Browse code

adler32: add API documentation

Originally committed as revision 23907 to svn://svn.ffmpeg.org/ffmpeg/trunk

Måns Rullgård authored on 2010/07/01 05:09:40
Showing 1 changed files
... ...
@@ -24,6 +24,18 @@
24 24
 #include <stdint.h>
25 25
 #include "attributes.h"
26 26
 
27
+/**
28
+ * Calculate the Adler32 checksum of a buffer.
29
+ *
30
+ * Passing the return value to a subsequent av_adler32_update() call
31
+ * allows the checksum of multiple buffers to be calculated as though
32
+ * they were concatenated.
33
+ *
34
+ * @param adler initial checksum value
35
+ * @param buf   pointer to input buffer
36
+ * @param len   size of input buffer
37
+ * @return      updated checksum
38
+ */
27 39
 unsigned long av_adler32_update(unsigned long adler, const uint8_t *buf,
28 40
                                 unsigned int len) av_pure;
29 41