From bb931010f3fedc6ab155384bfbef77a282117f88 Mon Sep 17 00:00:00 2001 From: Bruno Haible Date: Sun, 2 Feb 2020 13:31:11 +0100 Subject: [PATCH] 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. --- lib/gl_map.h | 2 +- lib/gl_omap.h | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/gl_map.h b/lib/gl_map.h index 8b45c839c0..8a203b6270 100644 --- a/lib/gl_map.h +++ b/lib/gl_map.h @@ -172,7 +172,7 @@ extern int gl_map_nx_getput (gl_map_t map, const void *key, const void *value, Returns false otherwise. */ extern bool gl_map_remove (gl_map_t map, const void *key); -/* Removes a pair from a map and retrieve the previous value. +/* Removes a pair from a 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. */ 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. */ -- 2.39.5