Browse Source

avutil: Add detailed Doxygen description to a few hashes

tags/n3.2
Timothy Gu 9 years ago
parent
commit
0a7a4e33f3
3 changed files with 21 additions and 0 deletions
  1. +4
    -0
      libavutil/crc.h
  2. +8
    -0
      libavutil/sha.h
  3. +9
    -0
      libavutil/sha512.h

+ 4
- 0
libavutil/crc.h View File

@@ -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.
*
* @{
*/



+ 8
- 0
libavutil/sha.h View File

@@ -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.
*
* @{
*/



+ 9
- 0
libavutil/sha512.h View File

@@ -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.
*
* @{
*/



Loading…
Cancel
Save