From 336b09df0e55e4c27d77160d6b95ba958d02b6ba Mon Sep 17 00:00:00 2001
From: brutzman <brutzman@nps.edu>
Date: Sat, 1 Jan 2022 15:05:55 -0800
Subject: [PATCH] javadoc
---
.../src/OpenDis7Examples/ExampleSimulationProgram.java | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/examples/src/OpenDis7Examples/ExampleSimulationProgram.java b/examples/src/OpenDis7Examples/ExampleSimulationProgram.java
index db21cc89de..c024ff8add 100644
--- a/examples/src/OpenDis7Examples/ExampleSimulationProgram.java
+++ b/examples/src/OpenDis7Examples/ExampleSimulationProgram.java
@@ -20,6 +20,7 @@ import java.util.logging.Logger;
* that includes DIS-capable entities performing tasks of interest, and then reporting activity via PDUs
* to the network.
* Default program initialization includes PDU recording turned on by default.
+ * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleSimulationProgramLog.txt">ExampleSimulationProgramLog.txt</a>
*/
public class ExampleSimulationProgram
{
@@ -38,13 +39,13 @@ public class ExampleSimulationProgram
double simulationTime;
/**
- * Output prefix to identify this class (override in subclass), helps with logging
+ * Output prefix to help with logging by identifying this class (overridden in subclass).
*/
protected static String TRACE_PREFIX;
/**
- * This runSimulationLoops() method is for you, a programmer-modifiable code block
- * for defining and running a new simulation of interest.
+ * This runSimulationLoops() method is for you, a customizable programmer-modifiable
+ * code block for defining and running a new simulation of interest.
*
* Welcome! Other parts of this program handle bookkeeping and plumbing tasks so that
* you can focus on your model entities and activities.
@@ -151,7 +152,7 @@ public class ExampleSimulationProgram
// loop now finished, check whether to terminate if simulation complete, otherwise continue
if (simulationComplete || (simulationLoopCount > 10000)) // for example; including fail-safe condition is good
{
- System.out.println ("... [Termination condition met, simulationComplete=" + simulationComplete + "]"); // ", final loopCount=" + loopCount +
+ System.out.println ("... [loop termination condition met, simulationComplete=" + simulationComplete + "]"); // ", final loopCount=" + loopCount +
break;
}
} // end of simulation loop
--
GitLab