Add lots of new code comments.

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

1 files changed, 39 insertions, 2 deletions

diff --git a/builtin.c b/builtin.c
index 9bf3bd6b..37b4fadc 100644
--- a/builtin.c
+++ b/builtin.c
@@ -407,6 +407,9 @@ static void builtin_missing_argument( const wchar_t *cmd, const wchar_t *opt )
 #include "builtin_ulimit.c"
 #include "builtin_jobs.c"
 
+/**
+   List all current key bindings
+ */
 static void builtin_bind_list()
 {
 	array_list_t lst;
@@ -442,6 +445,13 @@ static void builtin_bind_list()
 	al_destroy( &lst );
 }
 
+/**
+   Print terminfo key binding names to string buffer used for standard output.
+
+   \param all if set, all terminfo key binding names will be
+   printed. If not set, only ones that are defined for this terminal
+   are printed.
+ */
 static void builtin_bind_key_names( int all )
 {
 	array_list_t lst;
@@ -460,6 +470,10 @@ static void builtin_bind_key_names( int all )
 	al_destroy( &lst );
 }
 
+/**
+   Print all the special key binding functions to string buffer used for standard output.
+
+ */
 static void builtin_bind_function_names()
 {
 	array_list_t lst;
@@ -478,6 +492,9 @@ static void builtin_bind_function_names()
 	al_destroy( &lst );
 }
 
+/**
+   Add specified key binding.
+ */
 static int builtin_bind_add( wchar_t *seq, wchar_t *cmd, int terminfo )
 {
 
@@ -526,6 +543,12 @@ static int builtin_bind_add( wchar_t *seq, wchar_t *cmd, int terminfo )
 	
 }
 
+/**
+   Erase specified key bindings
+
+   \param seq an array of all key bindings to erase
+   \param all if specified, _all_ key bindings will be erased
+ */
 static void builtin_bind_erase( wchar_t **seq, int all )
 {
 	if( all )
@@ -983,7 +1006,9 @@ static int builtin_builtin(  wchar_t **argv )
 	return STATUS_BUILTIN_OK;
 }
 
-
+/**
+   Implementation of the builtin emit command, used to create events.
+ */
 static int builtin_emit( wchar_t **argv )
 {
 	int argc=builtin_count_args( argv );
@@ -2660,7 +2685,10 @@ static int builtin_cd( wchar_t **argv )
 	return res;
 }
 
-
+/**
+   Implementation of the builtin count command, used to count the
+   number of arguments sent to it.
+ */
 static int builtin_count( wchar_t ** argv )
 {
 	int argc;
@@ -2669,6 +2697,10 @@ static int builtin_count( wchar_t ** argv )
 	return !(argc-1);
 }
 
+/**
+   Implementation of the builtin contains command, used to check if a
+   specified string is part of a list.
+ */
 static int builtin_contains( wchar_t ** argv )
 {
 	int argc;
@@ -3408,6 +3440,11 @@ static int builtin_break_continue( wchar_t **argv )
 	return STATUS_BUILTIN_OK;
 }
 
+/**
+   Implementation of the builtin count command, used to launch the
+   interactive debugger.
+ */
+
 static int builtin_breakpoint( wchar_t **argv )
 {
 	parser_push_block( BREAKPOINT );