X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=libavutil%2Fsha.h;h=c7558a89646b1ba2fba6445eb3a4970c0852f128;hb=cb114ed464069ac83f05a4ebdfe992e8f1549815;hp=bf4377e51b5baed019ea3b6477cf1e8e0750e5e2;hpb=39d6d3618d48625decaff7d9bdbb45b44ef2a805;p=ffmpeg diff --git a/libavutil/sha.h b/libavutil/sha.h index bf4377e51b5..c7558a89646 100644 --- a/libavutil/sha.h +++ b/libavutil/sha.h @@ -18,6 +18,12 @@ * 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 #define AVUTIL_SHA_H @@ -28,7 +34,17 @@ /** * @defgroup lavu_sha SHA - * @ingroup lavu_crypto + * @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. + * * @{ */