docs: update javadocs #143
Conversation
Close #141
WalkthroughThe changes in the Changes
Assessment against linked issues
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
src/main/java/com/flowingcode/vaadin/addons/googlemaps/GoogleMap.java (2)
Line range hint
600-620: Consider simplifying the error message.The error message for the IllegalStateException could be more concise while maintaining clarity.
- throw new IllegalStateException( - "A tracking location session is already active. Please stop the current session before starting a new one."); + throw new IllegalStateException("Location tracking already active. Stop current session before starting new one.");
Line range hint
800-810: Add @SInCE tag to deprecated method.The @deprecated annotation should be accompanied by an @SInCE tag to indicate when the deprecation occurred.
/** * Adds custom control buttons to the map. * * @param customControls list of custom controls to add to the map * * @deprecated {@link #setCustomControls(CustomControl... customControls)} should be used instead. + * @since 2.2.0 */ @Deprecated public void addCustomControls(CustomControl... customControls) {
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
src/main/java/com/flowingcode/vaadin/addons/googlemaps/GoogleMap.java(2 hunks)
🔇 Additional comments (4)
src/main/java/com/flowingcode/vaadin/addons/googlemaps/GoogleMap.java (4)
Line range hint 72-82: LGTM: Constructor documentation update is accurate.
The removal of the GoogleMapState reference from the documentation aligns with the PR objectives and improves accuracy since this object doesn't exist in the add-on.
436-437: LGTM: Parameter name in documentation matches method signature.
The documentation now correctly uses 'kml' instead of 'url' for the parameter name, improving consistency between the documentation and the code.
Line range hint 700-710: LGTM: Proper cleanup of tracking resources.
The method correctly checks for an active tracking session and ensures proper cleanup by setting trackLocationId to null after stopping the tracking.
Line range hint 800-900: LGTM: Improved custom controls management API.
The new implementation provides better control over the lifecycle of custom controls with methods for individual control management and proper cleanup of existing controls.
Close #141
Removed "GoogleMapState" from javadoc of constructor as there's no object with that name in the add-on.
Summary by CodeRabbit
New Features
Improvements
Deprecations