Skip to content

chore: fix javadoc errors#510

Merged
kabir merged 1 commit intoa2aproject:mainfrom
jmesnil:javadoc
Dec 4, 2025
Merged

chore: fix javadoc errors#510
kabir merged 1 commit intoa2aproject:mainfrom
jmesnil:javadoc

Conversation

@jmesnil
Copy link
Collaborator

@jmesnil jmesnil commented Dec 4, 2025

Description

  • Follow the CONTRIBUTING Guide.
  • Make your Pull Request title in the https://www.conventionalcommits.org/ specification.
    • Important Prefixes for release-please:
      • fix: which represents bug fixes, and correlates to a SemVer patch.
      • feat: represents a new feature, and correlates to a SemVer minor.
      • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.
  • Ensure the tests pass
  • Appropriate READMEs were updated (if necessary)

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @jmesnil, 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 addresses and resolves several Javadoc errors across the codebase. The changes primarily focus on improving the accuracy and readability of the documentation by correcting formatting for generic types, updating parameter names, and ensuring that class references within Javadoc comments are consistent with the current API structure. These adjustments contribute to a more robust and error-free documentation generation process.

Highlights

  • Javadoc Formatting: Corrected Javadoc formatting for generic types, specifically changing Map<String, Object> to {@code Map<String, Object>} to ensure proper rendering and avoid Javadoc errors.
  • Javadoc Parameter Names: Updated a Javadoc @param tag from request to domain in SetTaskPushNotificationConfigMapper.java for improved clarity and consistency.
  • Class Reference Updates: Renamed Javadoc references from TaskResubscriptionRequest to SubscribeToTaskRequest in StreamingJSONRPCRequest.java and TaskIdParams.java to reflect an underlying class name change.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

The pull request primarily updates Javadoc comments across several files. It corrects Javadoc formatting by enclosing generic types like Map<String, Object> within {@code} tags and rectifies a parameter name in a Javadoc comment from request to domain. Additionally, it reflects a renaming of TaskResubscriptionRequest to SubscribeToTaskRequest in Javadoc descriptions and @see tags within StreamingJSONRPCRequest.java and TaskIdParams.java.

Signed-off-by: Jeff Mesnil <jmesnil@ibm.com>
@jmesnil
Copy link
Collaborator Author

jmesnil commented Dec 4, 2025

The "Build with '-Prelease' / build (pull_request_target) job fails because it is run on the PR target (main), not on the PR itself.

However, I was able to successfully run mvn clean install -Prelease locally on my branch

@kabir kabir merged commit c154104 into a2aproject:main Dec 4, 2025
9 of 10 checks passed
@jmesnil jmesnil added this to the 1.0.0 milestone Dec 11, 2025
kabir pushed a commit to kabir/a2a-java that referenced this pull request Dec 23, 2025
# Description

- [X] Follow the [`CONTRIBUTING` Guide](../CONTRIBUTING.md).
- [X] Make your Pull Request title in the
<https://www.conventionalcommits.org/> specification.
- Important Prefixes for
[release-please](https://github.com/googleapis/release-please):
- `fix:` which represents bug fixes, and correlates to a
[SemVer](https://semver.org/) patch.
- `feat:` represents a new feature, and correlates to a SemVer minor.
- `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking
change (indicated by the `!`) and will result in a SemVer major.
- [X] Ensure the tests pass
- [X] Appropriate READMEs were updated (if necessary)

Signed-off-by: Jeff Mesnil <jmesnil@ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants