avutil: Group hash functions separately in Doxygen
authorTimothy Gu <timothygu99@gmail.com>
Tue, 2 Aug 2016 02:18:44 +0000 (19:18 -0700)
committerTimothy Gu <timothygu99@gmail.com>
Tue, 2 Aug 2016 14:48:08 +0000 (07:48 -0700)
libavutil/adler32.h
libavutil/crc.h
libavutil/hash.h
libavutil/md5.h
libavutil/murmur3.h
libavutil/ripemd.h
libavutil/sha.h
libavutil/sha512.h

index 0dc69ec..a1f035b 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * @ingroup lavu_adler32
+ * Public header for Adler-32 hash function implementation.
+ */
+
 #ifndef AVUTIL_ADLER32_H
 #define AVUTIL_ADLER32_H
 
 #include "attributes.h"
 
 /**
- * @file
- * Public header for libavutil Adler32 hasher
+ * @defgroup lavu_adler32 Adler-32
+ * @ingroup lavu_hash
+ * Adler-32 hash function implementation.
  *
- * @defgroup lavu_adler32 Adler32
- * @ingroup lavu_crypto
  * @{
  */
 
index ef8a713..f0556a9 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * @ingroup lavu_crc32
+ * Public header for CRC hash function implementation.
+ */
+
 #ifndef AVUTIL_CRC_H
 #define AVUTIL_CRC_H
 
 #include "version.h"
 
 /**
- * @defgroup lavu_crc32 CRC32
- * @ingroup lavu_crypto
+ * @defgroup lavu_crc32 CRC
+ * @ingroup lavu_hash
+ * CRC (Cyclic Redundancy Check) hash function implementation.
+ *
  * @{
  */
 
index d4bcbf8..dae39cd 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * @ingroup lavu_hash_generic
+ * Generic hashing API
+ */
+
 #ifndef AVUTIL_HASH_H
 #define AVUTIL_HASH_H
 
 #include <stdint.h>
 
+/**
+ * @defgroup lavu_hash Hash Functions
+ * @ingroup lavu_crypto
+ *
+ * @{
+ *
+ * @defgroup lavu_hash_generic Generic Hashing API
+ *
+ * @{
+ */
+
 struct AVHashContext;
 
 /**
@@ -109,4 +126,9 @@ void av_hash_final_b64(struct AVHashContext *ctx, uint8_t *dst, int size);
  */
 void av_hash_freep(struct AVHashContext **ctx);
 
+/**
+ * @}
+ * @}
+ */
+
 #endif /* AVUTIL_HASH_H */
index 79702c8..9571c1f 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * @ingroup lavu_md5
+ * Public header for MD5 hash function implementation.
+ */
+
 #ifndef AVUTIL_MD5_H
 #define AVUTIL_MD5_H
 
@@ -28,7 +34,9 @@
 
 /**
  * @defgroup lavu_md5 MD5
- * @ingroup lavu_crypto
+ * @ingroup lavu_hash
+ * MD5 hash function implementation.
+ *
  * @{
  */
 
index f29ed97..e2d0039 100644 (file)
  * 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 */
index 7b0c8bc..6d6bb32 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * @ingroup lavu_ripemd
+ * Public header for RIPEMD hash function implementation.
+ */
+
 #ifndef AVUTIL_RIPEMD_H
 #define AVUTIL_RIPEMD_H
 
@@ -29,7 +35,9 @@
 
 /**
  * @defgroup lavu_ripemd RIPEMD
- * @ingroup lavu_crypto
+ * @ingroup lavu_hash
+ * RIPEMD hash function implementation.
+ *
  * @{
  */
 
index bf4377e..89052eb 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * @ingroup lavu_sha
+ * Public header for SHA-1 & SHA-256 hash function implementations.
+ */
+
 #ifndef AVUTIL_SHA_H
 #define AVUTIL_SHA_H
 
@@ -28,7 +34,9 @@
 
 /**
  * @defgroup lavu_sha SHA
- * @ingroup lavu_crypto
+ * @ingroup lavu_hash
+ * SHA-1 and SHA-256 (Secure Hash Algorithm) hash function implementations.
+ *
  * @{
  */
 
index 7b08701..2391e37 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * @ingroup lavu_sha512
+ * Public header for SHA-512 implementation.
+ */
+
 #ifndef AVUTIL_SHA512_H
 #define AVUTIL_SHA512_H
 
 #include "version.h"
 
 /**
- * @defgroup lavu_sha512 SHA512
- * @ingroup lavu_crypto
+ * @defgroup lavu_sha512 SHA-512
+ * @ingroup lavu_hash
+ * SHA-512 (Secure Hash Algorithm) hash function implementations.
+ *
  * @{
  */