diff options
| author | Bruno Haible <bruno@clisp.org> | 2020-02-02 13:15:34 +0100 |
|---|---|---|
| committer | Bruno Haible <bruno@clisp.org> | 2020-02-02 13:15:34 +0100 |
| commit | 6a5df5fb005c8a41a2020538532563ad54998128 (patch) | |
| tree | abc7542e32cf249b3dcfe43b87ea8069fa7318b2 /lib/gl_anyavltree_list2.h | |
| parent | ffcdc458053b9a161294dd04a9a869bd43a636ba (diff) | |
| download | gnulib-6a5df5fb005c8a41a2020538532563ad54998128.tar.gz | |
list, set, oset, map, omap: Avoid imperative voice in documentation.
* lib/gl_list.h: Use descriptive sentences instead of imperative voice
in the specification of functions.
* lib/gl_set.h: Likewise.
* lib/gl_oset.h: Likewise.
* lib/gl_map.h: Likewise.
* lib/gl_omap.h: Likewise.
* lib/gl_*.h: Likewise.
Diffstat (limited to 'lib/gl_anyavltree_list2.h')
| -rw-r--r-- | lib/gl_anyavltree_list2.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/gl_anyavltree_list2.h b/lib/gl_anyavltree_list2.h index 4148296e9d..3cb1fcd20b 100644 --- a/lib/gl_anyavltree_list2.h +++ b/lib/gl_anyavltree_list2.h @@ -19,9 +19,9 @@ /* -------------------------- gl_list_t Data Type -------------------------- */ -/* Create a subtree for count >= 1 elements. +/* Creates a subtree for count >= 1 elements. Its height is h where 2^(h-1) <= count <= 2^h - 1. - Return NULL upon out-of-memory. */ + Returns NULL upon out-of-memory. */ static gl_list_node_t create_subtree_with_contents (size_t count, const void **contents) { @@ -138,7 +138,7 @@ gl_tree_nx_create (gl_list_implementation_t implementation, return NULL; } -/* Ensure the tree is balanced, after an insertion or deletion operation. +/* Ensures the tree is balanced, after an insertion or deletion operation. The height of NODE is incremented by HEIGHT_DIFF (1 or -1). PARENT = NODE->parent. (NODE can also be NULL. But PARENT is non-NULL.) Rotation operations are performed starting at PARENT (not NODE itself!). */ |