Changeset 76 in tmcsimulator-scriptbuilder for trunk/src/scriptbuilder/structures/ScriptEvent.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/ScriptEvent.java (modified) (3 diffs)

trunk/src/scriptbuilder/structures/ScriptEvent.java

@@ -18 +18 @@
      * Compare the Script Events based on their type enum.
      *
-     * @param o the other script event to be compared
+     * @param a the other script event to be compared
      * @return -1, 0, or 1 depending on if this event's type comes before,
      * simultaneously, or after the other event's type in the enum list
@@ -130 +130 @@
     }
 
+    /**
+     * Generate a new script event object of the specified type.
+     *
+     * @param t the type of the script event
+     * @return a new I_ScriptEvent object matching the given type
+     */
     public static I_ScriptEvent factoryByType(ScriptEventType t)
     {
@@ -172 +178 @@
         }
     }
-    
+
+    /**
+     * Determines if the event in question is an evaluation event.
+     *
+     * @param event the event to be checked
+     * @return true if the event implements I_EvaluationEvent
+     */
     public static boolean isEvaluationEvent(I_ScriptEvent event)
     {