Activate checkstyle rules for missing @param and @return entries in javadoc comments; fix missing entries in comments by travkin79 · Pull Request #382 · microsoft/copilot-for-eclipse · GitHub
Skip to content

Activate checkstyle rules for missing @param and @return entries in javadoc comments; fix missing entries in comments - #382

Open
Dietrich Travkin (travkin79) wants to merge 3 commits into
microsoft:mainfrom
travkin79:fix-style
Open

Activate checkstyle rules for missing @param and @return entries in javadoc comments; fix missing entries in comments#382
Dietrich Travkin (travkin79) wants to merge 3 commits into
microsoft:mainfrom
travkin79:fix-style

Conversation

@travkin79

@travkin79 Dietrich Travkin (travkin79) commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

This PR

  • activates the checkstyle checks for missing @param and @return entries in javadoc comments in public API
  • adds missing @param and @return entries in javadoc comments

See comment #365 (comment)

Copilot AI review requested due to automatic review settings July 31, 2026 15:13
Copilot AI reviewed Jul 31, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR tightens Checkstyle’s JavadocMethod enforcement to require @param and @return tags for public APIs, and updates Javadocs across the UI/Core/Terminal modules to comply.

Changes:

  • Enable Checkstyle failures for missing @param / @return tags in public API Javadocs.
  • Add the missing Javadoc tags across a broad set of public methods/constructors.
  • Minor Javadoc wording adjustments while adding tags.

Reviewed changes

