aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-22 08:31:28 -0300
committerMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-22 08:31:28 -0300
commit536764e8f432f3ee39fe3def95a12175e309f940 (patch)
tree0194a5b18211e4e1eb9b24c774f2c647ca36f2ae
parent80a019dfa675f468114cb25b00505482328b5269 (diff)
libdvbv5: add documentation for the short event descriptor
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
-rw-r--r--doxygen_libdvbv5.cfg1
-rw-r--r--lib/include/libdvbv5/desc_event_short.h73
2 files changed, 70 insertions, 4 deletions
diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg
index e0a6ac36..40499885 100644
--- a/doxygen_libdvbv5.cfg
+++ b/doxygen_libdvbv5.cfg
@@ -772,6 +772,7 @@ INPUT = $(SRCDIR)/doc/libdvbv5-index.doc \
$(SRCDIR)/lib/include/libdvbv5/desc_ca_identifier.h \
$(SRCDIR)/lib/include/libdvbv5/desc_cable_delivery.h \
$(SRCDIR)/lib/include/libdvbv5/desc_event_extended.h \
+ $(SRCDIR)/lib/include/libdvbv5/desc_event_short.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/desc_event_short.h b/lib/include/libdvbv5/desc_event_short.h
index 08e5b4de..0275924e 100644
--- a/lib/include/libdvbv5/desc_event_short.h
+++ b/lib/include/libdvbv5/desc_event_short.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2011-2012 - Mauro Carvalho Chehab
+ * Copyright (c) 2011-2014 - Mauro Carvalho Chehab
* Copyright (c) 2012 - Andre Roth <neolynx@gmail.com>
*
* This program is free software; you can redistribute it and/or
@@ -19,11 +19,44 @@
*
*/
+/**
+ * @file desc_event_short.h
+ * @ingroup descriptors
+ * @brief Provides the descriptors for the short event descriptor
+ * @copyright GNU General Public License version 2 (GPLv2)
+ * @author Mauro Carvalho Chehab
+ * @author Andre Roth
+ *
+ * @par Relevant specs
+ * The descriptor described herein is defined at:
+ * - ETSI EN 300 468 V1.11.1
+ *
+ * @par Bug Report
+ * Please submit bug reports and patches to linux-media@vger.kernel.org
+ */
+
#ifndef _DESC_EVENT_SHORT_H
#define _DESC_EVENT_SHORT_H
#include <libdvbv5/descriptors.h>
+/**
+ * @struct dvb_desc_event_short
+ * @ingroup descriptors
+ * @brief Structure containing the short event descriptor
+ *
+ * @param type descriptor tag
+ * @param length descriptor length
+ * @param next pointer to struct dvb_desc
+ * @param language ISO 639 language code
+ * @param name event name string
+ * @param name_emph event name emphasis string
+ * @param text event text string
+ * @param text_emph event text emphasis string
+ *
+ * The emphasis text is the one that uses asterisks. For example, in the text:
+ * "the quick *fox* jumps over the lazy table" the emphasis would be "fox".
+ */
struct dvb_desc_event_short {
uint8_t type;
uint8_t length;
@@ -42,9 +75,41 @@ struct dvb_v5_fe_parms;
extern "C" {
#endif
-int dvb_desc_event_short_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf, struct dvb_desc *desc);
-void dvb_desc_event_short_print(struct dvb_v5_fe_parms *parms, const struct dvb_desc *desc);
-void dvb_desc_event_short_free (struct dvb_desc *desc);
+/**
+ * @brief Initializes and parses the short event descriptor
+ * @ingroup descriptors
+ *
+ * @param parms struct dvb_v5_fe_parms pointer to the opened device
+ * @param buf buffer containing the descriptor's raw data
+ * @param desc pointer to struct dvb_desc to be allocated and filled
+ *
+ * This function allocates a the descriptor and fills the fields inside
+ * the struct. It also makes sure that all fields will follow the CPU
+ * endianness. Due to that, the content of the buffer may change.
+ *
+ * @return On success, it returns the size of the allocated struct.
+ * A negative value indicates an error.
+ */
+int dvb_desc_event_short_init(struct dvb_v5_fe_parms *parms,
+ const uint8_t *buf, struct dvb_desc *desc);
+
+/**
+ * @brief Prints the content of the short event descriptor
+ * @ingroup descriptors
+ *
+ * @param parms struct dvb_v5_fe_parms pointer to the opened device
+ * @param desc pointer to struct dvb_desc
+ */
+void dvb_desc_event_short_print(struct dvb_v5_fe_parms *parms,
+ const struct dvb_desc *desc);
+
+/**
+ * @brief Frees all data allocated by the short event descriptor
+ * @ingroup descriptors
+ *
+ * @param desc pointer to struct dvb_desc to be freed
+ */
+void dvb_desc_event_short_free(struct dvb_desc *desc);
#ifdef __cplusplus
}

Privacy Policy