add javadoc

test/edu/nps/moves/dis7/test/BitFieldRoundTripTest.java

@@ -21,24 +21,28 @@ import static org.junit.jupiter.api.Assertions.assertTrue;
  * Unit tests for satisfactory handling of various necessary bit fields, supporting each data type.
  * @author Don McGregor
  */
-@DisplayName("Bit Field Round TripTest")
+@DisplayName("Bit Field Round Trip Test")
 public class BitFieldRoundTripTest
 {
     Pdu receivedPdu;
     DisThreadedNetworkInterface disNetworkInterface;
     DisThreadedNetworkInterface.PduListener pduListener;
 
+  /** test method override */
   @BeforeAll
   public static void setUpClass()
   {
-    System.out.println("BitFieldRoundTripTest");
+    System.out.println("BitFieldRoundTripTest setUpClass()");
   }
 
+  /** test method override */
   @AfterAll
   public static void tearDownClass()
   {
+    System.out.println("BitFieldRoundTripTest tearDownClass()");
   }
 
+  /** setup disNetworkInterface and pduListener */
   @BeforeEach
   public void setUp()
   {   
@@ -52,6 +56,7 @@ public class BitFieldRoundTripTest
       disNetworkInterface.addListener(pduListener);
   }
 
+  /** Tear down disNetworkInterface */
   @AfterEach
   public void tearDown()
   {
@@ -59,6 +64,7 @@ public class BitFieldRoundTripTest
       disNetworkInterface.close();
   }
 
+  /** Test PDU sending, receiving, marshalling (serialization) and unmarshalling (deserialization) */
   @Test
   public void testRoundTrip()
   {
@@ -101,6 +107,8 @@ public class BitFieldRoundTripTest
     assertTrue(same, "Sent and received pdu not the same");
   }
 
+  /** Callback method for pduListener
+   * @param pdu received PDU*/
   private void setUpReceiver(Pdu pdu)
   {
     receivedPdu = pdu;
@@ -131,11 +139,16 @@ public class BitFieldRoundTripTest
     System.out.println();
  }
   
-  public static void main(String[] args)
-  {
-    BitFieldRoundTripTest brt = new BitFieldRoundTripTest();
-    brt.setUp();
-    brt.testRoundTrip();
-    brt.tearDown();
-  }
+    /**
+     * Main method for testing.
+     * @see <a href="https://docs.oracle.com/javase/tutorial/getStarted/application/index.html">Java Tutorials: A Closer Look at the "Hello World!" Application</a>
+     * @param args [address, port, descriptor] command-line arguments are an array of optional String parameters that are passed from execution environment during invocation
+     */
+    public static void main(String[] args)
+    {
+        BitFieldRoundTripTest bitFieldRoundTripTest = new BitFieldRoundTripTest();
+        bitFieldRoundTripTest.setUp();
+        bitFieldRoundTripTest.testRoundTrip();
+        bitFieldRoundTripTest.tearDown();
+    }
 }

test/edu/nps/moves/dis7/test/FirePduTest.java

@@ -64,6 +64,11 @@ public class FirePduTest extends PduTest
      testPduFinishingChecks(createdPdu); // shared tests in superclass
   }
   
+    /**
+     * Main method for testing.
+     * @see <a href="https://docs.oracle.com/javase/tutorial/getStarted/application/index.html">Java Tutorials: A Closer Look at the "Hello World!" Application</a>
+     * @param args [address, port, descriptor] command-line arguments are an array of optional String parameters that are passed from execution environment during invocation
+     */
     public static void main(String[] args)
     {
         FirePduTest firePduTest = new FirePduTest();

test/edu/nps/moves/dis7/test/FixedAndVariableDatumRoundTripTest.java

@@ -24,17 +24,21 @@ public class FixedAndVariableDatumRoundTripTest
   DisThreadedNetworkInterface disNetworkInterface;
   DisThreadedNetworkInterface.PduListener pduListener;
 
+  /** test method override */
   @BeforeAll
   public static void setUpClass()
   {
-    System.out.println("FixedAndVariableDatumRoundTripTest");
+    System.out.println("FixedAndVariableDatumRoundTripTest setUpClass()");
   }
 
+  /** test method override */
   @AfterAll
   public static void tearDownClass()
   {
+    System.out.println("FixedAndVariableDatumRoundTripTest tearDownClass()");
   }
 
+  /** setup disNetworkInterface and pduListener */
   @BeforeEach
   public void setUp()
   {   
@@ -48,6 +52,7 @@ public class FixedAndVariableDatumRoundTripTest
       disNetworkInterface.addListener(pduListener);
   }
 
+  /** Tear down disNetworkInterface */
   @AfterEach
   public void tearDown()
   {
@@ -91,6 +96,7 @@ public class FixedAndVariableDatumRoundTripTest
     variableDatum2.setVariableDatumValue(variableDatum2Value);
   }
 
+  /** Test PDU sending, receiving, marshalling (serialization) and unmarshalling (deserialization) */
   @Test
   public void testRoundTrip()
   {
@@ -119,16 +125,23 @@ public class FixedAndVariableDatumRoundTripTest
     assertTrue(receivedPdu.equals(sentPdu),"Sent and received pdus not identical");
   }
 
+  /** Callback method for pduListener
+   * @param pdu received PDU*/
   private void setUpReceiver(Pdu pdu)
   {
-    receivedPdu = pdu;
+        receivedPdu = pdu;
   }
 
-  public static void main(String[] args)
-  {
-    FixedAndVariableDatumRoundTripTest frt = new FixedAndVariableDatumRoundTripTest();
-    frt.setUp();
-    frt.testRoundTrip();
-    frt.tearDown();
-  }
+    /**
+     * Main method for testing.
+     * @see <a href="https://docs.oracle.com/javase/tutorial/getStarted/application/index.html">Java Tutorials: A Closer Look at the "Hello World!" Application</a>
+     * @param args [address, port, descriptor] command-line arguments are an array of optional String parameters that are passed from execution environment during invocation
+     */
+    public static void main(String[] args)
+    {
+      FixedAndVariableDatumRoundTripTest frt = new FixedAndVariableDatumRoundTripTest();
+      frt.setUp();
+      frt.testRoundTrip();
+      frt.tearDown();
+    }
 }