avutil: Add detailed Doxygen description to a few hashes
authorTimothy Gu <timothygu99@gmail.com>
Tue, 2 Aug 2016 02:53:50 +0000 (19:53 -0700)
committerTimothy Gu <timothygu99@gmail.com>
Tue, 2 Aug 2016 14:48:21 +0000 (07:48 -0700)
libavutil/crc.h
libavutil/sha.h
libavutil/sha512.h

index f0556a9..2a1b0d7 100644 (file)
  * @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.
+ *
  * @{
  */
 
index 89052eb..c7558a8 100644 (file)
  * @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.
+ *
  * @{
  */
 
index 2391e37..5bac184 100644 (file)
  * @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.
+ *
  * @{
  */