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

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -291,7 +291,7 @@ public final class SerialPort
* On Linux machines, the descriptor will look similar to "/dev/tty[*]". * On Linux machines, the descriptor will look similar to "/dev/tty[*]".
* *
* @param portDescriptor The desired serial port to use with this library. * @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. * @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 static public SerialPort getCommPort(String portDescriptor) throws SerialPortInvalidPortException

4
src/main/java/com/fazecast/jSerialComm/SerialPortDataListenerWithExceptions.java
View File

@ -2,7 +2,7 @@
* SerialPortDataListenerWithExceptions.java * SerialPortDataListenerWithExceptions.java
* *
* Created on: Jul 11, 2019 * Created on: Jul 11, 2019
* Last Updated on: Jul 11, 2019 * Last Updated on: Aug 28, 2019
* Author: Will Hedgecock * Author: Will Hedgecock
* *
* Copyright (C) 2012-2019 Fazecast, Inc. * 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. * 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); public abstract void catchException(Exception e);
} }