Changeset 838 for trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKeySynonyms.java

Timestamp:

09/20/12 14:13:07 (12 years ago)

Author:

sherbold

Message:

• code documentation and clean-up

File:

• trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKeySynonyms.java (modified) (5 diffs)

trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKeySynonyms.java

@@ +1 @@
+
 package de.ugoe.cs.tasktree.keyboardmaps;
 
@@ -10 +11 @@
 
 /**
- * TODO comment
+ * <p>
+ * Helper class to handle synonymous {@link VirtualKey}s.
+ * </p>
  * 
- * @version $Revision: $ $Date: 12.07.2012$
- * @author 2012, last modified by $Author: pharms$
+ * @version 1.0
+ * @author Patrick Harms
  */
 class VirtualKeySynonyms {
-    
-    /** */
+
+    /**
+     * <p>
+     * Map of synonymous keys.
+     * </p>
+     */
     private Map<Integer, List<VirtualKey>> synonyms = new HashMap<Integer, List<VirtualKey>>();
 
-    /** */
+    /**
+     * <p>
+     * Mapping of {@link VirtualKey}s to integer Ids.
+     * </p>
+     */
     private Map<VirtualKey, Integer> keyIds = new HashMap<VirtualKey, Integer>();
 
     /**
-     * TODO: comment
+     * <p>
+     * Adds a new synonymous key.
+     * </p>
      * 
      * @param keyId
+     *            id of the synonym
      * @param virtualKey
+     *            the synonym
      */
     public void add(int keyId, VirtualKey virtualKey) {
@@ -46 +61 @@
         if ((existingKeyId != null) && (existingKeyId != keyId)) {
             Console.traceln(Level.FINEST, "virtual key " + virtualKey + " is mapped to more " +
-                            "than one key id (current is " + existingKeyId + ", new is " + keyId +
-                            "). New key id will be used (" + keyId + ").");
+                "than one key id (current is " + existingKeyId + ", new is " + keyId +
+                "). New key id will be used (" + keyId + ").");
         }
 
@@ -54 +69 @@
 
     /**
-   *
-   */
+     * <p>
+     * Returns whether a key is contained in the set of synonyms.
+     * </p>
+     * 
+     * @param keyId
+     *            id of the key
+     * @return true, if the key is contained; false otherwise
+     */
     public boolean containsKey(int keyId) {
         return synonyms.containsKey(keyId);
@@ -61 +82 @@
 
     /**
-     * TODO: comment
+     * <p>
+     * Returns all synonyms known for a given key.
+     * </p>
      * 
      * @param keyId
-     * @return
+     *            the id of the key
+     * @return the synonyms
      */
     public VirtualKey[] getVirtualKeySynonyms(int keyId) {