Add missing Javadocs - #491
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds/updates missing class- and method-level Javadocs in pi4micronaut-utils to satisfy Gradle’s Javadoc checks, without intended runtime behavior changes.
Changes:
- Adds class-level Javadocs for several device helper classes.
- Improves/extends method-level Javadocs (including parameter/return descriptions).
- Minor Javadoc wording corrections.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/ServoMotorHelper.java |
Expands method Javadocs for enable/disable/setAngle; introduces an unused import that will fail compilation. |
pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/PassiveBuzzerHelper.java |
Adds missing @return and Javadoc for sleep, but getFrequency() description is misleading. |
pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/LEDHelper.java |
Cleans up constructor and blink Javadocs. |
pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/FourDigitSevenSegmentDisplayHelper.java |
Adds class-level Javadoc. |
pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/ThermistorHelper.java |
Adds class-level Javadoc. |
pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/ReedSwitchHelper.java |
Adds class-level Javadoc. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Leandru Martin <122942864+leandrumartin@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Leandru Martin <122942864+leandrumartin@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add the missing class- and method-level Javadocs flagged by gradle javadoc in pi4micronaut-utils. No functional changes.