From e27061b131d9ec9e37690e4759d7264d0393a547 Mon Sep 17 00:00:00 2001 From: James Booth Date: Tue, 10 Dec 2013 00:06:00 +0000 Subject: Added comments to autocomplete.h --- src/tools/autocomplete.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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 -- cgit 1.4.1-2-gfad0