Improve ServoMotorHelper Javadocs - #490
Merged
leandrumartin merged 3 commits intoJun 13, 2026
Merged
Conversation
Clarify current behavior by mentioning side effects, making links as appropriate, and mentioning exceptions thrown.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aims to improve the Javadoc for ServoMotorHelper by clarifying behavior (PWM startup/shutdown semantics, angle bounds handling, and the post-update delay) and by documenting potential side effects/exceptions as requested in issue #245.
Changes:
- Expanded Javadocs for
enable(),disable(), andsetAngle(int)to better describe runtime behavior and side effects. - Added
@throws IOExceptiondocumentation (and an associated import) for PWM operations. - Minor Javadoc formatting improvement for
setLog(...)by using{@code ...}.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Remove @throws tags because those exceptions are not declared, and because we don't want to declare them; doing so would be inconsistent within the repository. 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>
leandrumartin
deleted the
245-improve-javadoc-documentation-for-servomotorhelper-class
branch
June 13, 2026 22:26
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.
Pull Request Summary
Closes #245
A brief description/summary of your PR. What does it add, and why is it necessary? Does this new feature solve any problems or bugs? How was it tested — automated or manual software tests, physical hardware tests, or some other method or combination of testing techniques?
Clarify current behavior by mentioning side effects, making links as appropriate, and mentioning exceptions thrown.
PR Checklist
Detailed Description
A more detailed description and any additional information.