aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-22 11:23:44 -0300
committerMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-22 11:28:38 -0300
commitfe3995a1cc9da7cdf71bba8f40d70338f98139fd (patch)
tree10867296c7883b012b7bf429ca7c3c993d9f2170
parente602c144fc7236ecde29110e3ba42cf56382a46d (diff)
libdvbv5: add documentation for the network name 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_extended.h1
-rw-r--r--lib/include/libdvbv5/desc_event_short.h1
-rw-r--r--lib/include/libdvbv5/desc_network_name.h71
-rw-r--r--lib/include/libdvbv5/descriptors.h1
5 files changed, 70 insertions, 5 deletions
diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg
index 7ffd00fd..8cc09e8a 100644
--- a/doxygen_libdvbv5.cfg
+++ b/doxygen_libdvbv5.cfg
@@ -779,6 +779,7 @@ INPUT = $(SRCDIR)/doc/libdvbv5-index.doc \
$(SRCDIR)/lib/include/libdvbv5/desc_isdbt_delivery.h \
$(SRCDIR)/lib/include/libdvbv5/desc_language.h \
$(SRCDIR)/lib/include/libdvbv5/desc_logical_channel.h \
+ $(SRCDIR)/lib/include/libdvbv5/desc_network_name.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_extended.h b/lib/include/libdvbv5/desc_event_extended.h
index ccc1d5e1..9b6262fd 100644
--- a/lib/include/libdvbv5/desc_event_extended.h
+++ b/lib/include/libdvbv5/desc_event_extended.h
@@ -55,6 +55,7 @@
* @param text text string
* @param text_emph text emphasis string
*
+ * @details
* 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".
*/
diff --git a/lib/include/libdvbv5/desc_event_short.h b/lib/include/libdvbv5/desc_event_short.h
index 0275924e..6c805056 100644
--- a/lib/include/libdvbv5/desc_event_short.h
+++ b/lib/include/libdvbv5/desc_event_short.h
@@ -54,6 +54,7 @@
* @param text event text string
* @param text_emph event text emphasis string
*
+ * @details
* 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".
*/
diff --git a/lib/include/libdvbv5/desc_network_name.h b/lib/include/libdvbv5/desc_network_name.h
index 9cf11a06..f4af74f3 100644
--- a/lib/include/libdvbv5/desc_network_name.h
+++ b/lib/include/libdvbv5/desc_network_name.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,42 @@
*
*/
+/**
+ * @file desc_network_name.h
+ * @ingroup descriptors
+ * @brief Provides the descriptors for the network name 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 (2010-04)
+ *
+ * @par Bug Report
+ * Please submit bug reports and patches to linux-media@vger.kernel.org
+ */
+
#ifndef _DESC_NETWORK_NAME_H
#define _DESC_NETWORK_NAME_H
#include <libdvbv5/descriptors.h>
+/**
+ * @struct dvb_desc_network_name
+ * @ingroup descriptors
+ * @brief Struct containing the network name descriptor
+ *
+ * @param type descriptor tag
+ * @param length descriptor length
+ * @param next pointer to struct dvb_desc
+ * @param network_name network name string
+ * @param network_name_emph network name emphasis string
+ *
+ * @details
+ * 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_network_name {
uint8_t type;
uint8_t length;
@@ -39,9 +70,41 @@ struct dvb_v5_fe_parms;
extern "C" {
#endif
-int dvb_desc_network_name_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf, struct dvb_desc *desc);
-void dvb_desc_network_name_free (struct dvb_desc *desc);
-void dvb_desc_network_name_print(struct dvb_v5_fe_parms *parms, const struct dvb_desc *desc);
+/**
+ * @brief Initializes and parses the network name 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_network_name_init(struct dvb_v5_fe_parms *parms,
+ const uint8_t *buf, struct dvb_desc *desc);
+
+/**
+ * @brief Prints the content of the network name 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_network_name_print(struct dvb_v5_fe_parms *parms,
+ const struct dvb_desc *desc);
+
+/**
+ * @brief Frees all data allocated by the network name descriptor
+ * @ingroup descriptors
+ *
+ * @param desc pointer to struct dvb_desc to be freed
+ */
+void dvb_desc_network_name_free(struct dvb_desc *desc);
#ifdef __cplusplus
}
diff --git a/lib/include/libdvbv5/descriptors.h b/lib/include/libdvbv5/descriptors.h
index 34191603..c12ffc74 100644
--- a/lib/include/libdvbv5/descriptors.h
+++ b/lib/include/libdvbv5/descriptors.h
@@ -335,7 +335,6 @@ extern const struct dvb_descriptor dvb_descriptors[];
* @var flexmux_timing_descriptor
* @brief flexmux_timing descriptor - ISO/IEC 13818-1
* @var network_name_descriptor
- *
* @brief network_name descriptor - ETSI EN 300 468 V1.11.1 (2010-04)
* @var service_list_descriptor
* @brief service_list descriptor - ETSI EN 300 468 V1.11.1 (2010-04)

Privacy Policy