Changeset 784 for trunk

Timestamp:

09/06/12 13:39:27 (12 years ago)

Author:

sherbold

Message:

• code documentation

Location:

trunk

Files:

• java-utils-test/src/test/java/de/ugoe/cs/util/console/defaultcommands/CMDlistCommandsTest.java (modified) (4 diffs)
• quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/Event.java (modified) (1 diff)
• quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/guimodel/GUIElementFactory.java (modified) (1 diff)
• quest-ui-core/src/main/java/de/ugoe/cs/quest/commands/sequences/CMDdetectTextInputEvents.java (modified) (7 diffs)

trunk/java-utils-test/src/test/java/de/ugoe/cs/util/console/defaultcommands/CMDlistCommandsTest.java

@@ -1 @@
-// Module    : $RCSfile: CMDlistCommandsTest.java,v $
-// Version   : $Revision: 0.0 $  $Author: pharms $  $Date: 28.08.2012 $
-// Project   : quest-ui-core-test
-// Creation  : 2012 by pharms
-// Copyright : Patrick Harms, 2012
+
 package de.ugoe.cs.util.console.defaultcommands;
 
@@ -19 +15 @@
 import de.ugoe.cs.util.console.listener.IOutputListener;
 
-/**
- * <p>
- * TODO comment
- * </p>
- * 
- * @version $Revision: $ $Date: 28.08.2012$
- * @author 2012, last modified by $Author: pharms$
- */
 public class CMDlistCommandsTest implements IOutputListener {
 
-    /** */
     private List<String> commands = new ArrayList<String>();
 
-    /**
-     * 
-     */
     @Before
     public void setUp() throws Exception {
         Console.getInstance().registerOutputListener(this);
     }
-        
-    /**
-     * <p>
-     * TODO: comment
-     * </p>
-     *
-     */
+
     @Test
     public void test() {
@@ -51 +29 @@
         CMDlistCommands command = new CMDlistCommands();
         command.run(null);
-        
+
         assertTrue(commands.size() > 0);
-        
+
         for (String cmd : commands) {
             assertNotNull(cmd);
@@ -61 +39 @@
     }
 
-    /* (non-Javadoc)
-     * @see de.ugoe.cs.util.console.listener.IOutputListener#outputMsg(java.lang.String)
-     */
     @Override
     public void outputMsg(String newMessage) {

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

@@ -19 +19 @@
 
     /**
+     * <p>
      * Id for object serialization.
+     * </p>
      */
     private static final long serialVersionUID = 1L;

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

@@ -15 +15 @@
 /**
  * TODO comment
- * 
- * TODO rename class to GUIElementFactory
  * 
  * @version $Revision: $ $Date: 13.05.2012$

trunk/quest-ui-core/src/main/java/de/ugoe/cs/quest/commands/sequences/CMDdetectTextInputEvents.java

@@ -9 +9 @@
 import de.ugoe.cs.quest.SequenceInstanceOf;
 import de.ugoe.cs.quest.eventcore.Event;
+import de.ugoe.cs.quest.eventcore.gui.KeyPressed;
+import de.ugoe.cs.quest.eventcore.gui.KeyReleased;
+import de.ugoe.cs.quest.eventcore.gui.KeyTyped;
+import de.ugoe.cs.quest.eventcore.gui.TextInput;
 import de.ugoe.cs.quest.eventcore.gui.TextInput.TextEquality;
 import de.ugoe.cs.quest.eventcore.gui.TextInputDetector;
@@ -17 +21 @@
 /**
  * <p>
- * TODO comment
+ * Command that converts {@link KeyPressed}, {@link KeyReleased}, and {@link KeyTyped} sequences
+ * into {@link TextInput} events if possible.
  * </p>
  * 
@@ -54 +59 @@
                 newSequencesName = sequencesName;
             }
-            if( parameters.size() > 2) {
+            if (parameters.size() > 2) {
                 textEqualityTypeString = (String) parameters.get(2);
             }
@@ -72 +77 @@
             return;
         }
-        
+
         TextEquality textEqualityType = null;
         try {
@@ -78 +83 @@
         }
         catch (IllegalArgumentException e) {
-            Console.printerrln("Invalid mode. Only LEXICAL, SYNTACTICAL, and SEMANTICAL are allowed values!");
+            Console
+                .printerrln("Invalid mode. Only LEXICAL, SYNTACTICAL, and SEMANTICAL are allowed values!");
             return;
         }
@@ -85 +91 @@
 
         Collection<List<Event>> newSequences = new LinkedList<List<Event>>();
-       
+
         for (List<Event> sequence : sequences) {
             newSequences.add(new TextInputDetector(textEqualityType).detectTextInputs(sequence));
@@ -93 +99 @@
             CommandHelpers.dataOverwritten(newSequencesName);
         }
-        
+
     }