Copilot reviewed 157 out of 157 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/utils/UiUtils.java Add missing @param/@return tags to public utility methods.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/utils/TextMateUtils.java Add @param/@return tags to configuration helper.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/utils/SwtUtils.java Add missing Javadoc tags for SWT helpers.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/utils/ResourceUtils.java Add missing @param/@return tags for selection utilities.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/utils/ModelUtils.java Add missing Javadoc tags for model utilities.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/utils/MenuUtils.java Add missing Javadoc tags for quota/menu helpers.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/utils/McpUtils.java Add missing @param tag for allowlist parsing method.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/utils/AccessibilityUtils.java Add missing Javadoc tags for accessibility helpers.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/swt/WrapLabel.java Add missing constructor/method parameter/return tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/swt/CssConstants.java Add missing @param/@return tags for theme color helpers.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/quickstart/FeaturePage.java Add missing @param tag to constructor.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/WrappableIconLink.java Add missing Javadoc tags to factory methods.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/TerminalAutoApproveSection.java Expand Javadocs to include ctor/method parameters.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/McpPreferencePage.java Add missing @param tag for display method.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/McpAutoApproveSection.java Expand Javadocs to include ctor/method parameters.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/LanguageServerSettingManager.java Add missing @param/@return tags for settings APIs.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/GlobalAutoApproveSection.java Expand Javadocs to include ctor/method parameters.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/FileOperationAutoApproveSection.java Expand Javadocs to include ctor/method parameters.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/ByokPreferencePage.java Add missing @param tags for update/state methods.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/AddByokModelDialog.java Add missing ctor @param tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/AddApiKeyDialog.java Add missing ctor @param tags for add/change flows.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/nes/TextDiffCalculator.java Add missing ctor/method Javadoc tags for diff helpers.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/nes/RulerColumn.java Add missing Javadoc tags for indentation clearing API.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/nes/RenderManager.java Add missing Javadoc tags for renderer APIs.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/nes/InlineHighlighter.java Add missing ctor/method parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/nes/DiffPopup.java Add missing Javadoc tags for popup positioning APIs.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/nes/BottomBar.java Add missing constructor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/nes/ActionMenu.java Add missing @param/@return tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/handlers/QuotaTextCalculator.java Add missing @return tags for label/tooltip/text methods.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/handlers/CopilotHandler.java Add missing @return tags for manager getters.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/dialogs/mcp/McpServerInstallManager.java Add missing @param/@return tags for install/uninstall/state.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/dialogs/mcp/McpServerDetailDialog.java Add missing @param tag for registry base URL.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/dialogs/mcp/McpRegistryDialog.java Add missing @param tag to constructor.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/CopilotUi.java Add missing @param tags for preference-read helpers.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/RenderingManager.java Add missing @param tag for constructor.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/InlineGhostText.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/GhostText.java Add missing @param tags to draw contract.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/EolGhostText.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/EditorsManager.java Add missing ctor/method @param/@return tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/EditorLifecycleListener.java Add missing ctor/method parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/CompletionManagerLegacy.java Add missing ctor and helper @return tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/CompletionManager.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/codemining/LineEndGhostText.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/codemining/LineContentGhostText.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/codemining/BlockGhostText.java Add missing ctor parameter tags (incl. test ctor).
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/BlockGhostText.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/BaseCompletionManager.java Add missing ctor/method parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/WorkingSetBar.java Add missing constructor parameter tags for nested row widget.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/UserTurnWidget.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/tools/FileToolService.java Add missing ctor/method @param/@return tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/tools/BaseTool.java Add missing @param/@return tags for tool API.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/TodoListBar.java Add missing ctor/method parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/ThinkingTurnWidget.java Add missing parameter/return tags for thinking persistence APIs.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/ThinkingBlock.java Add missing @param/@return tags for thinking block API.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/SubagentTurnWidget.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/SourceViewerComposite.java Add missing ctor/method parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/UserPreferenceService.java Add missing ctor/method parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/TodoListService.java Add missing ctor/method return/parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/ReferencedFileService.java Add missing method parameter tags for bindings/updates.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/ModelService.java Add missing ctor and @return tag.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/McpRuntimeLogger.java Add missing @param tag for console printing.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/McpExtensionPointManager.java Add missing ctor/return tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/McpConfigService.java Add missing parameter tags for UI bindings and OAuth.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/ChatServiceManager.java Add missing @return tags for getters.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/ChatCompletionService.java Add missing ctor/method parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/ByokService.java Add missing @param/@return tags for BYOK flows.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/AvatarService.java Add missing ctor/return tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/services/AgentToolService.java Add missing ctor/method return/parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/ReferencedFile.java Add missing ctor/return tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/InvokeToolConfirmationDialog.java Add missing @return tag.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/ErrorWidget.java Add missing @param tag for style.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/DragReferenceManager.java Add missing ctor/method parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/CurrentReferencedFile.java Add missing ctor/method parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/CopilotTurnWidget.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/contextwindow/ContextSizeDonut.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/confirmation/ConfirmationService.java Add missing @param/@return tags for evaluation/clearing APIs.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/confirmation/ConfirmationHandler.java Add missing @param tag for session clearing.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/confirmation/AttachedFileRegistry.java Add missing @param/@return tags for registry APIs.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/ChatView.java Add missing @return/@param tags for accessors/registration.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/ChatContentViewer.java Add missing ctor/method parameter/return tags.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/BaseTurnWidget.java Add missing @return tags for confirmation APIs.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/AgentToolCancelLabel.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/AgentStatusLabel.java Add missing method parameter tag.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/AddContextButton.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/chat/ActionBar.java Add missing ctor/return tags for UI accessors.
com.microsoft.copilot.eclipse.ui.jobs/src/com/microsoft/copilot/eclipse/ui/jobs/views/JobsView.java Add missing @param tag for view creation.
com.microsoft.copilot.eclipse.terminal.api/src/com/microsoft/copilot/eclipse/terminal/api/TerminalServiceManager.java Add missing Javadoc tags for singleton and listener APIs.
com.microsoft.copilot.eclipse.terminal.api/src/com/microsoft/copilot/eclipse/terminal/api/IRunInTerminalTool.java Add missing @param tag for icon setter.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/utils/WorkspaceUtils.java Add missing @return tag for workspace folders listing.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/utils/PlatformUtils.java Add missing @return tags for platform helpers.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/utils/FileUtils.java Add missing @param/@return tags for exclusion helpers.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/utils/AnonymizeUtils.java Add missing @param/@return tags for PII removal helper.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/persistence/UserTurnData.java Add missing method parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/persistence/CopilotTurnData.java Add missing @return/ctor parameter tags for nested structures.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/persistence/ConversationXmlData.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/persistence/ConversationPersistenceManager.java Add missing @param/@return tags across persistence APIs.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/persistence/ConversationDataFactory.java Add missing @param/@return tags for factory APIs.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/nes/NextEditSuggestionProvider.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/Turn.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/ToolSpecificData.java Add missing @return tag for convenience accessor.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/SignInConfirmParams.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/ReadDirectoryResult.java Add missing getter @return tags in nested type.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/ProgressParamsAdapter.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/NotifyShownParams.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/NotifyRejectedParams.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/NotifyCodeAcceptanceParams.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/NotifyAcceptedParams.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/NextEditSuggestionsResult.java Add missing @return tag for command UUID helper.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/NextEditSuggestionsParams.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/LanguageModelToolResult.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/LanguageModelToolConfirmationResult.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/InputSchemaPropertyValue.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/InitializationOptions.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/git/GenerateCommitMessageResult.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/git/GenerateCommitMessageParams.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/FileStat.java Add missing @return tag for getter.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/DidChangeFeatureFlagsParams.java Add missing @return tags for feature flag helpers.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/CurrentEditorContext.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/CopilotLanguageServerSettings.java Add missing ctor/method parameter tags (MCP server settings).
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/CopilotAgentSettings.java Add missing @return tags for lazy init getters.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/ConversationTurnParams.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/ConversationError.java Add missing @return tag for provider name.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/ConversationDestroyParams.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/ConversationCreateParams.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/ConversationCodeCopyParams.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/CompletionResult.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/CompletionParams.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/CompletionItem.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/CompletionDocument.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/byok/ByokModelProvider.java Add missing param/return tags for helper.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/protocol/byok/ByokListModelParams.java Add missing ctor parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/CopilotLanguageServer.java Add missing @param/@return tags across LSP interface methods.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/CopilotLanguageClient.java Add missing @param/@return tags for client requests/notifications.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/logger/handlers/EclipseConsoleHandler.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/logger/GithubPanicErrorReport.java Add missing @param tag (and related Javadoc adjustments).
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/logger/CopilotForEclipseLogger.java Add missing method parameter tags for logger helpers.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/format/JavaFormatReader.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/format/FormatOptionProvider.java Add missing param/return tags for formatting options.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/format/CdtFormatReader.java Add missing ctor parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/CopilotCore.java Add missing @return tags for lazy-loaded services.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/CopilotAuthStatusListener.java Add missing callback parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/completion/SuggestionUpdateManager.java Add missing ctor/method param/return tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/completion/CompletionProvider.java Add missing ctor/method parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/completion/CompletionListener.java Add missing callback parameter tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/chat/service/IReferencedFileService.java Add missing @return tags for interface methods.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/chat/service/IMcpConfigService.java Add missing param/return tags for OAuth interface.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/chat/service/ICustomizationFileService.java Add missing @return tags for customization file discovery.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/chat/service/IChatServiceManager.java Add missing @return tags for service getters.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/chat/service/BuiltInChatModeService.java Add missing @return tag for async load method.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/chat/InputNavigation.java Add missing @param/@return tags for history navigation.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/chat/ConfirmationResult.java Add missing param/return tags for factory/accessors.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/chat/ConfirmationAction.java Add missing param/return tags for factories.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/chat/ChatProgressListener.java Add missing callback parameter tag.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/chat/ChatEventsManager.java Add missing listener and async return tags.
com.microsoft.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/AuthStatusManager.java Add missing param/return tags for auth APIs.
checkstyle.xml Enforce missing @param / @return tags as Checkstyle errors.

