Javadoc updates

This commit is contained in:
hedgecrw85 2019-08-28 19:49:31 -05:00
parent 6634692ac9
commit 606657e45a
2 changed files with 4 additions and 2 deletions

View File

@ -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

View File

@ -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);
}