From 82012619962ed0fd97e8ec36b732265103a0a2a3 Mon Sep 17 00:00:00 2001 From: Måns Rullgård Date: Wed, 30 Jun 2010 20:09:40 +0000 Subject: adler32: add API documentation Originally committed as revision 23907 to svn://svn.ffmpeg.org/ffmpeg/trunk --- libavutil/adler32.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'libavutil/adler32.h') diff --git a/libavutil/adler32.h b/libavutil/adler32.h index 9626c80567..0b890bcc11 100644 --- a/libavutil/adler32.h +++ b/libavutil/adler32.h @@ -24,6 +24,18 @@ #include #include "attributes.h" +/** + * Calculate the Adler32 checksum of a buffer. + * + * Passing the return value to a subsequent av_adler32_update() call + * allows the checksum of multiple buffers to be calculated as though + * they were concatenated. + * + * @param adler initial checksum value + * @param buf pointer to input buffer + * @param len size of input buffer + * @return updated checksum + */ unsigned long av_adler32_update(unsigned long adler, const uint8_t *buf, unsigned int len) av_pure; -- cgit v1.2.3