[libav-commits] adler32: Fix doxy group definition

Timothy Gu git at libav.org
Mon Apr 7 01:36:18 CEST 2014


Module: libav
Branch: master
Commit: f73495686d109ffffaa8c0387e790e7997326229

Author:    Timothy Gu <timothygu99 at gmail.com>
Committer: Vittorio Giovara <vittorio.giovara at gmail.com>
Date:      Fri Jun 14 05:42:55 2013 -0300

adler32: Fix doxy group definition

Based on a patch by James Almer <jamrial at gmail.com>.

Signed-off-by: Vittorio Giovara <vittorio.giovara at gmail.com>

---

 libavutil/adler32.c |    9 +++++++++
 libavutil/adler32.h |   12 ++++++++++++
 2 files changed, 21 insertions(+)

diff --git a/libavutil/adler32.c b/libavutil/adler32.c
index 7f5afdb..8a8065c 100644
--- a/libavutil/adler32.c
+++ b/libavutil/adler32.c
@@ -21,6 +21,15 @@
  * 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"
 
diff --git a/libavutil/adler32.h b/libavutil/adler32.h
index a8ff6f9..53e3dbf 100644
--- a/libavutil/adler32.h
+++ b/libavutil/adler32.h
@@ -25,7 +25,15 @@
 #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 */



More information about the libav-commits mailing list