Add lots of new code comments.

darcs-hash:20080113164747-75c98-9d0cefd27be7aef7ba60772616d9da7e6bb52912.gz

1 files changed, 13 insertions, 6 deletions

diff --git a/input.h b/input.h
index 2814d809..cd275674 100644
--- a/input.h
+++ b/input.h
@@ -89,19 +89,26 @@ void input_unreadch( wint_t ch );
 
 
 /**
-   Add a key mapping from the specified sequence
+   Add a key mapping from the specified sequence to the specified command
 
-   \param mode the name of the mapping mode to add this mapping to
-   \param s the sequence
-   \param d a description of the sequence
-   \param cmd an input function that will be run whenever the key sequence occurs
+   \param sequence the sequence to bind
+   \param command an input function that will be run whenever the key sequence occurs
 */
-void input_mapping_add( const wchar_t *sequence, const wchar_t *cmd );
+void input_mapping_add( const wchar_t *sequence, const wchar_t *command );
 
+/**
+   Insert all mapping names into the specified array_list_t
+ */
 void input_mapping_get_names( array_list_t *list );
 
+/**
+   Erase binding for specified key sequence
+ */
 int input_mapping_erase( const wchar_t *sequence );
 
+/**
+   Return the command bound to the specified key sequence
+ */
 const wchar_t *input_mapping_get( const wchar_t *sequence );
 
 /**