aboutsummaryrefslogtreecommitdiffstats
path: root/libavutil/murmur3.h
diff options
context:
space:
mode:
authorTimothy Gu <timothygu99@gmail.com>2016-08-01 19:18:44 -0700
committerTimothy Gu <timothygu99@gmail.com>2016-08-02 07:48:08 -0700
commit19d7098c9e7b8568ce47f62a72af742eba478150 (patch)
tree1fff4b741f3ab70a65309a4f5c384e691e68c2b2 /libavutil/murmur3.h
parentfbe22355b7d44ab02fa2c7ed059c03e606970009 (diff)
downloadffmpeg-19d7098c9e7b8568ce47f62a72af742eba478150.tar.gz
avutil: Group hash functions separately in Doxygen
Diffstat (limited to 'libavutil/murmur3.h')
-rw-r--r--libavutil/murmur3.h18
1 files changed, 18 insertions, 0 deletions
diff --git a/libavutil/murmur3.h b/libavutil/murmur3.h
index f29ed973e9..e2d0039ba6 100644
--- a/libavutil/murmur3.h
+++ b/libavutil/murmur3.h
@@ -18,15 +18,33 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * @file
+ * @ingroup lavu_murmur3
+ * Public header for MurmurHash3 hash function implementation.
+ */
+
#ifndef AVUTIL_MURMUR3_H
#define AVUTIL_MURMUR3_H
#include <stdint.h>
+/**
+ * @defgroup lavu_murmur3 Murmur3
+ * @ingroup lavu_hash
+ * MurmurHash3 hash function implementation.
+ *
+ * @{
+ */
+
struct AVMurMur3 *av_murmur3_alloc(void);
void av_murmur3_init_seeded(struct AVMurMur3 *c, uint64_t seed);
void av_murmur3_init(struct AVMurMur3 *c);
void av_murmur3_update(struct AVMurMur3 *c, const uint8_t *src, int len);
void av_murmur3_final(struct AVMurMur3 *c, uint8_t dst[16]);
+/**
+ * @}
+ */
+
#endif /* AVUTIL_MURMUR3_H */