From 0e6903362e1f6b8da702ebdfab965731f3e1e6ba Mon Sep 17 00:00:00 2001 From: Will Hedgecock Date: Fri, 29 Oct 2021 16:38:38 -0500 Subject: [PATCH] Update documentation for serial port descriptors --- src/main/java/com/fazecast/jSerialComm/SerialPort.java | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/main/java/com/fazecast/jSerialComm/SerialPort.java b/src/main/java/com/fazecast/jSerialComm/SerialPort.java index df3d594..c447a1a 100644 --- a/src/main/java/com/fazecast/jSerialComm/SerialPort.java +++ b/src/main/java/com/fazecast/jSerialComm/SerialPort.java @@ -1246,22 +1246,24 @@ public final class SerialPort /** * Gets a descriptive string representing this serial port or the device connected to it. *

- * 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. */