From e2ba19923127f268b715c23080319f9360dfa514 Mon Sep 17 00:00:00 2001
From: brutzman <brutzman@nps.edu>
Date: Thu, 1 Jul 2021 19:26:19 -0700
Subject: [PATCH] javadoc
---
examples/DisDemo/src/DisDemo/DisDemonstration.java | 3 ++-
examples/DisDemo/src/DisDemo/EntityMover.java | 6 +++++-
examples/DisDemo/src/DisDemo/EntityMoverSquare.java | 13 ++++++++++++-
3 files changed, 19 insertions(+), 3 deletions(-)
diff --git a/examples/DisDemo/src/DisDemo/DisDemonstration.java b/examples/DisDemo/src/DisDemo/DisDemonstration.java
index b8bd02903e..6d839c6a7e 100644
--- a/examples/DisDemo/src/DisDemo/DisDemonstration.java
+++ b/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<>();
diff --git a/examples/DisDemo/src/DisDemo/EntityMover.java b/examples/DisDemo/src/DisDemo/EntityMover.java
index db9fa5a527..c4cec41584 100644
--- a/examples/DisDemo/src/DisDemo/EntityMover.java
+++ b/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;
diff --git a/examples/DisDemo/src/DisDemo/EntityMoverSquare.java b/examples/DisDemo/src/DisDemo/EntityMoverSquare.java
index e57577368d..d30dfb38a6 100644
--- a/examples/DisDemo/src/DisDemo/EntityMoverSquare.java
+++ b/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);
--
GitLab