Context Navigation

events

Timestamp:

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

Author:

bmcguffin

Message:

Added javadoc for several files.

Location:

trunk/src/scriptbuilder/structures/events

Files:

r46	r76
20	20	{
21	21
	22	/**
	23	* Constructor.
	24	*/
22	25	public ATMSEvaluationEvent()
23	26	{
…	…
25	28	}
26	29
	30	/**
	31	* A list of the expected actions held by this evaluation event.
	32	*/
27	33	public ArrayList<String> expectedAction = new ArrayList<String>();
28	34

r46	r76
20	20	{
21	21
	22	/**
	23	* Constructor.
	24	*/
22	25	public ActivityLogEvaluationEvent()
23	26	{
…	…
25	28	}
26	29
	30	/**
	31	* A list of the expected actions held by this evaluation event.
	32	*/
27	33	public ArrayList<String> expectedAction = new ArrayList<String>();
28	34

-                      r46
+                      r76
+{
+    /**
+     * Constructor.
+     */
     public AudioEvent()
+    {
 …
+    }
+    /**
+     * Length of the audio to be played, in seconds.
+     */
     public Integer audioLength = 0;
+    /**
+     * File path for the audio file.
+     */
     public String audioPath = "";

r46	r76
20	20	{
21	21
	22	/**
	23	* Constructor.
	24	*/
22	25	public CADEvaluationEvent()
23	26	{
…	…
25	28	}
26	29
	30	/**
	31	* A list of the expected actions held by this evaluation event.
	32	*/
27	33	public ArrayList<String> expectedAction = new ArrayList<String>();
28	34

-                      r47
+                      r76
+{
+    /**
+     * Constructor.
+     */
     public CADEvent()
+    {
 …
+    }
+    /**
+     * True if this CAD event has sub-events.
+     */
     public boolean hasSubEvents = false;
+    /**
+     * Description of this event.
+     */
     public String detail = "";

-                      r46
+                      r76
 /**
  * Data model for a CCTV event. (Just a stub; CCTV events aren't currently
  * used.) A CCTV event has, for now, a string message.
+ * Data model for a CCTV event(Just a stub; CCTV events aren't currently
+ * used). A CCTV event has, for now, a string message.
+ *
  * @author Bryan McGuffin
 …
+{
+    /**
+     * Constructor.
+     */
     public CCTVEvent()
+    {
 …
+    }
+    /**
+     * The message represented by this event.
+     */
     public String message = "";

-                      r46
+                      r76
+{
+    /**
+     * Constructor.
+     */
     public CHPRadioEvent()
+    {
 …
+    }
+    /**
+     * List of the lines of dialog in this event.
+     */
     public ArrayList<String> lines = new ArrayList<String>();
+    /**
+     * List of the corresponding roles for each line of dialog.
+     */
     public ArrayList<String> roles = new ArrayList<String>();
+    /**
+     * Path for the audio file to be played during this event.
+     */
     public String radioFile = "";

r46	r76
20	20	{
21	21
	22	/**
	23	* Constructor.
	24	*/
22	25	public FacilitatorEvaluationEvent()
23	26	{
…	…
25	28	}
26	29
	30	/**
	31	* A list of the expected actions held by this evaluation event.
	32	*/
27	33	public ArrayList<String> expectedAction = new ArrayList<String>();
28	34

r46	r76
20	20	{
21	21
	22	/**
	23	* Constructor.
	24	*/
22	25	public MaintenanceRadioEvent()
23	26	{

r46	r76
20	20	{
21	21
	22	/**
	23	* Constructor.
	24	*/
22	25	public RadioEvaluationEvent()
23	26	{
…	…
25	28	}
26	29
	30	/**
	31	* A list of the expected actions held by this evaluation event.
	32	*/
27	33	public ArrayList<String> expectedAction = new ArrayList<String>();
28	34

Note: See TracChangeset for help on using the changeset viewer.