Fix javadoc

[javier-godoy]

Summary by CodeRabbit

• New Features

  • Updated the maven-javadoc-plugin for improved documentation generation.
  • Added new dependencies for enhanced functionality and testing capabilities.

• Documentation

  • Enhanced Javadoc comments for clarity and consistency in the GridHelper class.
  • Updated method signatures in documentation to reflect changes in parameters.

• Bug Fixes

  • Corrected references in Javadoc to ensure proper context for methods related to Grid.

[coderabbitai]

Walkthrough

The changes in this pull request involve updates to the pom.xml file and modifications to the GridHelper and HeightMode classes. The pom.xml has been revised to update plugin versions, add new dependencies, and adjust profile settings. The GridHelper class has improved documentation with enhanced Javadoc comments and minor method signature updates. Similarly, the HeightMode enum has been updated to reflect changes in method signatures related to the Grid class. Overall, these modifications focus on dependency management, documentation clarity, and method signature adjustments.

Changes

File Path	Change Summary
pom.xml	Updated maven-javadoc-plugin version from 3.0.1 to 3.11.1, changed execution phase, added new dependencies for commons-demo and selenium-java, and expanded profile properties for v24.
src/main/java/com/flowingcode/vaadin/addons/gridhelpers/GridHelper.java	Enhanced Javadoc comments for methods, updated method signatures for setHidingToggleCaption, setHeightByRows, and getHeightMode to clarify usage.
src/main/java/com/flowingcode/vaadin/addons/gridhelpers/HeightMode.java	Added import for Grid class and updated Javadoc for HeightMode to reflect changes in setHeightMode method signature.

---

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)

318-339: Consider enabling stricter Javadoc checks.

While the plugin update and Vaadin Javadoc link are good improvements, completely disabling documentation checks might mask important issues. Consider:

1. Using specific doclint options instead of disabling all checks:

-            <doclint>none</doclint>
+            <doclint>-missing</doclint>

2. Enabling failOnWarnings to maintain documentation quality:

-            <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 d059e5a and f0b86ed.

📒 Files selected for processing (3)

• pom.xml (1 hunks)
• src/main/java/com/flowingcode/vaadin/addons/gridhelpers/GridHelper.java (7 hunks)
• src/main/java/com/flowingcode/vaadin/addons/gridhelpers/HeightMode.java (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• src/main/java/com/flowingcode/vaadin/addons/gridhelpers/GridHelper.java

🔇 Additional comments (2)

src/main/java/com/flowingcode/vaadin/addons/gridhelpers/HeightMode.java (1)

22-23: LGTM! Documentation updates are accurate.

The changes correctly reflect the updated method signature in GridHelper, with proper import and well-formatted Javadoc reference.

Also applies to: 27-27

pom.xml (1)

Line range hint 601-626: LGTM: Profile v24 updates are well-structured.

The updates appropriately configure the build for Vaadin 24:

• Java 17 compatibility
• Updated tool versions
• Test dependencies properly scoped