added javadoc to clear warnings

src/edu/nps/moves/dis7/examples/AlphabeticalPduSender.java

@@ -31,6 +31,10 @@ public class AlphabeticalPduSender
   private int port;
   InetAddress multicastAddress;
 
+  /** Constructor
+     * @param port socket port number
+     * @param multicast multicast address
+     */
   public AlphabeticalPduSender(int port, String multicast)
   {
     try {
@@ -45,6 +49,7 @@ public class AlphabeticalPduSender
     }
   }
 
+  /** Invocable run method for this object */
   public void run()
   {
     try {
@@ -323,6 +328,9 @@ public class AlphabeticalPduSender
     }
   }
 
+  /** Command-line invocation (CLI)
+    * @param args command-line arguments
+    */
   public static void main(String args[])
   {
     AlphabeticalPduSender sender;

src/edu/nps/moves/dis7/examples/EntityStateEntityIdExampleUse.java

@@ -126,7 +126,11 @@ public class EntityStateEntityIdExampleUse
     // Do something here with the pdu you received
     System.out.println("Received "+pdu.getClass().getSimpleName());
   }
-  
+
+  /** Command-line invocation (CLI)
+    * @param args command-line arguments
+    * @throws java.lang.Exception if fails
+    */
   public static void main(String[] args) throws Exception
   {
       EntityStateEntityIdExampleUse.exampleUse(); // run example showing use

src/edu/nps/moves/dis7/examples/EspduReceiver.java

@@ -28,6 +28,9 @@ import java.util.List;
  */
 public class EspduReceiver
 {
+  /** Command-line invocation (CLI)
+    * @param args command-line arguments
+    */
   public static void main(String args[])
   {
     MulticastSocket socket;

src/edu/nps/moves/dis7/examples/EspduReceiverNIO.java

@@ -21,6 +21,9 @@ import java.net.MulticastSocket;
  */
 public class EspduReceiverNIO
 {
+  /** Command-line invocation (CLI)
+    * @param args command-line arguments
+    */
   public static void main(String args[])
   {
     MulticastSocket   socket;

src/edu/nps/moves/dis7/examples/EspduSender.java

@@ -22,11 +22,18 @@ import java.util.*;
  */
 public class EspduSender
 {
+  /** default value avoids unterminated zombie senders */
   public static final int NUMBER_TO_SEND = 5000;
 
+  /** TCP/IP network modes */
   public enum NetworkMode
   {
-    UNICAST, MULTICAST, BROADCAST
+    /** unicast socket */
+    UNICAST,
+    /** multicast socket */
+    MULTICAST,
+    /** broadcast socket */
+    BROADCAST
   };
 
   /**

src/edu/nps/moves/dis7/examples/EspduSenderNIO.java

@@ -24,6 +24,9 @@ import java.net.MulticastSocket;
  */
 public class EspduSenderNIO
 {
+  /** Command-line invocation (CLI)
+    * @param args command-line arguments
+    */
   public static void main(String args[])
   {
     MulticastSocket   socket;

src/edu/nps/moves/dis7/examples/PduListenerSaver.java

@@ -28,6 +28,9 @@ public class PduListenerSaver
     PAUSED;
   }
 
+  /** Command-line invocation (CLI)
+    * @param args command-line arguments
+    */
   public static void main(String[] args)
   {
     String outputDirectoryPath = DEFAULT_OUTPUT_DIRECTORY;

src/edu/nps/moves/dis7/examples/PduReaderPlayer.java

@@ -29,6 +29,9 @@ public class PduReaderPlayer
     PAUSED;
   }
 
+  /** Command-line invocation (CLI)
+    * @param args command-line arguments
+    */
   public static void main(String[] args)
   {
     String outDir = DEFAULT_OUTPUTDIR;

src/edu/nps/moves/dis7/examples/ThreadedNetExample.java

@@ -20,6 +20,9 @@ import edu.nps.moves.dis7.utilities.PduFactory;
  */
 public class ThreadedNetExample
 {
+  /** Command-line invocation (CLI)
+    * @param args command-line arguments
+    */
   public static void main(String[] args)
   {
     // Create an instance of DisThreadedNetworkInterface using default port 3000, mcast 225.4.5.6, use other constructor to specific port and ip

src/edu/nps/moves/dis7/examples/package-info.java

+/**
+ * Example classes using edu.nps.moves.dis7 library.
+ */
+// https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java
+
+package edu.nps.moves.dis7.examples;

src/edu/nps/moves/dis7/utilities/CoordinateConversions.java

@@ -12,7 +12,9 @@ package edu.nps.moves.dis7.utilities;
  */
 public class CoordinateConversions
 {
+    /** conversion factor */
     public static final double RADIANS_TO_DEGREES = 180.0/Math.PI;
+    /** conversion factor */
     public static final double DEGREES_TO_RADIANS = Math.PI/180.0;
     
     private CoordinateConversions()

src/edu/nps/moves/dis7/utilities/TrialDisMulticastNetworkingDeprecated.java

@@ -24,11 +24,13 @@ import java.util.logging.Logger;
 @Deprecated(since="dis7")
 public class TrialDisMulticastNetworkingDeprecated
 {
+  /** deprecated */
   public class ByteArrayBufferAndLength
   {
     public byte[] bufferByteArray;
     public int length;
 
+  /* deprecated do not use */
     public ByteArrayBufferAndLength(byte[] bufferByteArray, int length)
     {
       this.bufferByteArray = bufferByteArray;
@@ -46,11 +48,13 @@ public class TrialDisMulticastNetworkingDeprecated
   private InetSocketAddress group;
   private NetworkInterface ni;
 
+  /* deprecated do not use */
   public TrialDisMulticastNetworkingDeprecated()
   {
     this(DisThreadedNetworkInterface.DEFAULT_DIS_PORT, DisThreadedNetworkInterface.DEFAULT_MULTICAST_ADDRESS);
   }
 
+  /* deprecated do not use */
   public TrialDisMulticastNetworkingDeprecated(int port, String mcastgroup)
   {
     DIS_PORT = port;
@@ -66,16 +70,19 @@ public class TrialDisMulticastNetworkingDeprecated
     dos = new DataOutputStream(baos);
   }
 
+  /* deprecated do not use */
   public int getPort()
   {
     return DIS_PORT;
   }
 
+  /* deprecated do not use */
   public String getIp()
   {
     return MCAST_GROUP;
   }
 
+  /* deprecated do not use */
   public void stop()
   {
     if(rsocket != null) {
@@ -88,7 +95,8 @@ public class TrialDisMulticastNetworkingDeprecated
       ssocket = null;
     }
   }
-  
+
+  /* deprecated do not use */
   public Pdu receivePdu() throws IOException
   {
     PduFactory pduFactory = new PduFactory();
@@ -99,6 +107,7 @@ public class TrialDisMulticastNetworkingDeprecated
   private MulticastSocket rsocket;
   byte buffer[];
   DatagramPacket packet;
+  /* deprecated do not use */
   public ByteArrayBufferAndLength receiveRawPdu() throws IOException
   {
     rsocket = new MulticastSocket(DIS_PORT);

src/edu/nps/moves/dis7/utilities/package-info.java

+/**
+ * Utility classes supporting edu.nps.moves.dis7 library.
+ */
+// https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java
+
+package edu.nps.moves.dis7.utilities;

src/edu/nps/moves/dis7/utilities/stream/PduPlayer.java

@@ -29,6 +29,7 @@ public class PduPlayer {
 
     /** PDU listener interface */
     public interface RawListener {
+        /** callback */
         void receiveBytes(byte[] ba);
     }
     
@@ -37,15 +38,15 @@ public class PduPlayer {
     private int port;
     private Thread thrd;
 
-    static final String ENCODING_BASE64 = "ENCODING_BASE64";
-    static final String ENCODING_PLAINTEXT = "ENCODING_PLAINTEXT";
-    static final String ENCODING_BINARY = "ENCODING_BINARY";  // TODO likely requires different code path
-    static final String ENCODING_XML = "ENCODING_XML";     // TODO, repeat Open-DIS version 4 effort
-    static final String ENCODING_EXI = "ENCODING_EXI";     // TODO, use Exificient or Nagasena libraries
-    static final String ENCODING_JSON = "ENCODING_JSON";    // TODO, repeat Open-DIS version 4 effort
+    static final String ENCODING_BASE64          = "ENCODING_BASE64";
+    static final String ENCODING_PLAINTEXT       = "ENCODING_PLAINTEXT";
+    static final String ENCODING_BINARY          = "ENCODING_BINARY";  // TODO likely requires different code path
+    static final String ENCODING_XML             = "ENCODING_XML";     // TODO, repeat Open-DIS version 4 effort
+    static final String ENCODING_EXI             = "ENCODING_EXI";     // TODO, use Exificient or Nagasena libraries
+    static final String ENCODING_JSON            = "ENCODING_JSON";    // TODO, repeat Open-DIS version 4 effort
+    static final String ENCODING_CDIS            = "ENCODING_CDIS";    // future work based on new SISO standard
     static final String ENCODING_MAK_DATA_LOGGER = "ENCODING_MAK_DATA_LOGGER";        // verbose pretty-print. perhaps output only (MAK format itself is binary)
     static final String ENCODING_WIRESHARK_DATA_LOGGER = "ENCODING_WIRESHARK_DATA_LOGGER"; // 
-    static final String ENCODING_CDIS = "ENCODING_CDIS";    // future work based on new SISO standard
 
     private static String pduLogEncoding = ENCODING_PLAINTEXT; // TODO use Java enumerations, generalize/share across library
 
@@ -392,15 +393,17 @@ public class PduPlayer {
         }
         return returnValue;
     }
-
+    /** Start or resume this instance */
     public void startResume() {
         paused = false;
     }
 
+    /** Stop or pause this instance */
     public void stopPause() {
         paused = true;
     }
 
+    /** End operation of this instance */
     public void end() {
         closer();
     }

src/edu/nps/moves/dis7/utilities/stream/PduRecorder.java

@@ -28,6 +28,7 @@ import org.apache.commons.io.FilenameUtils;
  */
 public class PduRecorder implements PduReceiver
 {
+  /** Character sentinel indicating remainder of line is a comment */
   public static final String COMMENT_MARKER = "#";
   
   static String outputDirectoryPath   = "./pduLog";
@@ -126,17 +127,18 @@ public class PduRecorder implements PduReceiver
     public static void setPduLogEncoding(String newPduLogEncoding) {
         pduLogEncoding = newPduLogEncoding;
     }
-  
+
+  /** Start or resume this instance */
   public void startResume()
   {
     running = true;
   }
-  
+  /** Stop or pause this instance */
   public void stopPause()
   {
     running = false;
   }
-  
+  /** End operation of this instance */
   public File end()
   {
     running = false;

src/edu/nps/moves/dis7/utilities/stream/X3dCoordinates.java

@@ -38,50 +38,74 @@ public class X3dCoordinates {
         this.theta = theta;
     }
 
+    /** accessor method for angle of rotation
+     * @return current value */
     public double getPhi() {
         return phi;
     }
 
+    /** accessor method to set angle of rotation
+     * @param phi new angle value */
     public void setPhi(double phi) {
         this.phi = phi;
     }
 
+    /** accessor method for angle of rotation
+     * @return current value */
     public double getPsi() {
         return psi;
     }
 
+    /** accessor method to set angle of rotation
+     * @param psi new angle value */
     public void setPsi(double psi) {
         this.psi = psi;
     }
 
+    /** accessor method for angle of rotation
+     * @return current value */
     public double getTheta() {
         return theta;
     }
 
+    /** accessor method to set angle of rotation
+     * @param theta new angle value */
     public void setTheta(double theta) {
         this.theta = theta;
     }
 
+    /** accessor method to get coordinate x value
+      * @return current value */
     public double getX() {
         return x;
     }
 
+    /** accessor method to set coordinate x value
+     * @param x coordinate value to set */
     public void setX(double x) {
         this.x = x;
     }
 
+    /** accessor method to get coordinate y value
+      * @return current value */
     public double getY() {
         return y;
     }
 
+    /** accessor method to set coordinate y value
+     * @param y coordinate value to set */
     public void setY(double y) {
         this.y = y;
     }
 
+    /** accessor method to get coordinate z value
+      * @return current value */
     public double getZ() {
         return z;
     }
 
+    /** accessor method to set coordinate z value
+     * @param z coordinate value to set */
     public void setZ(double z) {
         this.z = z;
     }

src/edu/nps/moves/dis7/utilities/stream/X3dCreateInterpolators.java

@@ -35,6 +35,8 @@ public class X3dCreateInterpolators {
     private NumberFormat coordinateNumberFormat = NumberFormat.getInstance(new Locale("en", "US"));
 
     // -------------------- End Variables for Position Interpolator
+
+    /** Default Constructor */
     public X3dCreateInterpolators() {
 
         //3 significant digits equals milimeter position accuracy and 0.001 radians = 0.0572963266634555‬ degrees

src/edu/nps/moves/dis7/utilities/stream/package-info.java

+/**
+ * Streaming utility classes supporting edu.nps.moves.dis7 library.
+ */
+// https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java
+
+package edu.nps.moves.dis7.utilities.stream;

src/edu/nps/moves/spatial/package-info.java

+/**
+ * Spatial utility classes supporting edu.nps.moves.dis7 library.
+ */
+// https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java
+
+package edu.nps.moves.spatial;