summaryrefslogtreecommitdiffstats
path: root/include/zix/hash.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2021-07-01 00:05:22 -0400
committerDavid Robillard <d@drobilla.net>2021-07-17 19:58:17 -0400
commit4b266e2f39a8d3a49b58c861c7fd852911cf7fb0 (patch)
treedc12d618dc52b640b82e522917b238e38af033b3 /include/zix/hash.h
parent46f9327b06e866e3180c1924a0afa0afd8b0b5c5 (diff)
downloadzix-4b266e2f39a8d3a49b58c861c7fd852911cf7fb0.tar.gz
zix-4b266e2f39a8d3a49b58c861c7fd852911cf7fb0.tar.bz2
zix-4b266e2f39a8d3a49b58c861c7fd852911cf7fb0.zip
Use line comments where appropriate
Diffstat (limited to 'include/zix/hash.h')
-rw-r--r--include/zix/hash.h16
1 files changed, 4 insertions, 12 deletions
diff --git a/include/zix/hash.h b/include/zix/hash.h
index 3905038..6312d7b 100644
--- a/include/zix/hash.h
+++ b/include/zix/hash.h
@@ -35,14 +35,10 @@ extern "C" {
typedef struct ZixHashImpl ZixHash;
-/**
- Function for computing the hash of an element.
-*/
+/// Function for computing the hash of an element
typedef uint32_t (*ZixHashFunc)(const void* value);
-/**
- Function to visit a hash element.
-*/
+/// Function to visit a hash element
typedef void (*ZixHashVisitFunc)(void* value, void* user_data);
/**
@@ -62,16 +58,12 @@ ZIX_API
ZixHash*
zix_hash_new(ZixHashFunc hash_func, ZixEqualFunc equal_func, size_t value_size);
-/**
- Free `hash`.
-*/
+/// Free `hash`
ZIX_API
void
zix_hash_free(ZixHash* hash);
-/**
- Return the number of elements in `hash`.
-*/
+/// Return the number of elements in `hash`
ZIX_PURE_API
size_t
zix_hash_size(const ZixHash* hash);