Comment thread com.microsoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/nes/RenderManager.java Outdated
Comment thread ...t.copilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/lsp/CopilotLanguageServer.java Outdated
Comment thread ...pilot.eclipse.core/src/com/microsoft/copilot/eclipse/core/logger/GithubPanicErrorReport.java Outdated
Comment thread ...clipse.ui/src/com/microsoft/copilot/eclipse/ui/preferences/LanguageServerSettingManager.java
Comment thread ...osoft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/BlockGhostText.java
Comment thread ...oft.copilot.eclipse.ui/src/com/microsoft/copilot/eclipse/ui/completion/RenderingManager.java
@travkin79
Activate checkstyle validation for missing @param/@return
b1fcdc5 
According to the public API guidelines in copilot-instructions.md, we activate checks for missing @PARAM and @return annotations. We do not check @throws annotations since this will very likely lead to many false positives.

See review comment microsoft#365 (comment)
@travkin79
fix: Add missing @PARAM and @return javadoc entries
34a34a7 
Fix checkstyle violations for missing @PARAM and @return entries in public API javadoc comments.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@travkin79
javadoc: Fix previously existing comments as suggested by review bot
badef34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@jdneo Sheng Chen (jdneo) Awaiting requested review from jdneo jdneo is a code owner
@ethanyhou Ethan Hou (ethanyhou) Awaiting requested review from ethanyhou ethanyhou is a code owner
@xinyi-gong xinyi-gong Awaiting requested review from xinyi-gong xinyi-gong is a code owner
@duzitong Zidong Lu (duzitong) Awaiting requested review from duzitong

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@travkin79