Changeset 780 for trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/IEventTarget.java

Timestamp:

09/06/12 13:14:24 (12 years ago)

Author:

sherbold

Message:

• code documentation

File:

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

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

@@ +1 @@
+
 package de.ugoe.cs.quest.eventcore;
 
@@ -4 +5 @@
 
 /**
- * 
  * <p>
- * TODO comment
+ * Common interface for event targets. An event target can, e.g., be an element of a GUI or Web
+ * server. A concrete event-driven software platform can define its event targets through the
+ * implementation of this interface.
  * </p>
  * 
- * @version $Revision: $ $Date: Aug 16, 2012$
- * @author 2012, last modified by $Author: sherbold$
+ * @version 1.0
+ * @author Steffen Herbold
  */
 public interface IEventTarget extends Serializable {
 
+    /**
+     * <p>
+     * Returns the name of event-driven software platform to which the target belongs.
+     * </p>
+     * 
+     * @return name of the platform
+     */
     public String getPlatform();
-    
+
+    /**
+     * <p>
+     * Returns a string identifier of the target. This is very convenient for visualizations of
+     * events.
+     * </p>
+     * 
+     * @return target identifier
+     */
     public String getStringIdentifier();
 }