javadoc

examples/DisDemo/src/DisDemo/DisDemonstration.java

@@ -117,7 +117,8 @@ public class DisDemonstration {
         }
         
     }
-    
+    /** Get list of network addresses for broadcast packets
+     * @return list of network addresses */
     public static List<InetAddress> getBroadcastAddresses()
     {
         List<InetAddress> broadcastAddresses = new ArrayList<>();

examples/DisDemo/src/DisDemo/EntityMover.java

@@ -14,13 +14,17 @@ public abstract class EntityMover
 {
     Vector3Double position;
     
+    /** Superclass constructor
+     * @param startPosition initial coordinate point */
     public EntityMover(Vector3Double startPosition)
     {
         this.position = startPosition;
     }
-    
+    /** single-step movement */
     public abstract void step();
     
+    /** provide current location
+      * @return current location */
     public Vector3Double getPosition()
     {
         return position;

examples/DisDemo/src/DisDemo/EntityMoverSquare.java

@@ -15,10 +15,21 @@ public class EntityMoverSquare extends EntityMover
     /** How big the square we move around is */
     private static final int SQUARE_SIZE = 50;  // size of a side to the square, in meters
     /** Directions we can travel. */
-    public enum Direction{NORTH, EAST, SOUTH, WEST};
+    public enum Direction{
+        /** value choice */
+        NORTH, 
+        /** value choice */
+        EAST, 
+        /** value choice */
+        SOUTH, 
+        /** value choice */
+        WEST};
     
+    /** direction of movement */
     public Direction currentDirection;
     
+    /** instance constructor
+     * @param position initial coordinate */
     public EntityMoverSquare(Vector3Double position)
     {
         super(position);