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/digest.h | |
| parent | 1a98f16aabf9e2c28f97b8ec89ae35af5a333252 (diff) | |
| download | zix-668ffa3febb116d20add6e9460fb1fb521a22e35.tar.gz zix-668ffa3febb116d20add6e9460fb1fb521a22e35.tar.bz2 zix-668ffa3febb116d20add6e9460fb1fb521a22e35.zip | |
Fix doc comments
Diffstat (limited to 'include/zix/digest.h')
| -rw-r--r-- | include/zix/digest.h | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/include/zix/digest.h b/include/zix/digest.h index 2becad2..5a0eb16 100644 --- a/include/zix/digest.h +++ b/include/zix/digest.h @@ -1,4 +1,4 @@ -// Copyright 2012-2021 David Robillard <d@drobilla.net> +// Copyright 2012-2022 David Robillard <d@drobilla.net> // SPDX-License-Identifier: ISC #ifndef ZIX_DIGEST_H @@ -14,14 +14,15 @@ extern "C" { #endif /** - @addtogroup zix - @{ - @name Digest + @defgroup zix_digest Digest + @ingroup zix + Functions to generate a short "digest" of data with minimal collisions. These are good general-purpose hash functions for indexing arbitrary data, but are not necessarily stable across platforms and should never be used for cryptographic purposes. + @{ */ @@ -89,6 +90,10 @@ ZIX_PURE_API size_t zix_digest_aligned(size_t seed, const void* ZIX_NONNULL buf, size_t len); +/** + @} +*/ + #ifdef __cplusplus } /* extern "C" */ #endif |