Fixed some javadoc errors

marci4 · marci4 · commit b9f47eb1170c · 2017-06-02T15:37:34.000+02:00
diff --git a/src/main/java/org/java_websocket/AbstractWebSocket.java b/src/main/java/org/java_websocket/AbstractWebSocket.java
@@ -42,7 +42,7 @@ public int getConnectionLostTimeout() {
 
     /**
      * Setter for the interval checking for lost connections
-     * A value >= 0 results in the check to be deactivated
+     * A value lower or equal 0 results in the check to be deactivated
      *
      * @param connectionLostTimeout the interval in seconds
      */
diff --git a/src/main/java/org/java_websocket/SSLSocketChannel.java b/src/main/java/org/java_websocket/SSLSocketChannel.java
@@ -18,12 +18,12 @@
 
 /**
  * A class that represents an SSL/TLS peer, and can be extended to create a client or a server.
- * <p/>
+ *
  * It makes use of the JSSE framework, and specifically the {@link SSLEngine} logic, which
  * is described by Oracle as "an advanced API, not appropriate for casual use", since
  * it requires the user to implement much of the communication establishment procedure himself.
  * More information about it can be found here: http://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#SSLEngine
- * <p/>
+ *
  * {@link SSLSocketChannel} implements the handshake protocol, required to establish a connection between two peers,
  * which is common for both client and server and provides the abstract {@link SSLSocketChannel#read(ByteBuffer)} and
  * {@link SSLSocketChannel#write(ByteBuffer)} (String)} methods, that need to be implemented by the specific SSL/TLS peer
diff --git a/src/main/java/org/java_websocket/framing/CloseFrame.java b/src/main/java/org/java_websocket/framing/CloseFrame.java
@@ -133,7 +133,11 @@ public CloseFrame() {
         setCode(CloseFrame.NORMAL);
     }
 
-    public void setCode(int code) {
+	/**
+	 * Set the close code for this close frame
+	 * @param code the close code
+	 */
+	public void setCode(int code) {
         this.code = code;
         // CloseFrame.TLS_ERROR is not allowed to be transfered over the wire
         if (code == CloseFrame.TLS_ERROR) {
@@ -143,6 +147,10 @@ public void setCode(int code) {
         updatePayload();
     }
 
+	/**
+	 * Set the close reason for this close frame
+	 * @param reason the reason code
+	 */
     public void setReason(String reason) {
         if (reason == null) {
             reason = "";
diff --git a/src/main/java/org/java_websocket/framing/ControlFrame.java b/src/main/java/org/java_websocket/framing/ControlFrame.java
@@ -10,6 +10,7 @@ public abstract class ControlFrame extends FramedataImpl1 {
 
 	/**
 	 * Class to represent a control frame
+	 * @param opcode the opcode to use
 	 */
 	public ControlFrame( Opcode opcode ) {
 		super( opcode );
diff --git a/src/main/java/org/java_websocket/framing/DataFrame.java b/src/main/java/org/java_websocket/framing/DataFrame.java
@@ -9,6 +9,7 @@ public abstract class DataFrame extends FramedataImpl1 {
 
 	/**
 	 * Class to represent a data frame
+	 * @param opcode the opcode to use
 	 */
 	public DataFrame(Opcode opcode) {
 		super(opcode);
diff --git a/src/main/java/org/java_websocket/framing/FramedataImpl1.java b/src/main/java/org/java_websocket/framing/FramedataImpl1.java
@@ -46,7 +46,7 @@ public abstract class FramedataImpl1 implements Framedata {
     /**
      * Check if the frame is valid due to specification
      *
-     * @throws InvalidDataException
+     * @throws InvalidDataException thrown if the frame is not a valid frame
      */
     public abstract void isValid() throws InvalidDataException;
 

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public int getConnectionLostTimeout() {`
`42`	`42`
`43`	`43`	`/**`
`44`	`44`	`* Setter for the interval checking for lost connections`
`45`		`- * A value >= 0 results in the check to be deactivated`
	`45`	`+ * A value lower or equal 0 results in the check to be deactivated`
`46`	`46`	`*`
`47`	`47`	`* @param connectionLostTimeout the interval in seconds`
`48`	`48`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public abstract class FramedataImpl1 implements Framedata {`
`46`	`46`	`/**`
`47`	`47`	`* Check if the frame is valid due to specification`
`48`	`48`	`*`
`49`		`- * @throws InvalidDataException`
	`49`	`+ * @throws InvalidDataException thrown if the frame is not a valid frame`
`50`	`50`	`*/`
`51`	`51`	`public abstract void isValid() throws InvalidDataException;`
`52`	`52`