map_add, set_add: fix misleading API doc

I really hate such "inaccuracies".

diff --git a/lib/generic/map.c b/lib/generic/map.c
index 350f3fc5fc7640acfbf8380f8c2c6a64cd10a7db..3e0652041cebdd6a092ab7a685dde9e8152e63c8 100644 (file)
--- a/lib/generic/map.c
+++ b/lib/generic/map.c
@@ -157,7 +157,6 @@ EXPORT void *map_get(map_t *map, const char *str)
        return v;
 }
 
-/*! Inserts str into map, returns 0 on success */
 EXPORT int map_set(map_t *map, const char *str, void *val)
 {
        const uint8_t *const ubytes = (void *)str;

diff --git a/lib/generic/map.h b/lib/generic/map.h
index 79eeb5c38d07fd770e0d22f5df0ddc5a139d3133..73ce4c096812b6ea7d1d15bbd386b131b32a6f04 100644 (file)
--- a/lib/generic/map.h
+++ b/lib/generic/map.h
@@ -79,7 +79,7 @@ int map_contains(map_t *map, const char *str);
 /** Returns value if map contains str.  Note: NULL may mean two different things. */
 void *map_get(map_t *map, const char *str);
 
-/** Inserts str into map, returns 0 on suceess */
+/** Inserts str into map.  Returns 0 if new, 1 if replaced, or ENOMEM. */
 int map_set(map_t *map, const char *str, void *val);
 
 /** Deletes str from the map, returns 0 on suceess */
@@ -96,7 +96,9 @@ void map_clear(map_t *map);
        map_walk_prefixed((map), "", (callback), (baton))
 
 /**
- * Calls callback for all strings in map with the given prefix
+ * Calls callback for all strings in map with the given prefix.
+ * Returns value immediately if a callback returns nonzero.
+ *
  * @param map
  * @param prefix   required string prefix (empty => all strings)
  * @param callback callback parameters are (key, value, baton)

diff --git a/lib/generic/set.h b/lib/generic/set.h
index dd6bbde8f3cf9e34cbaef7cd716898c7b4e99319..332c1aaa8dd9244d93b6ec98fb80a7b14337ff1d 100644 (file)
--- a/lib/generic/set.h
+++ b/lib/generic/set.h
@@ -77,7 +77,7 @@ typedef int (set_walk_cb)(const char *, void *);
 #define set_contains(set, str) \
        map_contains((set), (str))
 
-/*! Inserts str into set, returns 0 on suceess */
+/*! Inserts str into set.  Returns 0 if new, 1 if already present, or ENOMEM. */
 #define set_add(set, str) \
        map_set((set), (str), (void *)1)