adler32: Fix doxy group definition
authorTimothy Gu <timothygu99@gmail.com>
Fri, 14 Jun 2013 08:42:55 +0000 (05:42 -0300)
committerVittorio Giovara <vittorio.giovara@gmail.com>
Sun, 6 Apr 2014 23:31:02 +0000 (01:31 +0200)
Based on a patch by James Almer <jamrial@gmail.com>.

Signed-off-by: Vittorio Giovara <vittorio.giovara@gmail.com>
libavutil/adler32.c
libavutil/adler32.h

index 7f5afdb..8a8065c 100644 (file)
  * 3. This notice may not be removed or altered from any source distribution.
  */
 
+/**
+ * @file
+ * Computes the Adler-32 checksum of a data stream
+ *
+ * This is a modified version based on adler32.c from the zlib library.
+ * @author Mark Adler
+ * @ingroup lavu_adler32
+ */
+
 #include "config.h"
 #include "adler32.h"
 
index a8ff6f9..53e3dbf 100644 (file)
 #include "attributes.h"
 
 /**
+ * @file
+ * Public header for libavutil Adler32 hasher
+ *
+ * @defgroup lavu_adler32 Adler32
  * @ingroup lavu_crypto
+ * @{
+ */
+
+/**
  * Calculate the Adler32 checksum of a buffer.
  *
  * Passing the return value to a subsequent av_adler32_update() call
@@ -40,4 +48,8 @@
 unsigned long av_adler32_update(unsigned long adler, const uint8_t *buf,
                                 unsigned int len) av_pure;
 
+/**
+ * @}
+ */
+
 #endif /* AVUTIL_ADLER32_H */