chore: Enable javadoc in the default profile #525
Conversation
Any javadoc errors (not warnings) will make Maven fail This fixes a2aproject#524 Signed-off-by: Jeff Mesnil <jmesnil@ibm.com>
Summary of ChangesHello @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 aims to improve code documentation quality by enforcing stricter Javadoc standards within the project's build process. By integrating the Javadoc plugin into the default Maven profile, all builds will now fail if Javadoc errors are present, preventing poorly documented code from being merged. Additionally, it includes small fixes to existing Javadoc references. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request enables Javadoc validation in the default Maven profile, which is a great step towards improving and maintaining documentation quality. The build will now fail on any Javadoc errors. You've also included fixes for existing Javadoc issues to ensure the build passes with this new validation. The changes are well-focused and look good. I have one minor suggestion to improve the precision of a Javadoc link.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
@jmesnil I disagree with this fix. We should fix the GH Action instead. |
|
@kabir Do you disagree with generating Javadoc when the project is built (with the default profile)? The GitHub action runs on |
Javadoc is not generated by default. The "Build and Test" GitHub action is run with that profile to validate Javadoc. This fixes a2aproject#525 Signed-off-by: Jeff Mesnil <jmesnil@ibm.com>
Javadoc is not generated by default. The "Build and Test" GitHub action is run with that profile to validate Javadoc. This fixes #525 Signed-off-by: Jeff Mesnil <jmesnil@ibm.com>
Any javadoc errors (not warnings) will make Maven fail This fixes a2aproject#524 --------- Signed-off-by: Jeff Mesnil <jmesnil@ibm.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Javadoc is not generated by default. The "Build and Test" GitHub action is run with that profile to validate Javadoc. This fixes a2aproject#525 Signed-off-by: Jeff Mesnil <jmesnil@ibm.com>
2 participants
Any javadoc errors (not warnings) will make
Maven fail
This fixes #524