Merge pull request TooTallNate#327 from garys-esri/master

Fixed Javadoc errors interfering with Maven build

Author: BrushfireDigitalServices

src/main/java/org/java_websocket/WebSocket.java

@@ -81,12 +81,12 @@ public enum READYSTATE {
 	public abstract boolean hasBufferedData();
 
 	/**
-	 * @returns never returns null
+	 * @return never returns null
 	 */
 	public abstract InetSocketAddress getRemoteSocketAddress();
 
 	/**
-	 * @returns never returns null
+	 * @return never returns null
 	 */
 	public abstract InetSocketAddress getLocalSocketAddress();
 

src/main/java/org/java_websocket/WebSocketAdapter.java

@@ -66,7 +66,7 @@ public void onWebsocketPing( WebSocket conn, Framedata f ) {
 	/**
 	 * This default implementation does not do anything. Go ahead and overwrite it.
 	 * 
-	 * @see @see org.java_websocket.WebSocketListener#onWebsocketPong(WebSocket, Framedata)
+	 * @see org.java_websocket.WebSocketListener#onWebsocketPong(WebSocket, Framedata)
 	 */
 	@Override
 	public void onWebsocketPong( WebSocket conn, Framedata f ) {

src/main/java/org/java_websocket/WebSocketImpl.java

@@ -121,7 +121,7 @@ public WebSocketImpl( WebSocketListener listener , List<Draft> drafts ) {
 	/**
 	 * crates a websocket with client role
 	 * 
-	 * @param socket
+	 * @param listener
 	 *            may be unbound
 	 */
 	public WebSocketImpl( WebSocketListener listener , Draft draft ) {

src/main/java/org/java_websocket/WebSocketListener.java

@@ -101,7 +101,7 @@ public interface WebSocketListener {
 	 * Called after <tt>WebSocket#close</tt> is explicity called, or when the
 	 * other end of the WebSocket connection is closed.
 	 * 
-	 * @param conn
+	 * @param ws
 	 *            The <tt>WebSocket</tt> instance this event is occuring on.
 	 */
 	public void onWebsocketClose( WebSocket ws, int code, String reason, boolean remote );

src/main/java/org/java_websocket/server/WebSocketServer.java

@@ -146,7 +146,7 @@ public WebSocketServer( InetSocketAddress address , int decodercount , List<Draf
 	 *            By default a {@link HashSet} will be used.
 	 * 
 	 * @see #removeConnection(WebSocket) for more control over syncronized operation
-	 * @see <a href="https://github.com/TooTallNate/Java-WebSocket/wiki/Drafts" > more about drafts
+	 * @see <a href="https://github.com/TooTallNate/Java-WebSocket/wiki/Drafts" > more about drafts</a>
 	 */
 	public WebSocketServer( InetSocketAddress address , int decodercount , List<Draft> drafts , Collection<WebSocket> connectionscontainer ) {
 		if( address == null || decodercount < 1 || connectionscontainer == null ) {
@@ -197,8 +197,6 @@ public void start() {
 	 * @param timeout
 	 *            Specifies how many milliseconds the overall close handshaking may take altogether before the connections are closed without proper close handshaking.<br>
 	 * 
-	 * @throws IOException
-	 *             When {@link ServerSocketChannel}.close throws an IOException
 	 * @throws InterruptedException
 	 */
 	public void stop( int timeout ) throws InterruptedException {
@@ -614,7 +612,8 @@ public final WebSocketFactory getWebSocketFactory() {
 	 * Returns whether a new connection shall be accepted or not.<br>
 	 * Therefore method is well suited to implement some kind of connection limitation.<br>
 	 * 
-	 * @see {@link #onOpen(WebSocket, ClientHandshake)}, {@link #onWebsocketHandshakeReceivedAsServer(WebSocket, Draft, ClientHandshake)}
+	 * @see #onOpen(WebSocket, ClientHandshake)
+         * @see #onWebsocketHandshakeReceivedAsServer(WebSocket, Draft, ClientHandshake)
 	 **/
 	protected boolean onConnect( SelectionKey key ) {
 		return true;
@@ -659,7 +658,7 @@ public InetSocketAddress getRemoteSocketAddress( WebSocket conn ) {
 	 * This method will be called primarily because of IO or protocol errors.<br>
 	 * If the given exception is an RuntimeException that probably means that you encountered a bug.<br>
 	 * 
-	 * @param con
+	 * @param conn
 	 *            Can be null if there error does not belong to one specific websocket. For example if the servers port could not be bound.
 	 **/
 	public abstract void onError( WebSocket conn, Exception ex );

src/main/java/org/java_websocket/util/Base64.java

@@ -7,7 +7,7 @@
  * <p>Example:</p>
  * 
  * <code>String encoded = Base64.encode( myByteArray );</code>
- * <br />
+ * <br>
  * <code>byte[] myByteArray = Base64.decode( encoded );</code>
  *
  * <p>The <tt>options</tt> parameter, which appears in a few places, is used to pass 
@@ -1669,7 +1669,7 @@ public InputStream( java.io.InputStream in ) {
          * Valid options:<pre>
          *   ENCODE or DECODE: Encode or Decode as data is read.
          *   DO_BREAK_LINES: break lines at 76 characters
-         *     (only meaningful when encoding)</i>
+         *     <i>(only meaningful when encoding)</i>
          * </pre>
          * <p>
          * Example: <code>new Base64.InputStream( in, Base64.DECODE )</code>
@@ -1882,7 +1882,7 @@ public OutputStream( java.io.OutputStream out ) {
          * Valid options:<pre>
          *   ENCODE or DECODE: Encode or Decode as data is read.
          *   DO_BREAK_LINES: don't break lines at 76 characters
-         *     (only meaningful when encoding)</i>
+         *     <i>(only meaningful when encoding)</i>
          * </pre>
          * <p>
          * Example: <code>new Base64.OutputStream( out, Base64.ENCODE )</code>