From 0a7a4e33f3030253aa86eaecd4b05c047e0918f9 Mon Sep 17 00:00:00 2001 From: Timothy Gu Date: Mon, 1 Aug 2016 19:53:50 -0700 Subject: avutil: Add detailed Doxygen description to a few hashes --- libavutil/sha.h | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'libavutil/sha.h') 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. + * * @{ */ -- cgit v1.2.3