diff options
author | Mauro Carvalho Chehab <m.chehab@samsung.com> | 2014-09-22 11:08:04 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <m.chehab@samsung.com> | 2014-09-22 11:08:04 -0300 |
commit | a8c1861f114f4c572e106dcc57b6c6ab91a08ae1 (patch) | |
tree | 2863699520a244bf6fb8cf5188b79698f9b0d13a | |
parent | 4d006bc412e457e0c6950850e7c7aa8aed566c4c (diff) |
libdvbv5: add documentation for the language 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_language.h | 61 |
2 files changed, 59 insertions, 3 deletions
diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg index db108883..dd8ba343 100644 --- a/doxygen_libdvbv5.cfg +++ b/doxygen_libdvbv5.cfg @@ -777,6 +777,7 @@ INPUT = $(SRCDIR)/doc/libdvbv5-index.doc \ $(SRCDIR)/lib/include/libdvbv5/desc_frequency_list.h \ $(SRCDIR)/lib/include/libdvbv5/desc_hierarchy.h \ $(SRCDIR)/lib/include/libdvbv5/desc_isdbt_delivery.h \ + $(SRCDIR)/lib/include/libdvbv5/desc_language.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_language.h b/lib/include/libdvbv5/desc_language.h index b448a731..f333cfaa 100644 --- a/lib/include/libdvbv5/desc_language.h +++ b/lib/include/libdvbv5/desc_language.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,40 @@ * */ +/** + * @file desc_language.h + * @ingroup descriptors + * @brief Provides the descriptors for the ISO639 language 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 + * + * @par Bug Report + * Please submit bug reports and patches to linux-media@vger.kernel.org + */ + #ifndef _DESC_LANGUAGE_H #define _DESC_LANGUAGE_H #include <libdvbv5/descriptors.h> +/** + * @struct dvb_desc_language + * @ingroup descriptors + * @brief Structure containing the ISO639 language descriptor + * + * @param type descriptor tag + * @param length descriptor length + * @param next pointer to struct dvb_desc + * @param language ISO639 language string + * @param audio_type audio type: 0 = undefined, 1 = clean effects, + * 2 = hearing impaired, 3 = visual impired + * comentary, other values are reserved. + */ struct dvb_desc_language { uint8_t type; uint8_t length; @@ -39,8 +68,34 @@ struct dvb_v5_fe_parms; extern "C" { #endif -int dvb_desc_language_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf, struct dvb_desc *desc); -void dvb_desc_language_print(struct dvb_v5_fe_parms *parms, const struct dvb_desc *desc); +/** + * @brief Initializes and parses the language 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_language_init(struct dvb_v5_fe_parms *parms, const uint8_t *buf, + struct dvb_desc *desc); + +/** + * @brief Prints the content of the language 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_language_print(struct dvb_v5_fe_parms *parms, + const struct dvb_desc *desc); #ifdef __cplusplus } |