Merge remote branch 'qatar/master'

[ffmpeg] / libavutil / adler32.h

diff --git a/libavutil/adler32.h b/libavutil/adler32.h
index 9626c8056778e25217cd73c1cc00b2abe022a6e6..0b890bcc1100d34d06b035aa1e4c58f1b002dfdb 100644 (file)
--- a/libavutil/adler32.h
+++ b/libavutil/adler32.h
@@ -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;