diff options
author | Mauro Carvalho Chehab <m.chehab@samsung.com> | 2014-09-22 08:23:03 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <m.chehab@samsung.com> | 2014-09-22 08:23:37 -0300 |
commit | 80a019dfa675f468114cb25b00505482328b5269 (patch) | |
tree | 1f5681ec7a3b7735ce97467fa85557889c11ffce | |
parent | e00882e9ea74ae158c4ba60a6676db5ce4865f6a (diff) |
libdvbv5: add documentation for the extended event descriptor
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
-rw-r--r-- | doxygen_libdvbv5.cfg | 1 | ||||
-rw-r--r-- | lib/include/libdvbv5/desc_cable_delivery.h | 2 | ||||
-rw-r--r-- | lib/include/libdvbv5/desc_event_extended.h | 74 |
3 files changed, 72 insertions, 5 deletions
diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg index f940d57a..e0a6ac36 100644 --- a/doxygen_libdvbv5.cfg +++ b/doxygen_libdvbv5.cfg @@ -771,6 +771,7 @@ INPUT = $(SRCDIR)/doc/libdvbv5-index.doc \ $(SRCDIR)/lib/include/libdvbv5/desc_ca.h \ $(SRCDIR)/lib/include/libdvbv5/desc_ca_identifier.h \ $(SRCDIR)/lib/include/libdvbv5/desc_cable_delivery.h \ + $(SRCDIR)/lib/include/libdvbv5/desc_event_extended.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_cable_delivery.h b/lib/include/libdvbv5/desc_cable_delivery.h index 162acbeb..95c8a11f 100644 --- a/lib/include/libdvbv5/desc_cable_delivery.h +++ b/lib/include/libdvbv5/desc_cable_delivery.h @@ -44,7 +44,7 @@ /** * @struct dvb_desc_cable_delivery * @ingroup descriptors - * @brief structure containing the cable delivery system descriptor + * @brief Structure containing the cable delivery system descriptor * * @param type descriptor tag * @param length descriptor length diff --git a/lib/include/libdvbv5/desc_event_extended.h b/lib/include/libdvbv5/desc_event_extended.h index 8ad1a838..ccc1d5e1 100644 --- a/lib/include/libdvbv5/desc_event_extended.h +++ b/lib/include/libdvbv5/desc_event_extended.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,45 @@ * */ +/** + * @file desc_event_extended.h + * @ingroup descriptors + * @brief Provides the descriptors for the extended 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_EXTENDED_H #define _DESC_EVENT_EXTENDED_H #include <libdvbv5/descriptors.h> + +/** + * @struct dvb_desc_event_extended + * @ingroup descriptors + * @brief Structure containing the extended event descriptor + * + * @param type descriptor tag + * @param length descriptor length + * @param next pointer to struct dvb_desc + * @param id descriptor number + * @param last_id last descriptor number + * @param language ISO 639 language code + * @param text text string + * @param text_emph 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_extended { uint8_t type; uint8_t length; @@ -48,9 +82,41 @@ struct dvb_v5_fe_parms; extern "C" { #endif -int dvb_desc_event_extended_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf, struct dvb_desc *desc); -void dvb_desc_event_extended_print(struct dvb_v5_fe_parms *parms, const struct dvb_desc *desc); -void dvb_desc_event_extended_free (struct dvb_desc *desc); +/** + * @brief Initializes and parses the extended 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_extended_init(struct dvb_v5_fe_parms *parms, + const uint8_t *buf, struct dvb_desc *desc); + +/** + * @brief Prints the content of the extended 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_extended_print(struct dvb_v5_fe_parms *parms, + const struct dvb_desc *desc); + +/** + * @brief Frees all data allocated by the extended event descriptor + * @ingroup descriptors + * + * @param desc pointer to struct dvb_desc to be freed + */ +void dvb_desc_event_extended_free(struct dvb_desc *desc); #ifdef __cplusplus } |