Add comments to resolve javadoc warnings#146
Merged
Merged
Conversation
Contributor
Author
|
@adityamparikh can you review? |
There was a problem hiding this comment.
Pull request overview
This PR focuses on eliminating Javadoc warnings and improving developer guidance by adding missing Javadoc blocks across services, records, and package-level documentation.
Changes:
- Added Javadoc for constants, constructors, and MCP prompt methods to satisfy doclint/javadoc requirements.
- Expanded method/record Javadoc with missing
@param,@return, and@throwstags. - Added package-level documentation for
org.apache.solr.mcp.server.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/main/java/org/apache/solr/mcp/server/search/SearchService.java |
Documents sort-clause keys and the search MCP prompt method. |
src/main/java/org/apache/solr/mcp/server/schema/SchemaUpdateResult.java |
Adds record component @param tags to avoid record Javadoc warnings. |
src/main/java/org/apache/solr/mcp/server/schema/SchemaService.java |
Adds Javadoc for schema mutation tools and schema-related MCP prompts. |
src/main/java/org/apache/solr/mcp/server/package-info.java |
Adds package-level Javadoc describing the server root package responsibilities. |
src/main/java/org/apache/solr/mcp/server/Main.java |
Adds an explicit documented default constructor. |
src/main/java/org/apache/solr/mcp/server/indexing/IndexingService.java |
Adds missing constructor @param docs and tool method @return docs; documents indexing MCP prompt. |
src/main/java/org/apache/solr/mcp/server/indexing/documentcreator/XmlDocumentCreator.java |
Adds documented default constructor. |
src/main/java/org/apache/solr/mcp/server/indexing/documentcreator/JsonDocumentCreator.java |
Adds constructor Javadoc for injected ObjectMapper. |
src/main/java/org/apache/solr/mcp/server/indexing/documentcreator/IndexingDocumentCreator.java |
Adds constructor Javadoc for per-format creators. |
src/main/java/org/apache/solr/mcp/server/indexing/documentcreator/CsvDocumentCreator.java |
Adds documented default constructor. |
src/main/java/org/apache/solr/mcp/server/config/SolrNativeHints.java |
Adds documented default constructor. |
src/main/java/org/apache/solr/mcp/server/config/SolrConfig.java |
Adds documented default constructor. |
src/main/java/org/apache/solr/mcp/server/collection/CollectionService.java |
Adds missing @throws and completion-handler @param/@return docs; documents collection-related MCP prompts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * {@code add-field-type} shape | ||
| * @return summary listing the collection and the names of the field types added | ||
| * @throws SolrServerException | ||
| * if there are if there are errors communicating with Solr |
| public Main() { | ||
| } | ||
|
|
||
| static void main(String[] args) { |
Contributor
|
@epugh looks good but I am unable to commit the suggestions. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Plus help the next person!