Changeset 7ee8c5b in mainline for uspace/srv/kbd/include/gsp.h

Timestamp:

2009-03-12T19:37:20Z (15 years ago)

Author:

Jiri Svoboda <jirik.svoboda@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

c640876

Parents:

29295cd

Message:

Add more comments.

File:

• uspace/srv/kbd/include/gsp.h (modified) (3 diffs)

uspace/srv/kbd/include/gsp.h

@@ -41 +41 @@
 
 enum {
-        GSP_END         = -1,
-        GSP_DEFAULT     = -2
+        GSP_END         = -1,   /**< Terminates a sequence. */
+        GSP_DEFAULT     = -2    /**< Wildcard, catches unhandled cases. */
 };
 
+/** Scancode parser description */
 typedef struct {
-        /** Transition table, (state, input) -> (state, output). */
+        /** Transition table, (state, input) -> (state, output) */
         hash_table_t trans;
 
-        /** Current number of states. */
+        /** Number of states */
         int states;
 } gsp_t;
 
+/** Scancode parser transition. */
 typedef struct {
-        link_t link;
+        link_t link;            /**< Link to hash table in @c gsp_t */ 
 
-        int old_state;
-        int input;
+        /* Preconditions */
 
-        int new_state;
+        int old_state;          /**< State before transition */
+        int input;              /**< Input symbol (scancode) */
 
-        unsigned out_mods;
-        unsigned out_key;
+        /* Effects */
+
+        int new_state;          /**< State after transition */
+
+        /* Output emitted during transition */
+
+        unsigned out_mods;      /**< Modifier to emit */
+        unsigned out_key;       /**< Keycode to emit */
 } gsp_trans_t;
 
@@ -70 +78 @@
 extern int gsp_step(gsp_t *, int, int, unsigned *, unsigned *);
 
-
 #endif
 
@@ -76 +83 @@
  * @}
  */ 
-