From 606657e45a4a85f94219f270170d4d50084666ee Mon Sep 17 00:00:00 2001 From: hedgecrw85 Date: Wed, 28 Aug 2019 19:49:31 -0500 Subject: [PATCH] Javadoc updates --- src/main/java/com/fazecast/jSerialComm/SerialPort.java | 2 +- .../jSerialComm/SerialPortDataListenerWithExceptions.java | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/main/java/com/fazecast/jSerialComm/SerialPort.java b/src/main/java/com/fazecast/jSerialComm/SerialPort.java index 9420dc1..4a732bb 100644 --- a/src/main/java/com/fazecast/jSerialComm/SerialPort.java +++ b/src/main/java/com/fazecast/jSerialComm/SerialPort.java @@ -291,7 +291,7 @@ public final class SerialPort * On Linux machines, the descriptor will look similar to "/dev/tty[*]". * * @param portDescriptor The desired serial port to use with this library. - * @return A SerialPort object. + * @return A {@link SerialPort} object. * @exception SerialPortInvalidPortException If a {@link SerialPort} object cannot be created due to a logical or formatting error in the portDescriptor parameter. */ static public SerialPort getCommPort(String portDescriptor) throws SerialPortInvalidPortException diff --git a/src/main/java/com/fazecast/jSerialComm/SerialPortDataListenerWithExceptions.java b/src/main/java/com/fazecast/jSerialComm/SerialPortDataListenerWithExceptions.java index 8a7eb40..bfe5fb6 100644 --- a/src/main/java/com/fazecast/jSerialComm/SerialPortDataListenerWithExceptions.java +++ b/src/main/java/com/fazecast/jSerialComm/SerialPortDataListenerWithExceptions.java @@ -2,7 +2,7 @@ * SerialPortDataListenerWithExceptions.java * * Created on: Jul 11, 2019 - * Last Updated on: Jul 11, 2019 + * Last Updated on: Aug 28, 2019 * Author: Will Hedgecock * * Copyright (C) 2012-2019 Fazecast, Inc. @@ -37,6 +37,8 @@ public interface SerialPortDataListenerWithExceptions extends SerialPortDataList { /** * Must be overridden to handle any Java exceptions that occur asynchronously in this data listener. + * + * @param e An {@link Exception} object containing information about the exception that occurred. */ public abstract void catchException(Exception e); }