aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-11 13:56:13 -0300
committerMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-11 13:56:13 -0300
commite11be77b026e37899ce4e46a8d1024e4dce17868 (patch)
treea8e20713c36ba73c6424d45f2a767dbfe5e5d3ef
parentf1d55b1bb91c9d07aa5dbf0776228b745d5b0f26 (diff)
libdvbv5: add documentation for crc32.h
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
-rw-r--r--doxygen_libdvbv5.cfg1
-rw-r--r--lib/include/libdvbv5/crc32.h18
2 files changed, 19 insertions, 0 deletions
diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg
index 28edccb5..a9a3ff6e 100644
--- a/doxygen_libdvbv5.cfg
+++ b/doxygen_libdvbv5.cfg
@@ -757,6 +757,7 @@ INPUT = $(SRCDIR)/lib/include/libdvbv5/dvb-demux.h \
$(SRCDIR)/lib/include/libdvbv5/pmt.h \
$(SRCDIR)/lib/include/libdvbv5/sdt.h \
$(SRCDIR)/lib/include/libdvbv5/vct.h \
+ $(SRCDIR)/lib/include/libdvbv5/crc32.h \
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
diff --git a/lib/include/libdvbv5/crc32.h b/lib/include/libdvbv5/crc32.h
index 9582d4ce..350df52d 100644
--- a/lib/include/libdvbv5/crc32.h
+++ b/lib/include/libdvbv5/crc32.h
@@ -19,6 +19,23 @@
*
*/
+/**
+ * @file crc32.h
+ * @brief Provides ancillary code to calculate DVB crc32 checksum
+ * @copyright GNU General Public License version 2 (GPLv2)
+ * @author Mauro Carvalho Chehab
+ * @author Andre Roth
+ *
+ * @par Bug Report
+ * Please submit bug report and patches to linux-media@vger.kernel.org
+ *
+ * @par Descriptors
+ * The descriptors herein are defined on:
+ * - ISO/IEC 13818-1
+ *
+ * @see http://www.etherguidesystems.com/help/sdos/mpeg/syntax/tablesections/pat.aspx
+ */
+
#ifndef _CRC32_H
#define _CRC32_H
@@ -29,6 +46,7 @@
extern "C" {
#endif
+/** @brief Calculates the crc-32 as defined at the MPEG-TS specs */
uint32_t dvb_crc32(uint8_t *data, size_t datalen, uint32_t crc);
#ifdef __cplusplus

Privacy Policy