build: upgrade javadoc plugin to 3.11.1

[javier-godoy]

Summary by CodeRabbit

• Documentation

  • Improved handling of Javadocs in the build process, ensuring better documentation quality.
  • Added links to the Vaadin platform Javadoc for easier reference.

• Chores

  • Updated the version of the maven-javadoc-plugin for enhanced functionality.

[coderabbitai]

Walkthrough

The changes involve updates to the pom.xml file for the Google Maps Addon project. Key modifications include upgrading the maven-javadoc-plugin version from 3.1.1 to 3.11.1, changing the execution phase from verify to package, and adjusting the configuration by removing the additionalparam entry and adding a failOnWarnings parameter. Additionally, a new links section has been introduced, which includes a link to the Vaadin platform Javadoc for a specified version.

Changes

File	Change Summary
pom.xml	- Updated maven-javadoc-plugin version from 3.1.1 to 3.11.1 - Changed execution phase from verify to package - Removed additionalparam and added failOnWarnings set to false - Added new links section with Vaadin platform Javadoc link.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

pom.xml (1)

301-304: Consider enabling failOnWarnings for better documentation quality.

While adding links to Vaadin platform javadoc is excellent, setting failOnWarnings=false might allow documentation issues to slip through. Consider enabling it to maintain high documentation standards.

-                            <failOnWarnings>false</failOnWarnings>
+                            <failOnWarnings>true</failOnWarnings>

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ea2abfc and c877475.

📒 Files selected for processing (1)

• pom.xml (2 hunks)

🔇 Additional comments (2)

pom.xml (2)

292-292: LGTM! Phase change is appropriate.

Moving javadoc generation from verify to package phase is a good optimization as it:

1. Provides earlier feedback on javadoc issues
2. Better aligns with Maven's standard lifecycle (documentation is part of the package)

---

288-288: LGTM! Version upgrade looks good.

The upgrade from 3.1.1 to 3.11.1 is compatible with the project's Java 8 baseline.

✅ Verification successful

Version upgrade to maven-javadoc-plugin 3.11.1 is safe to proceed

The search confirms that there is only one instance of maven-javadoc-plugin in the project's build configuration, and the version upgrade to 3.11.1 is consistently applied. No conflicting versions were found in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify if there are any other javadoc plugin version references
rg "maven-javadoc-plugin.*version" --type xml

Length of output: 47

---

Script:

#!/bin/bash
# Let's try a broader search for maven-javadoc-plugin references
rg "maven-javadoc-plugin" --type xml -A 5 -B 5

Length of output: 648