From 8430708fad6118ec3029e2614dd079556df6dba1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= Date: Sat, 30 Aug 2014 13:33:12 +0200 Subject: core: add comment about argument "index" of function arraylist_search --- src/core/wee-arraylist.c | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/core/wee-arraylist.c b/src/core/wee-arraylist.c index d2cba4b15..fbbbbef7d 100644 --- a/src/core/wee-arraylist.c +++ b/src/core/wee-arraylist.c @@ -416,6 +416,9 @@ arraylist_search (struct t_arraylist *arraylist, void *pointer, * If the index is negative and that the arraylist is not sorted, the element * is added at the end of arraylist. * + * If the arraylist is sorted, the argument "index" is ignored (the element + * will be inserted at appropriate position, to keep arraylist sorted). + * * Returns the index of the new element (>= 0) or -1 if error. */ -- cgit v1.2.3