Changeset 831 for trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/guimodel/IGUIElementFactory.java

Timestamp:

09/20/12 09:40:26 (12 years ago)

Author:

sherbold

Message:

• code documentation and clean-up

File:

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

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

@@ -3 +3 @@
 /**
  * <p>
- * TODO comment
+ * Common interface for GUI element factories. 
  * </p>
  * 
- * @version $Revision: $ $Date: 17.08.2012$
- * @author 2012, last modified by $Author: pharms$
+ * @version 1.0
+ * @author Patrick Harms
  */
 public interface IGUIElementFactory {
@@ -13 +13 @@
     /**
      * <p>
-     * TODO: comment
+     * Instantiates a new {@link IGUIElement} from a given specification.
      * </p>
-     *
+     * 
      * @param specification
-     * @return
+     *            specification of the new GUI element
+     * @param parent
+     *            parent of the new GUI element
+     * @return created GUI element
+     * @throws GUIModelConfigurationException
+     *             thrown if there is a problem during the creation of the GUI element
      */
     public IGUIElement instantiateGUIElement(IGUIElementSpec specification, IGUIElement parent)