Changeset 76 in tmcsimulator-scriptbuilder for trunk/src/scriptbuilder/structures/MyScriptHandler.java

Timestamp:

08/25/2017 12:22:28 PM (9 years ago)

Author:

bmcguffin

Message:

Added javadoc for several files.

File:

• trunk/src/scriptbuilder/structures/MyScriptHandler.java (modified) (3 diffs)

trunk/src/scriptbuilder/structures/MyScriptHandler.java

@@ -241 +241 @@
     /**
      * Constructor. Initializes incident map.
-     */
-    public MyScriptHandler(SimulationScript s)
-    {
-        script = s;
+     *
+     * @param scr the script into which the XML file is being read
+     */
+    public MyScriptHandler(SimulationScript scr)
+    {
+        script = scr;
         incidentMap = new TreeMap<Integer, ScriptIncident>();
         eventMap = new TreeMap<ELEMENT, I_ScriptEvent>();
@@ -255 +257 @@
      * Get the list of incidents that have been parsed from the script file.
      *
-     * @returns Vector of Incident objects.
+     * @return Vector of Incident objects.
      */
     public Vector<ScriptIncident> getIncidents()
@@ -265 +267 @@
      * Get the list of units that have been parsed from the script file.
      *
-     * @returns Vector of Unit objects.
+     * @return Vector of Unit objects.
      */
     public ArrayList<Unit> getUnits()