diff options
| author | David Robillard <d@drobilla.net> | 2022-10-20 21:03:17 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2022-10-20 21:10:24 -0400 |
| commit | 668ffa3febb116d20add6e9460fb1fb521a22e35 (patch) | |
| tree | 888e51d4b7c853f4afe77743a2d846e6799cef5f /include/zix/btree.h | |
| parent | 1a98f16aabf9e2c28f97b8ec89ae35af5a333252 (diff) | |
| download | zix-668ffa3febb116d20add6e9460fb1fb521a22e35.tar.gz zix-668ffa3febb116d20add6e9460fb1fb521a22e35.tar.bz2 zix-668ffa3febb116d20add6e9460fb1fb521a22e35.zip | |
Fix doc comments
Diffstat (limited to 'include/zix/btree.h')
| -rw-r--r-- | include/zix/btree.h | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/include/zix/btree.h b/include/zix/btree.h index 24a0171..1b36908 100644 --- a/include/zix/btree.h +++ b/include/zix/btree.h @@ -1,4 +1,4 @@ -// Copyright 2011-2020 David Robillard <d@drobilla.net> +// Copyright 2011-2022 David Robillard <d@drobilla.net> // SPDX-License-Identifier: ISC #ifndef ZIX_BTREE_H @@ -17,9 +17,8 @@ extern "C" { #endif /** - @addtogroup zix - @{ - @name BTree + @defgroup zix_btree BTree + @ingroup zix @{ */ @@ -81,8 +80,12 @@ zix_btree_new(ZixAllocator* ZIX_NULLABLE allocator, /** Free `t` and all the nodes it contains. + @param t The tree to free. + @param destroy Function to call once for every value in the tree. This can be used to free values if they are dynamically allocated. + + @param destroy_user_data Opaque pointer to pass to `destroy`. */ ZIX_API void @@ -93,8 +96,12 @@ zix_btree_free(ZixBTree* ZIX_NULLABLE t, /** Clear everything from `t`, leaving it empty. + @param t The tree to clear. + @param destroy Function called exactly once for every value in the tree, just before that value is removed from the tree. + + @param destroy_user_data Opaque pointer to pass to `destroy`. */ ZIX_API void @@ -203,7 +210,6 @@ zix_btree_iter_next(ZixBTreeIter iter); /** @} - @} */ #ifdef __cplusplus |