rusefi
/
jSerialComm
mirror of https://github.com/rusefi/jSerialComm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation for serial port descriptors

This commit is contained in:
Will Hedgecock 2021-10-29 16:38:38 -05:00
parent c7cf3cbbfb
commit 0e6903362e
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/main/java/com/fazecast/jSerialComm/SerialPort.java
View File

@ -1246,22 +1246,24 @@ public final class SerialPort
/**
* Gets a descriptive string representing this serial port or the device connected to it.
* <p>
* This description is generated by the operating system and may or may not be a good representation of the actual port or
* device it describes.
* This description is generated by the operating system and may or may not be either unique or
* a good representation of the actual port or device it describes.
*
* @return A descriptive string representing this serial port.
*/
public final String getDescriptivePortName() { return friendlyName.trim(); }
/**
* Gets the operating system-defined device name corresponding to this serial port.
* Gets the operating system-defined device name corresponding to this serial port. The name will be unique,
* returning a different string for multiples of the same type of device connected to a single computer.
*
* @return The system-defined device name of this serial port.
*/
public final String getSystemPortName() { return (isWindows ? comPort.substring(comPort.lastIndexOf('\\')+1) : comPort.substring(comPort.lastIndexOf('/')+1)); }
/**
* Gets the operating system-defined device path corresponding to this serial port.
* Gets the operating system-defined device path corresponding to this serial port. The path will be unique,
* returning a different string for multiples of the same type of device connected to a single computer.
*
* @return The system-defined device path of this serial port.
*/