# HG changeset patch
# User mru
# Date 1277928580 0
# Node ID 082e51609a900f8765266db43100f082804b559e
# Parent  f789d66969a4f34ff5d711c21c2c09ef4f02da94
adler32: add API documentation

diff -r f789d66969a4 -r 082e51609a90 adler32.h
--- a/adler32.h	Wed Jun 30 20:09:32 2010 +0000
+++ b/adler32.h	Wed Jun 30 20:09:40 2010 +0000
@@ -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;