string_list: document string_list_(insert,lookup)
Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Stefan Beller committed
Nov 24, 2014 at 13:22 UTC
fc66505c53f1a471e63b6122b2d629daca6e705b
1 file changed
+10
string-list.h
+10
@@ -55,9 +55,19 @@ void string_list_remove_empty_items(struct string_list *list, int free_util);
55
int string_list_has_string(const struct string_list *list, const char *string);
56
int string_list_find_insert_index(const struct string_list *list, const char *string,
57
int negative_existing_index);
58
+/*
59
+ * Inserts the given string into the sorted list.
60
+ * If the string already exists, the list is not altered.
61
+ * Returns the string_list_item, the string is part of.
62
+ */
63
struct string_list_item *string_list_insert(struct string_list *list, const char *string);
64
struct string_list_item *string_list_insert_at_index(struct string_list *list,
65
int insert_at, const char *string);
66
+
67
+/*
68
+ * Checks if the given string is part of a sorted list. If it is part of the list,
69
+ * return the coresponding string_list_item, NULL otherwise.
70
+ */
71
struct string_list_item *string_list_lookup(struct string_list *list, const char *string);
72
73
/*