Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve SerialPortManager.getIdentifiers() JavaDoc #1471

Merged
merged 2 commits into from
May 13, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,12 @@ public interface SerialPortManager {
}

/**
* Gets the serial port identifiers.
* Gets the discovered serial port identifiers.
*
* @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)}.
*
* @return stream of discovered serial port identifiers
*/
Stream<SerialPortIdentifier> getIdentifiers();
}