Improve SerialPortManager.getIdentifiers() JavaDoc #1471
Merged
Conversation
This file contains 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
The current JavaDocs do not clearly state that it does not always return all identifiers. E.g. it will not return any RFC2217 identifiers or undiscovered RXTX port identifiers. So it should not be used to search for an identifier when the serial port name is known. This method is useful for listing available port options in UIs and logging. Signed-off-by: Wouter Born <github@maindrain.net>
cweitkamp
reviewed
May 13, 2020
| * | ||
| * @return stream of serial port identifiers | ||
| * {@link SerialPortProvider}s may not be able to discover any or all identifiers. | ||
| * When the port name is known, the preferred way to get an identifier is by using {@link #getIdentifier(String). |
There was a problem hiding this comment.
A missing curly bracket? Isn't it?
Suggested change
| * When the port name is known, the preferred way to get an identifier is by using {@link #getIdentifier(String). | |
| * When the port name is known, the preferred way to get an identifier is by using {@link #getIdentifier(String)}. |
There was a problem hiding this comment.
Well spotted! The curly has returned from its absence. :-)
splatch
pushed a commit
to ConnectorIO/copybara-hab-core
that referenced
this pull request
Jul 11, 2023
* Improve SerialPortManager.getIdentifiers() JavaDoc The current JavaDocs do not clearly state that it does not always return all identifiers. E.g. it will not return any RFC2217 identifiers or undiscovered RXTX port identifiers. So it should not be used to search for an identifier when the serial port name is known. This method is useful for listing available port options in UIs and logging. Signed-off-by: Wouter Born <github@maindrain.net> GitOrigin-RevId: 583ea02
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.
The current JavaDocs do not clearly state that it does not always return all identifiers.
E.g. it will not return any RFC2217 identifiers or undiscovered RXTX port identifiers.
So it should not be used to search for an identifier when the serial port name is known.
This method is useful for listing available port options in UIs and logging.
Related to: