aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-22 10:34:43 -0300
committerMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-22 10:34:43 -0300
commit52a58427a64f53d82831c07bb773e59945bda6e4 (patch)
treec8adbb327ae9c1b846a85268fb6bae9e83eb684d
parent00d01e92be11bdb09db96a70d803b6e98033d356 (diff)
libdvbv5: Document the hierarchy descriptor
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
-rw-r--r--doxygen_libdvbv5.cfg1
-rw-r--r--lib/include/libdvbv5/desc_hierarchy.h61
2 files changed, 60 insertions, 2 deletions
diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg
index fc8c439a..fd3ebfb1 100644
--- a/doxygen_libdvbv5.cfg
+++ b/doxygen_libdvbv5.cfg
@@ -775,6 +775,7 @@ INPUT = $(SRCDIR)/doc/libdvbv5-index.doc \
$(SRCDIR)/lib/include/libdvbv5/desc_event_short.h \
$(SRCDIR)/lib/include/libdvbv5/desc_extension.h \
$(SRCDIR)/lib/include/libdvbv5/desc_frequency_list.h \
+ $(SRCDIR)/lib/include/libdvbv5/desc_hierarchy.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_hierarchy.h b/lib/include/libdvbv5/desc_hierarchy.h
index ab71b425..1dfd84e2 100644
--- a/lib/include/libdvbv5/desc_hierarchy.h
+++ b/lib/include/libdvbv5/desc_hierarchy.h
@@ -19,11 +19,42 @@
*
*/
+/**
+ * @file desc_hierarchy.h
+ * @ingroup descriptors
+ * @brief Provides the descriptors for the hierarchy 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:
+ * - ISO/IEC 13818-1
+ *
+ * @see
+ *
+ * @par Bug Report
+ * Please submit bug reports and patches to linux-media@vger.kernel.org
+ */
+
#ifndef _HIERARCHY_H
#define _HIERARCHY_H
#include <libdvbv5/descriptors.h>
+/**
+ * @struct dvb_desc_hierarchy
+ * @ingroup descriptors
+ * @brief Structure containing the hierarchy descriptor
+ *
+ * @param type descriptor tag
+ * @param length descriptor length
+ * @param next pointer to struct dvb_desc
+ * @param hierarchy_type hierarchy type
+ * @param layer hierarchy layer index
+ * @param embedded_layer hierarchy embedded layer index
+ * @param channel hierarchy channel
+ */
struct dvb_desc_hierarchy {
uint8_t type;
uint8_t length;
@@ -48,8 +79,34 @@ struct dvb_v5_fe_parms;
extern "C" {
#endif
-int dvb_desc_hierarchy_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf, struct dvb_desc *desc);
-void dvb_desc_hierarchy_print(struct dvb_v5_fe_parms *parms, const struct dvb_desc *desc);
+/**
+ * @brief Initializes and parses the hierarchy 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 initializes and makes sure that all fields will follow the CPU
+ * endianness. Due to that, the content of the buffer may change.
+ *
+ * Currently, no memory is allocated internally.
+ *
+ * @return On success, it returns the size of the allocated struct.
+ * A negative value indicates an error.
+ */
+int dvb_desc_hierarchy_init (struct dvb_v5_fe_parms *parms,
+ const uint8_t *buf, struct dvb_desc *desc);
+
+/**
+ * @brief Prints the content of the hierarchy 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_hierarchy_print(struct dvb_v5_fe_parms *parms,
+ const struct dvb_desc *desc);
#ifdef __cplusplus
}

Privacy Policy