diff options
| author | Bruno Haible <bruno@clisp.org> | 2020-02-02 13:31:11 +0100 |
|---|---|---|
| committer | Bruno Haible <bruno@clisp.org> | 2020-02-02 13:31:11 +0100 |
| commit | bb931010f3fedc6ab155384bfbef77a282117f88 (patch) | |
| tree | 9224362c75a83e60e14ced3c95c7eae3eee2208c /lib/gl_omap.h | |
| parent | 6a5df5fb005c8a41a2020538532563ad54998128 (diff) | |
| download | gnulib-bb931010f3fedc6ab155384bfbef77a282117f88.tar.gz | |
list, set, oset, map, omap: Avoid imperative voice in documentation.
* lib/gl_map.h: Use descriptive sentences instead of imperative voice
in the specification of functions.
* lib/gl_omap.h: Likewise.
Diffstat (limited to 'lib/gl_omap.h')
| -rw-r--r-- | lib/gl_omap.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/gl_omap.h b/lib/gl_omap.h index afb4411495..c534db5826 100644 --- a/lib/gl_omap.h +++ b/lib/gl_omap.h @@ -161,7 +161,7 @@ extern int gl_omap_nx_put (gl_omap_t map, const void *key, const void *value) #endif ; -/* Adds a pair to an ordered map and retrieve the previous value. +/* Adds a pair to an ordered map and retrieves the previous value. Returns true if a pair with the given key was not already in the map and so this pair was added. Returns false and sets *OLDVALUEP to the previous value, if a pair with the @@ -182,7 +182,7 @@ extern int gl_omap_nx_getput (gl_omap_t map, const void *key, const void *value, Returns false otherwise. */ extern bool gl_omap_remove (gl_omap_t map, const void *key); -/* Removes a pair from an ordered map and retrieve the previous value. +/* Removes a pair from an ordered map and retrieves the previous value. Returns true and sets *OLDVALUEP to the previous value, if the key was found and its pair removed. Returns false otherwise. */ |