Skip to main content

[websocket-spec~source-code-repository:108] Tidying up use of @link throughout the javadoc of this classes

  • From:
  • To:
  • Subject: [websocket-spec~source-code-repository:108] Tidying up use of @link throughout the javadoc of this classes
  • Date: Wed, 9 Jan 2013 00:46:43 +0000

Project:    websocket-spec
Repository: source-code-repository
Revision:   108
Author:     dannycoward
Date:       2013-01-09 00:46:41 UTC
Link:       

Log Message:
------------
Tidying up use of @link throughout the javadoc of this classes


Revisions:
----------
108


Modified Paths:
---------------
trunk/api/src/main/java/javax/websocket/WebSocketMessage.java
trunk/api/src/main/java/javax/websocket/server/WebSocketPathParam.java
trunk/api/src/main/java/javax/websocket/WebSocketError.java
trunk/api/src/main/java/javax/websocket/WebSocketClose.java
trunk/api/src/main/java/javax/websocket/WebSocketClient.java
trunk/api/src/main/java/javax/websocket/WebSocketOpen.java


Diffs:
------
Index: trunk/api/src/main/java/javax/websocket/WebSocketError.java
===================================================================
--- trunk/api/src/main/java/javax/websocket/WebSocketError.java (revision 107)
+++ trunk/api/src/main/java/javax/websocket/WebSocketError.java (revision 108)
@@ -50,9 +50,9 @@
  * </p>
  * The method may only take the following parameters:-
  * <ul>
- * <li>optional Session parameter</li>
- * <li>a Throwable  parameter</li>
- * <li>Zero to n String parameters annotated with the @WebSocketPathParam 
annotation</li>
+ * <li>optional {@link Session} parameter</li>
+ * <li>a {@link java.lang.Throwable}  parameter</li>
+ * <li>Zero to n String parameters annotated with the {@link 
javax.websocket.server.WebSocketPathParam} annotation</li>
  * </ul>
  * The parameters may appear in any order.
  *
Index: trunk/api/src/main/java/javax/websocket/WebSocketOpen.java
===================================================================
--- trunk/api/src/main/java/javax/websocket/WebSocketOpen.java  (revision 107)
+++ trunk/api/src/main/java/javax/websocket/WebSocketOpen.java  (revision 108)
@@ -50,9 +50,9 @@
  * <p/>
  * <br> The method may only take the following parameters:-
  * <ul>
- * <li>optional Session parameter</li>
- * <li>optional EndpointConfig parameter</li>
- * <li>Zero to n String parameters annotated with the @WebSocketPathParam 
annotation.</li>
+ * <li>optional {@link Session} parameter</li>
+ * <li>optional {@link EndpointConfiguration} parameter</li>
+ * <li>Zero to n String parameters annotated with the {@link 
javax.websocket.server.WebSocketPathParam} annotation.</li>
  * </ul>
  * The parameters may appear in any order.
  *
Index: trunk/api/src/main/java/javax/websocket/WebSocketClose.java
===================================================================
--- trunk/api/src/main/java/javax/websocket/WebSocketClose.java (revision 107)
+++ trunk/api/src/main/java/javax/websocket/WebSocketClose.java (revision 108)
@@ -50,9 +50,9 @@
  * <p/>
  * The method may only take the following parameters:-
  * <ul>
- * <li>optional Session parameter</li>
- * <li>optional CloseReason parameter</li>
- * <li>Zero to n String parameters annotated with the @WebSocketPathParam 
annotation.</li>
+ * <li>optional {@link Session} parameter</li>
+ * <li>optional {@link CloseReason} parameter</li>
+ * <li>Zero to n String parameters annotated with the {@link 
javax.websocket.server.WebSocketPathParam} annotation.</li>
  * </ul>
  * The parameters may appear in any order.
  *
Index: trunk/api/src/main/java/javax/websocket/WebSocketClient.java
===================================================================
--- trunk/api/src/main/java/javax/websocket/WebSocketClient.java        
(revision 107)
+++ trunk/api/src/main/java/javax/websocket/WebSocketClient.java        
(revision 108)
@@ -46,7 +46,8 @@
 
 /**
  * The WebSocketClient annotation a class level annotation is used to denote 
that a POJO
- * is a web socket client and can be deployed as such. Similar to 
WebSocketEndpoints, POJOs that are
+ * is a web socket client and can be deployed as such. Similar to
+ * {@link javax.websocket.server.WebSocketEndpoint}s, POJOs that are
  * annotated with this annotation can have methods that, using the web 
socket method level annotations,
  * are web socket lifecycle methods.<br>
  *
Index: trunk/api/src/main/java/javax/websocket/server/WebSocketPathParam.java
===================================================================
--- trunk/api/src/main/java/javax/websocket/server/WebSocketPathParam.java    
  (revision 107)
+++ trunk/api/src/main/java/javax/websocket/server/WebSocketPathParam.java    
  (revision 108)
@@ -46,7 +46,7 @@
 
 /**
  * This annotation may be used to annotate method parameters on server side 
web socket POJOs
- * where a URI-template has been used in the path-mapping of the 
WebSocketEndpoint
+ * where a URI-template has been used in the path-mapping of the {@link 
WebSocketEndpoint}
  * annotation. The method parameter may be of type String, any Java primitive
  * type or any boxed version thereof. If a client URI matches the 
URI-template,
  * but the requested path parameter cannot be decoded, then the websocket's 
error
Index: trunk/api/src/main/java/javax/websocket/WebSocketMessage.java
===================================================================
--- trunk/api/src/main/java/javax/websocket/WebSocketMessage.java       
(revision 107)
+++ trunk/api/src/main/java/javax/websocket/WebSocketMessage.java       
(revision 108)
@@ -57,12 +57,12 @@
  * <li> String and boolean pair for partial text message processing</li>
  * <li> byte[] or ByteBuffer for whole binary message processing</li>
  * <li> byte[] and boolean pair, or ByteBuffer and boolean pair for partial 
binary message processing</li>
- * <li> any decodable object parameter (as determined by the Decoders 
configured for the endpoint)</li>
- * <li> PongMessage for handling Pong messages</li>
+ * <li> any decodable object parameter (as determined by the {@link 
Decoder}s configured for the endpoint)</li>
+ * <li> {@link PongMessage} for handling pong messages</li>
  * </ul>
  * <li> and Zero to n String or Java primitive parameters
- * annotated with the @WebSocketPathParam annotation for server 
endpoints.</li>
- * <li> and an optional Session parameter</li>
+ * annotated with the {@link javax.websocket.server.WebSocketPathParam} 
annotation for server endpoints.</li>
+ * <li> and an optional {@link Session} parameter</li>
  * </ol>
  * <p/>
  * The parameters may be listed in any order.<br><br>





[websocket-spec~source-code-repository:108] Tidying up use of @link throughout the javadoc of this classes

dannycoward 01/09/2013
 
 
Close
loading
Please Confirm
Close