docs: add Javadoc to all action classes and core client types#26
Merged
Conversation
Adds comprehensive Javadoc to all HTTP action implementations, core client classes (HttpClient, HttpAbstractClient, HttpAdminClient, HttpIndicesAdminClient), EngineInfo, curl utilities, and node management types to improve public API documentation and IDE support.
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
1 participant
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.
Summary
Adds comprehensive Javadoc documentation across the entire codebase to improve public API documentation and IDE support.
Changes Made
HttpActionimplementations inaction/HttpClient,HttpAbstractClient,HttpAdminClient,HttpIndicesAdminClientEngineInfoclass, constructor, all getters,getType(), and theEngineTypeenum constantsFesenRequest,ByteArrayStreamOutput, node management types (Node,NodeIterator,NodeManager,NodeUnavailableException), and utilities (MaxMapCountCheck,UrlUtils)EngineTypeenum from single-line to multi-constant format with individual constant documentationTesting
No functional changes — documentation only. Existing tests cover behavior.
Breaking Changes
None.
Additional Notes
This is a pure documentation pass to make the library easier to use from IDEs and to help consumers understand the public API without reading source code.