Fix javadoc

[javier-godoy]

Summary by CodeRabbit

• New Features

  • Improved documentation generation with updated Javadoc plugin settings.
  • Added support for Vaadin version 24 and new dependencies.

• Documentation

  • Enhanced clarity in documentation comments for Tab components in the EnhancedTabs class.

• Bug Fixes

  • Updated execution phase for Javadoc generation to ensure proper documentation attachment.

[coderabbitai]

Walkthrough

The pull request includes updates to the pom.xml file, primarily focusing on the configuration of the maven-javadoc-plugin, which has been upgraded to version 3.11.1 and its execution phase changed to package. A new profile for Vaadin version 24 has been added, incorporating updated properties and dependencies. Additionally, changes to the EnhancedTabs.java file include a new import statement and enhancements to documentation comments for clarity and readability.

Changes

File Path	Change Summary
pom.xml	- Updated maven-javadoc-plugin version from 3.0.1 to 3.11.1. - Changed execution phase from verify to package. - Added failOnWarnings set to true. - Added links section for Vaadin Javadoc. - Introduced new profile v24 with updated properties and jakarta.servlet-api dependency version 6.0.0. - Updated commons-demo dependency version to 4.1.0 in the v24 profile.
src/main/java/com/flowingcode/vaadin/addons/enhancedtabs/EnhancedTabs.java	- Added import for Tabs class. - Updated documentation comments for Tab components for clarity. - Reformatted documentation for improved readability.

---

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.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

pom.xml (1)

Line range hint 509-585: LGTM! Consider documenting Java version requirement.

The v24 profile is well-structured with appropriate updates for Vaadin 24:

• Java 17 requirement
• Jakarta EE transition
• Updated dependencies
• Proper repository configuration

Consider adding a comment in the profile to document the Java version requirement for better visibility.

 		<profile>
 			<id>v24</id>
+			<!-- Vaadin 24 requires Java 17 or newer -->
 			<properties>
 				<maven.compiler.source>17</maven.compiler.source>
 				<maven.compiler.target>17</maven.compiler.target>

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5cfbe8a and 6b4f03c.

📒 Files selected for processing (2)

• pom.xml (1 hunks)
• src/main/java/com/flowingcode/vaadin/addons/enhancedtabs/EnhancedTabs.java (3 hunks)

🔇 Additional comments (4)

pom.xml (1)

315-317: Consider implications of moving javadoc generation to package phase.

Moving javadoc generation from verify to package phase means documentation will be generated earlier in the build lifecycle. While this works, the verify phase is traditionally used for checks that validate the package, including javadoc generation. Consider keeping it in the verify phase unless there's a specific reason for the change.

src/main/java/com/flowingcode/vaadin/addons/enhancedtabs/EnhancedTabs.java (3)

50-50: LGTM: Import addition is appropriate.

The added import for Tabs class is necessary to support the explicit class references in the javadoc.

---

69-76: LGTM: Javadoc improvements enhance clarity.

The changes improve the documentation by:

• Adding proper paragraph breaks for better readability
• Making class references more explicit with fully qualified links

---

166-170: LGTM: Method javadoc improvements are consistent.

The changes maintain consistency with the class-level documentation improvements and enhance readability.