about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorJames Booth <boothj5@gmail.com>2013-12-10 00:06:00 +0000
committerJames Booth <boothj5@gmail.com>2013-12-10 00:06:00 +0000
commite27061b131d9ec9e37690e4759d7264d0393a547 (patch)
treecbddd998bcfd4cc6b1367ac02917b9ecca1d99eb
parent67dead32af7fe8a69543130e4bb1e405830a94c6 (diff)
downloadprofani-tty-e27061b131d9ec9e37690e4759d7264d0393a547.tar.gz
Added comments to autocomplete.h
-rw-r--r--src/tools/autocomplete.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/tools/autocomplete.h b/src/tools/autocomplete.h
index bf20020a..0a3b5b88 100644
--- a/src/tools/autocomplete.h
+++ b/src/tools/autocomplete.h
@@ -28,14 +28,19 @@
 typedef char*(*autocomplete_func)(char *);
 typedef struct autocomplete_t *Autocomplete;
 
+// allocate new autocompleter with no items
 Autocomplete autocomplete_new(void);
 
+// Remove all items from the autocompleter
 void autocomplete_clear(Autocomplete ac);
-void autocomplete_reset(Autocomplete ac);
+
+// free all memory used by the autocompleter
 void autocomplete_free(Autocomplete ac);
 
 void autocomplete_add(Autocomplete ac, const char *item);
 void autocomplete_remove(Autocomplete ac, const char * const item);
+
+// find the next item prefixed with search string
 gchar * autocomplete_complete(Autocomplete ac, gchar *search_str);
 
 GSList * autocomplete_get_list(Autocomplete ac);
@@ -50,4 +55,5 @@ char * autocomplete_param_with_ac(char *input, int *size, char *command,
 char * autocomplete_param_no_with_func(char *input, int *size, char *command,
     int arg_number, autocomplete_func func);
 
+void autocomplete_reset(Autocomplete ac);
 #endif