Skip to content
Snippets Groups Projects
Commit f5e61443 authored by Brutzman, Don's avatar Brutzman, Don
Browse files

javadoc cleanups, target="_blank"

parent 18615b66
No related branches found
No related tags found
No related merge requests found
...@@ -40,9 +40,9 @@ public class EspduSender ...@@ -40,9 +40,9 @@ public class EspduSender
public static final int DEFAULT_MULTICAST_PORT = 3000; public static final int DEFAULT_MULTICAST_PORT = 3000;
/** Type of network connection: /** Type of network connection:
* Point to point <a href="https://en.wikipedia.org/wiki/Unicast">UNICAST</a>, * Point to point <a href="https://en.wikipedia.org/wiki/Unicast" target="_blank">UNICAST</a>,
* Many to many <a href="https://en.wikipedia.org/wiki/Multicast">MULTICAST</a>, or * Many to many <a href="https://en.wikipedia.org/wiki/Multicast" target="_blank">MULTICAST</a>, or
* (rarely used, potentially harmful) <a href="https://en.wikipedia.org/wiki/Broadcasting_(networking)">BROADCAST</a> * (rarely used, potentially harmful) <a href="https://en.wikipedia.org/wiki/Broadcasting_(networking)" target="_blank">BROADCAST</a>
*/ */
public enum NetworkMode { public enum NetworkMode {
/** Point to point @see <a href="https://en.wikipedia.org/wiki/Unicast" target="_blank">https://en.wikipedia.org/wiki/Unicast</a> */ /** Point to point @see <a href="https://en.wikipedia.org/wiki/Unicast" target="_blank">https://en.wikipedia.org/wiki/Unicast</a> */
......
...@@ -19,11 +19,11 @@ import java.util.logging.Logger; ...@@ -19,11 +19,11 @@ import java.util.logging.Logger;
* example simulation program that includes DIS-capable entities performing * example simulation program that includes DIS-capable entities performing
* tasks of interest, and then reporting activity via PDUs to the network. * tasks of interest, and then reporting activity via PDUs to the network.
* Default program initialization includes PDU recording turned on by default. * 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> * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleSimulationProgramLog.txt" target="_blank">ExampleSimulationProgramLog.txt</a>
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleSimulationProgramPduCaptureLog.dislog">ExampleSimulationProgramPduCaptureLog.dislog</a> * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleSimulationProgramPduCaptureLog.dislog" target="_blank">ExampleSimulationProgramPduCaptureLog.dislog</a>
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleSimulationProgramFlowDiagram.pdf">ExampleSimulationProgramFlowDiagram.pdf</a> * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleSimulationProgramFlowDiagram.pdf" target="_blank">ExampleSimulationProgramFlowDiagram.pdf</a>
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleSimulationProgramWireshark.png">ExampleSimulationProgramWireshark.png</a> * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleSimulationProgramWireshark.png" target="_blank">ExampleSimulationProgramWireshark.png</a>
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleSimulationProgramSequenceDiagram.png">ExampleSimulationProgramSequenceDiagram.png</a> * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleSimulationProgramSequenceDiagram.png" target="_blank">ExampleSimulationProgramSequenceDiagram.png</a>
*/ */
public class ExampleSimulationProgram public class ExampleSimulationProgram
{ {
...@@ -312,7 +312,7 @@ public class ExampleSimulationProgram ...@@ -312,7 +312,7 @@ public class ExampleSimulationProgram
* @param comments String array of narrative comments * @param comments String array of narrative comments
* @see DisChannel * @see DisChannel
// * @see DisTime // TODO find renamed version // * @see DisTime // TODO find renamed version
* @see <a href="https://docs.oracle.com/javase/tutorial/java/javaOO/arguments.html">Passing Information to a Method or a Constructor</a> Arbitrary Number of Arguments * @see <a href="https://docs.oracle.com/javase/tutorial/java/javaOO/arguments.html" target="_blank">Passing Information to a Method or a Constructor</a> Arbitrary Number of Arguments
*/ */
public void sendAllPdusForLoopTimestep(double simTimeSeconds, public void sendAllPdusForLoopTimestep(double simTimeSeconds,
EntityStatePdu entityStatePdu, EntityStatePdu entityStatePdu,
...@@ -390,7 +390,7 @@ public class ExampleSimulationProgram ...@@ -390,7 +390,7 @@ public class ExampleSimulationProgram
/** /**
* Main method is first executed when a program instance is loaded. * Main method is first executed when a program instance is loaded.
* @see <a href="https://docs.oracle.com/javase/tutorial/getStarted/application/index.html">Java Tutorials: A Closer Look at the "Hello World!" Application</a> * @see <a href="https://docs.oracle.com/javase/tutorial/getStarted/application/index.html" target="_blank">Java Tutorials: A Closer Look at the "Hello World!" Application</a>
* @param args command-line parameters: network address and port. * @param args command-line parameters: network address and port.
* Command-line arguments are an array of optional String parameters that are passed from execution environment during invocation * Command-line arguments are an array of optional String parameters that are passed from execution environment during invocation
*/ */
......
...@@ -24,8 +24,8 @@ import java.util.logging.Logger; ...@@ -24,8 +24,8 @@ import java.util.logging.Logger;
* simulation for networked entity tracks and presentation, including * simulation for networked entity tracks and presentation, including
* DIS-capable entities doing tasks and reporting them to the network. * DIS-capable entities doing tasks and reporting them to the network.
* Default settings include PDU recording turned on by default. * Default settings include PDU recording turned on by default.
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleTrackInterpolationLog.txt">ExampleTrackInterpolationLog.txt</a> * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/blob/master/examples/src/OpenDis7Examples/ExampleTrackInterpolationLog.txt" target="_blank">ExampleTrackInterpolationLog.txt</a>
* @see <a href="https://calhoun.nps.edu/handle/10945/65436">REPEATABLE UNIT TESTING OF DISTRIBUTED INTERACTIVE SIMULATION (DIS) PROTOCOL BEHAVIOR STREAMS USING WEB STANDARDS</a> by Tobias Brennenstuhl, Masters Thesis, Naval Postgraduate School (NPS), June 2020 * @see <a href="https://calhoun.nps.edu/handle/10945/65436" target="_blank">REPEATABLE UNIT TESTING OF DISTRIBUTED INTERACTIVE SIMULATION (DIS) PROTOCOL BEHAVIOR STREAMS USING WEB STANDARDS</a> by Tobias Brennenstuhl, Masters Thesis, Naval Postgraduate School (NPS), June 2020
* @see <a href="https://gitlab.nps.edu/Savage/SavageTheses/-/tree/master/BrennenstuhlTobias" target="_blank">https://gitlab.nps.edu/Savage/SavageTheses/-/tree/master/BrennenstuhlTobias</a> * @see <a href="https://gitlab.nps.edu/Savage/SavageTheses/-/tree/master/BrennenstuhlTobias" target="_blank">https://gitlab.nps.edu/Savage/SavageTheses/-/tree/master/BrennenstuhlTobias</a>
*/ */
public class ExampleTrackInterpolation extends ExampleSimulationProgram public class ExampleTrackInterpolation extends ExampleSimulationProgram
...@@ -231,7 +231,7 @@ public class ExampleTrackInterpolation extends ExampleSimulationProgram ...@@ -231,7 +231,7 @@ public class ExampleTrackInterpolation extends ExampleSimulationProgram
* Main method is first executed when a program instance is loaded. * Main method is first executed when a program instance is loaded.
* *
* @see * @see
* <a href="https://docs.oracle.com/javase/tutorial/getStarted/application/index.html">Java * <a href="https://docs.oracle.com/javase/tutorial/getStarted/application/index.html" target="_blank">Java
* Tutorials: A Closer Look at the "Hello World!" Application</a> * Tutorials: A Closer Look at the "Hello World!" Application</a>
* @param args command-line arguments are an array of optional String * @param args command-line arguments are an array of optional String
* parameters that are passed from execution environment during invocation * parameters that are passed from execution environment during invocation
......
...@@ -345,8 +345,8 @@ public class PduTrack ...@@ -345,8 +345,8 @@ public class PduTrack
/** /**
* Sort all PDUs by timestamp * Sort all PDUs by timestamp
* @see <a href="https://stackoverflow.com/questions/16252269/how-to-sort-an-arraylist">StackOverflow: How to sort an ArrayList?</a> * @see <a href="https://stackoverflow.com/questions/16252269/how-to-sort-an-arraylist" target="_blank">StackOverflow: How to sort an ArrayList?</a>
* @see <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/doc-files/coll-overview.html">Collections Framework Overview</a> * @see <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/doc-files/coll-overview.html" target="_blank">Collections Framework Overview</a>
* @return same object to permit progressive setters * @return same object to permit progressive setters
*/ */
public PduTrack sortPdus() public PduTrack sortPdus()
...@@ -367,8 +367,8 @@ public class PduTrack ...@@ -367,8 +367,8 @@ public class PduTrack
} }
/** /**
* Reverse order of PDU list * Reverse order of PDU list
* @see <a href="https://stackoverflow.com/questions/10766492/what-is-the-simplest-way-to-reverse-an-arraylist">StackOverflow: What is the Simplest Way to Reverse an ArrayList?</a> * @see <a href="https://stackoverflow.com/questions/10766492/what-is-the-simplest-way-to-reverse-an-arraylist" target="_blank">StackOverflow: What is the Simplest Way to Reverse an ArrayList?</a>
* @see <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/doc-files/coll-overview.html">Collections Framework Overview</a> * @see <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/doc-files/coll-overview.html" target="_blank">Collections Framework Overview</a>
* @return same object to permit progressive setters * @return same object to permit progressive setters
*/ */
public PduTrack reversePdus() public PduTrack reversePdus()
...@@ -1023,7 +1023,7 @@ public class PduTrack ...@@ -1023,7 +1023,7 @@ public class PduTrack
/** /**
* Main method for testing. * 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> * @see <a href="https://docs.oracle.com/javase/tutorial/getStarted/application/index.html" target="_blank">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 * @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) public static void main(String[] args)
......
...@@ -13,8 +13,8 @@ import simkit.random.RandomVariate; ...@@ -13,8 +13,8 @@ import simkit.random.RandomVariate;
* *
* @see SimkitOpenDis7Examples.SimpleServer * @see SimkitOpenDis7Examples.SimpleServer
* @see SimkitOpenDis7Examples.run.RunSimpleServerOpenDis7 * @see SimkitOpenDis7Examples.run.RunSimpleServerOpenDis7
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/raw/master/examples/src/SimkitOpenDis7Examples/ArrivalProcessOpenDis7EventGraph.png">ArrivalProcessDisPdu.png</a> * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/raw/master/examples/src/SimkitOpenDis7Examples/ArrivalProcessOpenDis7EventGraph.png" target="_blank">ArrivalProcessDisPdu.png</a>
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/raw/master/examples/src/SimkitOpenDis7Examples/SimpleServerComponentEventGraph.png">SimpleServerComponentEventGraph.png</a> * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/raw/master/examples/src/SimkitOpenDis7Examples/SimpleServerComponentEventGraph.png" target="_blank">SimpleServerComponentEventGraph.png</a>
* @author abuss@nps.edu * @author abuss@nps.edu
* @author brutzman@nps.edu * @author brutzman@nps.edu
*/ */
......
...@@ -15,9 +15,9 @@ import simkit.SimEntityBase; ...@@ -15,9 +15,9 @@ import simkit.SimEntityBase;
/** /**
* Add DIS outputs to TwoCraneBerths simkit simulation * Add DIS outputs to TwoCraneBerths simkit simulation
* @see SimkitOpenDis7Examples.TwoCraneBerths * @see SimkitOpenDis7Examples.TwoCraneBerths
* @see <a href="run/RunTwoCranesBerthOpenDis7Log.txt">RunTwoCranesBerthOpenDis7Log.txt</a> * @see <a href="run/RunTwoCranesBerthOpenDis7Log.txt" target="_blank">RunTwoCranesBerthOpenDis7Log.txt</a>
* @see <a href="TwoCraneBerthsAssignment05.docx">TwoCraneBerthsAssignment05.docx</a> * @see <a href="TwoCraneBerthsAssignment05.docx" target="_blank">TwoCraneBerthsAssignment05.docx</a>
* @see <a href="TwoCraneBerthsAssignment05Solution.docx">TwoCraneBerthsAssignment05Solution.docx</a> * @see <a href="TwoCraneBerthsAssignment05Solution.docx" target="_blank">TwoCraneBerthsAssignment05Solution.docx</a>
* @author abuss@nps.edu@nps.edu * @author abuss@nps.edu@nps.edu
* @author brutzman@nps.edu * @author brutzman@nps.edu
*/ */
...@@ -216,7 +216,7 @@ public class TwoCraneBerthsOpenDis7 extends SimEntityBase ...@@ -216,7 +216,7 @@ public class TwoCraneBerthsOpenDis7 extends SimEntityBase
* @param simkitTimeStamp simkit timeStamp when crane operations began * @param simkitTimeStamp simkit timeStamp when crane operations began
* @param numberContainers how many container boxes to offload * @param numberContainers how many container boxes to offload
* @param pierDistanceForCraneOffload Y coordinate down pier across from ship's berth, aligned with cargo * @param pierDistanceForCraneOffload Y coordinate down pier across from ship's berth, aligned with cargo
* @see <a href="https://en.wikipedia.org/wiki/The_Box_(Levinson_book)">The Box: How the Shipping Container Made the World Smaller and the World Economy Bigger is</a> * @see <a href="https://en.wikipedia.org/wiki/The_Box_(Levinson_book)" target="_blank">The Box: How the Shipping Container Made the World Smaller and the World Economy Bigger is</a>
*/ */
public void reportCraneContainerUnloadOperationsDIS( public void reportCraneContainerUnloadOperationsDIS(
double simkitTimeStamp, double simkitTimeStamp,
......
...@@ -27,9 +27,9 @@ import simkit.util.SimplePropertyDumper; ...@@ -27,9 +27,9 @@ import simkit.util.SimplePropertyDumper;
* *
* @see SimkitOpenDis7Examples.ArrivalProcessOpenDis7 * @see SimkitOpenDis7Examples.ArrivalProcessOpenDis7
* @see SimkitOpenDis7Examples.SimpleServer * @see SimkitOpenDis7Examples.SimpleServer
* @see <a href="RunSimpleServerOpenDis7Log.txt">RunSimpleServerOpenDis7Log.txt</a> * @see <a href="RunSimpleServerOpenDis7Log.txt" target="_blank">RunSimpleServerOpenDis7Log.txt</a>
* @see <a href="../ArrivalProcessOpenDis7EventGraph.png">ArrivalProcessOpenDis7EventGraph.png</a> * @see <a href="../ArrivalProcessOpenDis7EventGraph.png" target="_blank">ArrivalProcessOpenDis7EventGraph.png</a>
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/raw/master/examples/src/SimkitOpenDis7Examples/documentation/ArrivalProcessDisPdu.png">ArrivalProcessDisPdu.png</a> * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/raw/master/examples/src/SimkitOpenDis7Examples/documentation/ArrivalProcessDisPdu.png" target="_blank">ArrivalProcessDisPdu.png</a>
* @author abuss@nps.edu@nps.edu * @author abuss@nps.edu@nps.edu
* @author brutzman@nps.edu * @author brutzman@nps.edu
*/ */
......
...@@ -2,10 +2,10 @@ ...@@ -2,10 +2,10 @@
* Invocation run classes for Simkit event graphs with opendis7 Java outputs supporting the NPS MOVES MV3500 Networked Graphics course. * Invocation run classes for Simkit event graphs with opendis7 Java outputs supporting the NPS MOVES MV3500 Networked Graphics course.
* Note that the "run" subpackage is a common Simkit design pattern for separating simkit models from executable programs. * Note that the "run" subpackage is a common Simkit design pattern for separating simkit models from executable programs.
* *
* @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/tree/master/examples">NetworkedGraphicsMV3500 examples</a> * @see <a href="https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/-/tree/master/examples" target="_blank">NetworkedGraphicsMV3500 examples</a>
* @see java.lang.Package * @see java.lang.Package
* @see <a href="https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful">StackOverflow: why-is-package-info-java-useful</a> * @see <a href="https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful" target="_blank">StackOverflow: why-is-package-info-java-useful</a>
* @see <a href="https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java">StackOverflow: how-do-i-document-packages-in-java</a> * @see <a href="https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java" target="_blank">StackOverflow: how-do-i-document-packages-in-java</a>
*/ */
package SimkitOpenDis7Examples.run; package SimkitOpenDis7Examples.run;
...@@ -13,7 +13,7 @@ import java.net.*; ...@@ -13,7 +13,7 @@ import java.net.*;
* *
* @see <a href="https://docs.oracle.com/javase/tutorial/essential/io/datastreams.html" target="_blank">https://docs.oracle.com/javase/tutorial/essential/io/datastreams.html</a> * @see <a href="https://docs.oracle.com/javase/tutorial/essential/io/datastreams.html" target="_blank">https://docs.oracle.com/javase/tutorial/essential/io/datastreams.html</a>
* @see <a href="https://en.wikipedia.org/wiki/User_Datagram_Protocol" target="_blank">https://en.wikipedia.org/wiki/User_Datagram_Protocol</a> * @see <a href="https://en.wikipedia.org/wiki/User_Datagram_Protocol" target="_blank">https://en.wikipedia.org/wiki/User_Datagram_Protocol</a>
* @see <a href="https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html">System properties</a> * @see <a href="https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html" target="_blank">System properties</a>
* @author mcgredo * @author mcgredo
* @author brutzman@nps.edu * @author brutzman@nps.edu
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment