Skip to content

Commit 84ebca2

Browse files
authored
javadoc-generation-fix (scream3r#66)
* Remove invalid html from javadoc comments * Enable doclint
1 parent 6d09752 commit 84ebca2

File tree

4 files changed

+22
-25
lines changed

4 files changed

+22
-25
lines changed

pom.xml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010

1111
<properties>
1212
<java.version>1.6</java.version>
13-
<!-- default: empty for compatiblity with Java 8. -->
1413
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
1514

1615
<!-- custom directories and file paths a-z -->
@@ -42,8 +41,7 @@
4241
<plugin.osmaven.version>1.6.2</plugin.osmaven.version>
4342
<plugin.signature.version>1.1</plugin.signature.version>
4443
<plugin.surfire.version>3.0.0-M3</plugin.surfire.version>
45-
<!-- keep below 3.1.0 because 3.1.0 fails on java 8. -->
46-
<plugin.javadoc.version>3.0.1</plugin.javadoc.version>
44+
<plugin.javadoc.version>3.1.1</plugin.javadoc.version>
4745
<plugin.source.version>3.0.1</plugin.source.version>
4846
<plugin.compiler.version>3.8.0</plugin.compiler.version>
4947
</properties>
@@ -217,7 +215,6 @@
217215
<groupId>org.apache.maven.plugins</groupId>
218216
<artifactId>maven-javadoc-plugin</artifactId>
219217
<configuration>
220-
<doclint>none</doclint>
221218
<!-- workaround for https://bugs.openjdk.java.net/browse/JDK-8212233 -->
222219
<javaApiLinks>
223220
<property>

src/java/jssc/SerialNativeInterface.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,8 @@ public static String getLibraryMinorSuffix() {
256256
* @param handle handle of opened port
257257
*
258258
* @return Method returns the array that contains info about bytes count in buffers:
259-
* <br><b>element 0</b> - input buffer</br>
260-
* <br><b>element 1</b> - output buffer</br>
259+
* <br><b>element 0</b> - input buffer
260+
* <br><b>element 1</b> - output buffer
261261
*
262262
* @since 0.8
263263
*/
@@ -299,10 +299,10 @@ public static String getLibraryMinorSuffix() {
299299
* @param handle handle of opened port
300300
*
301301
* @return Method returns the array containing information about lines in following order:
302-
* <br><b>element 0</b> - <b>CTS</b> line state</br>
303-
* <br><b>element 1</b> - <b>DSR</b> line state</br>
304-
* <br><b>element 2</b> - <b>RING</b> line state</br>
305-
* <br><b>element 3</b> - <b>RLSD</b> line state</br>
302+
* <br><b>element 0</b> - <b>CTS</b> line state
303+
* <br><b>element 1</b> - <b>DSR</b> line state
304+
* <br><b>element 2</b> - <b>RING</b> line state
305+
* <br><b>element 3</b> - <b>RLSD</b> line state
306306
*/
307307
public native int[] getLinesStatus(long handle);
308308

src/java/jssc/SerialPort.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -884,10 +884,10 @@ private void checkPortOpened(String methodName) throws SerialPortException {
884884
* Getting lines status. Lines status is sent as 0 – OFF and 1 - ON
885885
*
886886
* @return Method returns the array containing information about lines in following order:
887-
* <br><b>element 0</b> - <b>CTS</b> line state</br>
888-
* <br><b>element 1</b> - <b>DSR</b> line state</br>
889-
* <br><b>element 2</b> - <b>RING</b> line state</br>
890-
* <br><b>element 3</b> - <b>RLSD</b> line state</br>
887+
* <br><b>element 0</b> - <b>CTS</b> line state
888+
* <br><b>element 1</b> - <b>DSR</b> line state
889+
* <br><b>element 2</b> - <b>RING</b> line state
890+
* <br><b>element 3</b> - <b>RLSD</b> line state
891891
*
892892
* @throws SerialPortException
893893
*/

src/java/jssc/SerialPortEvent.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -66,17 +66,17 @@ public int getEventType() {
6666

6767
/**
6868
* Getting event value
69-
* <br></br>
70-
* <br><u><b>Event values depending on their types:</b></u></br>
71-
* <br><b>RXCHAR</b> - bytes count in input buffer</br>
72-
* <br><b>RXFLAG</b> - bytes count in input buffer (Not supported in Linux)</br>
73-
* <br><b>TXEMPTY</b> - bytes count in output buffer</br>
74-
* <br><b>CTS</b> - state of CTS line (0 - OFF, 1 - ON)</br>
75-
* <br><b>DSR</b> - state of DSR line (0 - OFF, 1 - ON)</br>
76-
* <br><b>RLSD</b> - state of RLSD line (0 - OFF, 1 - ON)</br>
77-
* <br><b>BREAK</b> - 0</br>
78-
* <br><b>RING</b> - state of RING line (0 - OFF, 1 - ON)</br>
79-
* <br><b>ERR</b> - mask of errors</br>
69+
* <br>
70+
* <br><u><b>Event values depending on their types:</b></u>
71+
* <br><b>RXCHAR</b> - bytes count in input buffer
72+
* <br><b>RXFLAG</b> - bytes count in input buffer (Not supported in Linux)
73+
* <br><b>TXEMPTY</b> - bytes count in output buffer
74+
* <br><b>CTS</b> - state of CTS line (0 - OFF, 1 - ON)
75+
* <br><b>DSR</b> - state of DSR line (0 - OFF, 1 - ON)
76+
* <br><b>RLSD</b> - state of RLSD line (0 - OFF, 1 - ON)
77+
* <br><b>BREAK</b> - 0
78+
* <br><b>RING</b> - state of RING line (0 - OFF, 1 - ON)
79+
* <br><b>ERR</b> - mask of errors
8080
*/
8181
public int getEventValue() {
8282
return eventValue;

0 commit comments

Comments
 (0)