diff options
| author | David Robillard <d@drobilla.net> | 2022-10-23 12:17:22 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2022-10-23 12:18:16 -0400 |
| commit | 6a182f6da1afda96de93467aa15827cefdad40af (patch) | |
| tree | 3d323b3984a19fbde9a04ab49268e41c6f6c0ca9 /include/zix/hash.h | |
| parent | 03554253ae5dbdd12d619db81864b38d5e300171 (diff) | |
| download | zix-6a182f6da1afda96de93467aa15827cefdad40af.tar.gz zix-6a182f6da1afda96de93467aa15827cefdad40af.tar.bz2 zix-6a182f6da1afda96de93467aa15827cefdad40af.zip | |
Add missing documentation
Diffstat (limited to 'include/zix/hash.h')
| -rw-r--r-- | include/zix/hash.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/zix/hash.h b/include/zix/hash.h index d362389..a5492a6 100644 --- a/include/zix/hash.h +++ b/include/zix/hash.h @@ -23,21 +23,21 @@ ZIX_BEGIN_DECLS #if defined(ZIX_HASH_KEY_TYPE) typedef ZIX_HASH_KEY_TYPE ZixHashKey; #else -typedef void ZixHashKey; +typedef void ZixHashKey; ///< The type of a key within a record #endif // ZIX_HASH_RECORD_TYPE can be defined to make the API more type-safe #if defined(ZIX_HASH_RECORD_TYPE) typedef ZIX_HASH_RECORD_TYPE ZixHashRecord; #else -typedef void ZixHashRecord; +typedef void ZixHashRecord; ///< The type of a hash table record #endif // ZIX_HASH_SEARCH_DATA_TYPE can be defined to make the API more type-safe #if defined(ZIX_HASH_SEARCH_DATA_TYPE) typedef ZIX_HASH_SEARCH_DATA_TYPE ZixHashSearchData; #else -typedef void ZixHashSearchData; +typedef void ZixHashSearchData; ///< User data for key comparison function #endif /** |