Fix javadoc warnings

[paodb]

Close #28 & #30

Summary by CodeRabbit

• Bug Fixes

  • Updated Javadoc generation to fail on warnings, enhancing documentation quality checks.

• Refactor

  • Renamed parameter in the scrollToIndex method from rowIndex to position for clarity, with corresponding updates to documentation.

[coderabbitai]

Walkthrough

The changes in this pull request involve updates to the pom.xml file and the ChatAssistant.java class. The pom.xml file now has the failOnWarnings property set to true in the maven-javadoc-plugin, making the build fail if there are Javadoc warnings. In ChatAssistant.java, the parameter name in the scrollToIndex method has been renamed from rowIndex to position, with the corresponding Javadoc comment updated accordingly. No other modifications were made to dependencies or functionality.

Changes

Files	Change Summary
pom.xml	Updated failOnWarnings property in maven-javadoc-plugin from false to true.
src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java	Renamed parameter rowIndex to position in scrollToIndex method and updated Javadoc comment.

Assessment against linked issues

Objective	Addressed	Explanation
Fix Javadoc warnings (#28)	✅

---

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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 988038a and d799cf2.

📒 Files selected for processing (2)

• pom.xml (1 hunks)
• src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java (1 hunks)

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

• src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java