Commit 19d7098c authored by Timothy Gu's avatar Timothy Gu

avutil: Group hash functions separately in Doxygen

parent fbe22355
...@@ -18,6 +18,12 @@ ...@@ -18,6 +18,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * 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 #ifndef AVUTIL_ADLER32_H
#define AVUTIL_ADLER32_H #define AVUTIL_ADLER32_H
...@@ -25,11 +31,10 @@ ...@@ -25,11 +31,10 @@
#include "attributes.h" #include "attributes.h"
/** /**
* @file * @defgroup lavu_adler32 Adler-32
* Public header for libavutil Adler32 hasher * @ingroup lavu_hash
* Adler-32 hash function implementation.
* *
* @defgroup lavu_adler32 Adler32
* @ingroup lavu_crypto
* @{ * @{
*/ */
......
...@@ -18,6 +18,12 @@ ...@@ -18,6 +18,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * 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 #ifndef AVUTIL_CRC_H
#define AVUTIL_CRC_H #define AVUTIL_CRC_H
...@@ -27,8 +33,10 @@ ...@@ -27,8 +33,10 @@
#include "version.h" #include "version.h"
/** /**
* @defgroup lavu_crc32 CRC32 * @defgroup lavu_crc32 CRC
* @ingroup lavu_crypto * @ingroup lavu_hash
* CRC (Cyclic Redundancy Check) hash function implementation.
*
* @{ * @{
*/ */
......
...@@ -18,11 +18,28 @@ ...@@ -18,11 +18,28 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/ */
/**
* @file
* @ingroup lavu_hash_generic
* Generic hashing API
*/
#ifndef AVUTIL_HASH_H #ifndef AVUTIL_HASH_H
#define AVUTIL_HASH_H #define AVUTIL_HASH_H
#include <stdint.h> #include <stdint.h>
/**
* @defgroup lavu_hash Hash Functions
* @ingroup lavu_crypto
*
* @{
*
* @defgroup lavu_hash_generic Generic Hashing API
*
* @{
*/
struct AVHashContext; struct AVHashContext;
/** /**
...@@ -109,4 +126,9 @@ void av_hash_final_b64(struct AVHashContext *ctx, uint8_t *dst, int size); ...@@ -109,4 +126,9 @@ void av_hash_final_b64(struct AVHashContext *ctx, uint8_t *dst, int size);
*/ */
void av_hash_freep(struct AVHashContext **ctx); void av_hash_freep(struct AVHashContext **ctx);
/**
* @}
* @}
*/
#endif /* AVUTIL_HASH_H */ #endif /* AVUTIL_HASH_H */
...@@ -18,6 +18,12 @@ ...@@ -18,6 +18,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * 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 #ifndef AVUTIL_MD5_H
#define AVUTIL_MD5_H #define AVUTIL_MD5_H
...@@ -28,7 +34,9 @@ ...@@ -28,7 +34,9 @@
/** /**
* @defgroup lavu_md5 MD5 * @defgroup lavu_md5 MD5
* @ingroup lavu_crypto * @ingroup lavu_hash
* MD5 hash function implementation.
*
* @{ * @{
*/ */
......
...@@ -18,15 +18,33 @@ ...@@ -18,15 +18,33 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * 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 #ifndef AVUTIL_MURMUR3_H
#define AVUTIL_MURMUR3_H #define AVUTIL_MURMUR3_H
#include <stdint.h> #include <stdint.h>
/**
* @defgroup lavu_murmur3 Murmur3
* @ingroup lavu_hash
* MurmurHash3 hash function implementation.
*
* @{
*/
struct AVMurMur3 *av_murmur3_alloc(void); struct AVMurMur3 *av_murmur3_alloc(void);
void av_murmur3_init_seeded(struct AVMurMur3 *c, uint64_t seed); void av_murmur3_init_seeded(struct AVMurMur3 *c, uint64_t seed);
void av_murmur3_init(struct AVMurMur3 *c); void av_murmur3_init(struct AVMurMur3 *c);
void av_murmur3_update(struct AVMurMur3 *c, const uint8_t *src, int len); void av_murmur3_update(struct AVMurMur3 *c, const uint8_t *src, int len);
void av_murmur3_final(struct AVMurMur3 *c, uint8_t dst[16]); void av_murmur3_final(struct AVMurMur3 *c, uint8_t dst[16]);
/**
* @}
*/
#endif /* AVUTIL_MURMUR3_H */ #endif /* AVUTIL_MURMUR3_H */
...@@ -19,6 +19,12 @@ ...@@ -19,6 +19,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * 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 #ifndef AVUTIL_RIPEMD_H
#define AVUTIL_RIPEMD_H #define AVUTIL_RIPEMD_H
...@@ -29,7 +35,9 @@ ...@@ -29,7 +35,9 @@
/** /**
* @defgroup lavu_ripemd RIPEMD * @defgroup lavu_ripemd RIPEMD
* @ingroup lavu_crypto * @ingroup lavu_hash
* RIPEMD hash function implementation.
*
* @{ * @{
*/ */
......
...@@ -18,6 +18,12 @@ ...@@ -18,6 +18,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * 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 #ifndef AVUTIL_SHA_H
#define AVUTIL_SHA_H #define AVUTIL_SHA_H
...@@ -28,7 +34,9 @@ ...@@ -28,7 +34,9 @@
/** /**
* @defgroup lavu_sha SHA * @defgroup lavu_sha SHA
* @ingroup lavu_crypto * @ingroup lavu_hash
* SHA-1 and SHA-256 (Secure Hash Algorithm) hash function implementations.
*
* @{ * @{
*/ */
......
...@@ -19,6 +19,12 @@ ...@@ -19,6 +19,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * 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 #ifndef AVUTIL_SHA512_H
#define AVUTIL_SHA512_H #define AVUTIL_SHA512_H
...@@ -28,8 +34,10 @@ ...@@ -28,8 +34,10 @@
#include "version.h" #include "version.h"
/** /**
* @defgroup lavu_sha512 SHA512 * @defgroup lavu_sha512 SHA-512
* @ingroup lavu_crypto * @ingroup lavu_hash
* SHA-512 (Secure Hash Algorithm) hash function implementations.
*
* @{ * @{
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment