ffmpeg | branch: master | Timothy Gu <timothyg...@gmail.com> | Mon Aug 1 19:18:44 2016 -0700| [19d7098c9e7b8568ce47f62a72af742eba478150] | committer: Timothy Gu
avutil: Group hash functions separately in Doxygen > http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=19d7098c9e7b8568ce47f62a72af742eba478150 --- libavutil/adler32.h | 13 +++++++++---- libavutil/crc.h | 12 ++++++++++-- libavutil/hash.h | 22 ++++++++++++++++++++++ libavutil/md5.h | 10 +++++++++- libavutil/murmur3.h | 18 ++++++++++++++++++ libavutil/ripemd.h | 10 +++++++++- libavutil/sha.h | 10 +++++++++- libavutil/sha512.h | 12 ++++++++++-- 8 files changed, 96 insertions(+), 11 deletions(-) diff --git a/libavutil/adler32.h b/libavutil/adler32.h index 0dc69ec..a1f035b 100644 --- a/libavutil/adler32.h +++ b/libavutil/adler32.h @@ -18,6 +18,12 @@ * 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 @@ -25,11 +31,10 @@ #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 * @{ */ diff --git a/libavutil/crc.h b/libavutil/crc.h index ef8a713..f0556a9 100644 --- a/libavutil/crc.h +++ b/libavutil/crc.h @@ -18,6 +18,12 @@ * 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 @@ -27,8 +33,10 @@ #include "version.h" /** - * @defgroup lavu_crc32 CRC32 - * @ingroup lavu_crypto + * @defgroup lavu_crc32 CRC + * @ingroup lavu_hash + * CRC (Cyclic Redundancy Check) hash function implementation. + * * @{ */ diff --git a/libavutil/hash.h b/libavutil/hash.h index d4bcbf8..dae39cd 100644 --- a/libavutil/hash.h +++ b/libavutil/hash.h @@ -18,11 +18,28 @@ * 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 */ diff --git a/libavutil/md5.h b/libavutil/md5.h index 79702c8..9571c1f 100644 --- a/libavutil/md5.h +++ b/libavutil/md5.h @@ -18,6 +18,12 @@ * 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. + * * @{ */ diff --git a/libavutil/murmur3.h b/libavutil/murmur3.h index f29ed97..e2d0039 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 */ diff --git a/libavutil/ripemd.h b/libavutil/ripemd.h index 7b0c8bc..6d6bb32 100644 --- a/libavutil/ripemd.h +++ b/libavutil/ripemd.h @@ -19,6 +19,12 @@ * 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. + * * @{ */ diff --git a/libavutil/sha.h b/libavutil/sha.h index bf4377e..89052eb 100644 --- a/libavutil/sha.h +++ b/libavutil/sha.h @@ -18,6 +18,12 @@ * 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. + * * @{ */ diff --git a/libavutil/sha512.h b/libavutil/sha512.h index 7b08701..2391e37 100644 --- a/libavutil/sha512.h +++ b/libavutil/sha512.h @@ -19,6 +19,12 @@ * 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 @@ -28,8 +34,10 @@ #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. + * * @{ */ _______________________________________________ ffmpeg-cvslog mailing list ffmpeg-cvslog@ffmpeg.org http://ffmpeg.org/mailman/listinfo/ffmpeg-cvslog
