Update documentation for serial port descriptors
This commit is contained in:
parent
c7cf3cbbfb
commit
0e6903362e
|
@ -1246,22 +1246,24 @@ public final class SerialPort
|
||||||
/**
|
/**
|
||||||
* Gets a descriptive string representing this serial port or the device connected to it.
|
* Gets a descriptive string representing this serial port or the device connected to it.
|
||||||
* <p>
|
* <p>
|
||||||
* This description is generated by the operating system and may or may not be a good representation of the actual port or
|
* This description is generated by the operating system and may or may not be either unique or
|
||||||
* device it describes.
|
* a good representation of the actual port or device it describes.
|
||||||
*
|
*
|
||||||
* @return A descriptive string representing this serial port.
|
* @return A descriptive string representing this serial port.
|
||||||
*/
|
*/
|
||||||
public final String getDescriptivePortName() { return friendlyName.trim(); }
|
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.
|
* @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)); }
|
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.
|
* @return The system-defined device path of this serial port.
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue