1
0
mirror of https://github.com/profanity-im/profanity.git synced 2024-09-29 19:56:07 -04:00

Added comments to autocomplete.h

This commit is contained in:
James Booth 2013-12-10 00:06:00 +00:00
parent 67dead32af
commit e27061b131

View File

@ -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