adler32: add API documentation
authorMåns Rullgård <mans@mansr.com>
Wed, 30 Jun 2010 20:09:40 +0000 (20:09 +0000)
committerMåns Rullgård <mans@mansr.com>
Wed, 30 Jun 2010 20:09:40 +0000 (20:09 +0000)
Originally committed as revision 23907 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavutil/adler32.h

index 9626c80..0b890bc 100644 (file)
 #include <stdint.h>
 #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;