diff options
| author | Timothy Gu <timothygu99@gmail.com> | 2016-08-01 19:53:50 -0700 |
|---|---|---|
| committer | Timothy Gu <timothygu99@gmail.com> | 2016-08-02 07:48:21 -0700 |
| commit | 0a7a4e33f3030253aa86eaecd4b05c047e0918f9 (patch) | |
| tree | a90f7c99e1ccc42c22185828afd79d20a71fa241 | |
| parent | 19d7098c9e7b8568ce47f62a72af742eba478150 (diff) | |
| download | ffmpeg-0a7a4e33f3030253aa86eaecd4b05c047e0918f9.tar.gz | |
avutil: Add detailed Doxygen description to a few hashes
| -rw-r--r-- | libavutil/crc.h | 4 | ||||
| -rw-r--r-- | libavutil/sha.h | 8 | ||||
| -rw-r--r-- | libavutil/sha512.h | 9 |
3 files changed, 21 insertions, 0 deletions
diff --git a/libavutil/crc.h b/libavutil/crc.h index f0556a9d3b..2a1b0d7624 100644 --- a/libavutil/crc.h +++ b/libavutil/crc.h @@ -37,6 +37,10 @@ * @ingroup lavu_hash * CRC (Cyclic Redundancy Check) hash function implementation. * + * This module supports numerous CRC polynomials, in addition to the most + * widely used CRC-32-IEEE. See @ref AVCRCId for a list of available + * polynomials. + * * @{ */ diff --git a/libavutil/sha.h b/libavutil/sha.h index 89052eb8bc..c7558a8964 100644 --- a/libavutil/sha.h +++ b/libavutil/sha.h @@ -37,6 +37,14 @@ * @ingroup lavu_hash * SHA-1 and SHA-256 (Secure Hash Algorithm) hash function implementations. * + * This module supports the following SHA hash functions: + * + * - SHA-1: 160 bits + * - SHA-224: 224 bits, as a variant of SHA-2 + * - SHA-256: 256 bits, as a variant of SHA-2 + * + * @see For SHA-384, SHA-512, and variants thereof, see @ref lavu_sha512. + * * @{ */ diff --git a/libavutil/sha512.h b/libavutil/sha512.h index 2391e37f6c..5bac184cf3 100644 --- a/libavutil/sha512.h +++ b/libavutil/sha512.h @@ -38,6 +38,15 @@ * @ingroup lavu_hash * SHA-512 (Secure Hash Algorithm) hash function implementations. * + * This module supports the following SHA-2 hash functions: + * + * - SHA-512/224: 224 bits + * - SHA-512/256: 256 bits + * - SHA-384: 384 bits + * - SHA-512: 512 bits + * + * @see For SHA-1, SHA-256, and variants thereof, see @ref lavu_sha. + * * @{ */ |