[FFmpeg-cvslog] r23907 - trunk/libavutil/adler32.h

[mru]

Author: mru
Date: Wed Jun 30 22:09:40 2010
New Revision: 23907

Log:
adler32: add API documentation

Modified:
   trunk/libavutil/adler32.h

Modified: trunk/libavutil/adler32.h
==============================================================================
--- trunk/libavutil/adler32.h	Wed Jun 30 22:09:37 2010	(r23906)
+++ trunk/libavutil/adler32.h	Wed Jun 30 22:09:40 2010	(r23907)
@@ -24,6 +24,18 @@
 #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;