javadoc entries

examples/WebsocketGateway/nbproject/project.properties

@@ -91,7 +91,7 @@ javadoc.private=false
 javadoc.splitindex=true
 javadoc.use=true
 javadoc.version=false
-javadoc.windowtitle=
+javadoc.windowtitle=${application.title} Demonstration
 jlink.launcher=false
 jlink.launcher.name=WebsocketGateway
 jnlp.codebase.type=no.codebase

examples/WebsocketGateway/src/edu/nps/moves/gateway/ConnectionManager.java

@@ -48,7 +48,8 @@ public class ConnectionManager
      * Add a client connection to the list. Messages will be
      * relayed to this client.
      * 
-     * @param aConnection 
+     * @param aConnection a DISEndpoint instance
+     * @see DISEndpoint
      */
     public synchronized void addConnection(DISEndpoint aConnection)
     {
@@ -60,7 +61,8 @@ public class ConnectionManager
      * typically called when a client closes the connection. We remove it
      * from the list of active connections.
      * 
-     * @param aConnection 
+     * @param aConnection a DISEndpoint instance
+     * @see DISEndpoint
      */
     public synchronized void removeConnection(DISEndpoint aConnection)
     {

examples/WebsocketGateway/src/edu/nps/moves/gateway/DISEndpoint.java

@@ -10,12 +10,12 @@ package edu.nps.moves.gateway;
 public interface DISEndpoint 
 {
     /** Send binary format DIS to an endpoint.
-     * @param buf 
+     * @param buf raw array of DIS data
      */
    void sendBinaryToClient(byte[] buf);
    
    /** Send JSON format DIS to a client
-     * @param aMessage 
+     * @param aMessage string containing message info
      */
    void sendToClient(String aMessage);
 }

examples/WebsocketGateway/src/edu/nps/moves/gateway/DisNative.java

@@ -79,9 +79,9 @@ public class DisNative implements Runnable, DISEndpoint {
      * Constructor
      *
      * @param socket socket we read and write on.
-     * @param multicastAddress If null we read & write bcast. Otherwise mcast on
+     * @param multicastAddress If null we read & write bcast. Otherwise mcast on
      * this address
-     * @param port
+     * @param port port number
      */
     public DisNative(MulticastSocket socket, InetAddress multicastAddress, int port) {
         this.multicastSocket = socket;
@@ -223,7 +223,7 @@ public class DisNative implements Runnable, DISEndpoint {
      * simply no-op this because it doesn't make sense to send a non-standard
      * string to the network.
      *
-     * @param aMessage
+     * @param aMessage string containing message info
      */
     @Override
     public void sendToClient(String aMessage) {

examples/WebsocketGateway/src/edu/nps/moves/gateway/WebPageConnection.java

@@ -68,8 +68,8 @@ public class WebPageConnection implements DISEndpoint
     /** Fired when a client sends a binary message. 
      *
      * @param buf binary data
-     * @param offset
-     * @param length 
+     * @param offset in array for binary data
+     * @param length of binary data in array
      */
     @OnWebSocketMessage
     public void onBinaryMessage(byte buf[], int offset, int length)
@@ -128,7 +128,7 @@ public class WebPageConnection implements DISEndpoint
      * Sends data in binary format to the client. The end client is typically
      * another web page.
      * 
-     * @param buf 
+     * @param buf binary array containing DIS data
      */
     @Override
     public void sendBinaryToClient(byte[] buf)

examples/WebsocketGateway/src/edu/nps/moves/gateway/WebSocketServer.java

@@ -178,7 +178,7 @@ public class WebSocketServer
      * Entry point.Create a new Server class, initialize it, and start it. Give
      * user a clean way to exit program gracefully by typing a "q" on the
      * command line.
-     * @param args
+     * @param args program entry arguments (if any)
      */
     public static void main(String[] args)
     {