docs: Add comprehensive Javadoc to spec module classes #527
Conversation
Summary of ChangesHello @ehsavoie, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on a significant documentation effort within the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive Javadoc documentation to numerous classes within the spec module, which is a valuable improvement for code clarity and maintainability. The added documentation covers public constants, generic type parameters, constructors, and builder classes, effectively resolving all Javadoc warnings in the module. The changes are well-executed. I've identified one minor issue in the Javadoc for A2AClientHTTPError where a parameter check was documented incorrectly. Other than that, this is an excellent contribution.
| * @param code the HTTP status code | ||
| * @param message the error message | ||
| * @param data additional error data (may be the response body) | ||
| * @throws IllegalArgumentException if code or message is null |
There was a problem hiding this comment.
The @throws documentation for the code parameter is misleading. Since code is a primitive int, it cannot be null. The corresponding check in the constructor body, Assert.checkNotNullParam("code", code), is also redundant because a primitive int cannot be null.
Please update the Javadoc to only mention message as being checked for nullity. For completeness, you might also consider removing the redundant null check for code from the constructor body.
| * @throws IllegalArgumentException if code or message is null | |
| * @throws IllegalArgumentException if message is null |
Added Javadoc documentation for: - Public constants (error codes, method names, type identifiers) - Generic type parameters in base request/response classes - Record compact constructors (12 record classes) - Exception constructors (5 exception classes) - APIKeySecurityScheme (enum, methods, constructors, Builder) - Builder classes and methods (CancelTaskRequest, DeleteTaskPushNotificationConfig*) - Request/response constructors This resolves all Javadoc warnings and errors in the spec module, enabling clean builds with the -Prelease profile. Signed-off-by: Emmanuel Hugonnet <ehugonne@redhat.com>
abe5d9b to
808e98d
Compare
Added Javadoc documentation for: - Public constants (error codes, method names, type identifiers) - Generic type parameters in base request/response classes - Record compact constructors (12 record classes) - Exception constructors (5 exception classes) - APIKeySecurityScheme (enum, methods, constructors, Builder) - Builder classes and methods (CancelTaskRequest, DeleteTaskPushNotificationConfig*) - Request/response constructors This resolves all Javadoc warnings and errors in the spec module, enabling clean builds with the -Prelease profile. Signed-off-by: Emmanuel Hugonnet <ehugonne@redhat.com>
Added Javadoc documentation for:
This resolves all Javadoc warnings and errors in the spec module, enabling clean builds with the -Prelease profile.