Changeset 786 for trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/IInteraction.java

Timestamp:

09/06/12 16:47:00 (12 years ago)

Author:

sherbold

Message:

• code documentation

File:

• trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/IInteraction.java (modified) (2 diffs)

trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/IInteraction.java

@@ +1 @@
+
 package de.ugoe.cs.quest.eventcore.gui;
 
@@ -5 +6 @@
 /**
  * <p>
- * An interaction is a special event type which represents the interaction of a user with an
- * element of a GUI. An example is a mouse click on a button.
+ * An interaction is a special event type which represents the interaction of a user with an element
+ * of a GUI. An example is a mouse click on a button.
  * </p>
  * 
- * @version $Revision: $ $Date: $
- * @author 2011, last modified by $Author: $
+ * @version 1.0
+ * @author Patrick Harms
  */
-public interface IInteraction extends IEventType
-{
+public interface IInteraction extends IEventType {
     /**
-     * @return
+     * <p>
+     * Determines whether an event type starts a logical sequence, i.e., a task.
+     * </p>
+     * 
+     * @return true if a logical sequence is started; false otherwise
      */
     public boolean startsLogicalSequence();
 
     /**
-     * @return
+     * <p>
+     * Determines whether an event type finishes a logical sequence, i.e., a task.
+     * </p>
+     * 
+     * @return true if a logical sequence is finished; false otherwise
      */
     public boolean finishesLogicalSequence();