aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-11 22:51:27 -0300
committerMauro Carvalho Chehab <m.chehab@samsung.com>2014-09-11 22:51:27 -0300
commit12779602fb956689471e43998efc969ed1169658 (patch)
treec02e01000dbee7b7e0b8ad260f0ff8f3207e4640
parentfccce9b760ecca78aa3eb6765a7c37417559b845 (diff)
libdvbv5: group documentation into modules
In order to help digging into the documentation, put each documented block into a group. Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
-rw-r--r--doc/libdvbv5-index.doc8
-rw-r--r--lib/include/libdvbv5/atsc_eit.h9
-rw-r--r--lib/include/libdvbv5/atsc_header.h2
-rw-r--r--lib/include/libdvbv5/cat.h3
-rw-r--r--lib/include/libdvbv5/crc32.h2
-rw-r--r--lib/include/libdvbv5/descriptors.h31
-rw-r--r--lib/include/libdvbv5/dvb-demux.h8
-rw-r--r--lib/include/libdvbv5/dvb-fe.h35
-rw-r--r--lib/include/libdvbv5/dvb-file.h45
-rw-r--r--lib/include/libdvbv5/dvb-log.h5
-rw-r--r--lib/include/libdvbv5/dvb-sat.h8
-rw-r--r--lib/include/libdvbv5/dvb-scan.h15
-rw-r--r--lib/include/libdvbv5/dvb-v5-std.h46
-rw-r--r--lib/include/libdvbv5/eit.h13
-rw-r--r--lib/include/libdvbv5/header.h5
-rw-r--r--lib/include/libdvbv5/mgt.h7
-rw-r--r--lib/include/libdvbv5/nit.h14
-rw-r--r--lib/include/libdvbv5/pat.h9
-rw-r--r--lib/include/libdvbv5/pmt.h14
-rw-r--r--lib/include/libdvbv5/sdt.h10
-rw-r--r--lib/include/libdvbv5/vct.h11
21 files changed, 277 insertions, 23 deletions
diff --git a/doc/libdvbv5-index.doc b/doc/libdvbv5-index.doc
index ee31fdf0..1866f75c 100644
--- a/doc/libdvbv5-index.doc
+++ b/doc/libdvbv5-index.doc
@@ -166,4 +166,12 @@ If DVB version 5.10 is supported, it also provides an extra Quality of
service indicator that tells if a received transponder has Poor, OK or
Good quality.
+@defgroup frontend Digital TV frontend control
+@defgroup frontend_scan Digital TV frontend scan
+@defgroup satellite Satellite Equipment Control
+@defgroup ancillary Ancillary functions and macros
+@defgroup dvb_table Digital TV table parsing
+@defgroup demux Digital TV demux
+@defgroup file Channel and transponder file read/write
+
*/
diff --git a/lib/include/libdvbv5/atsc_eit.h b/lib/include/libdvbv5/atsc_eit.h
index 8029ac93..d7814904 100644
--- a/lib/include/libdvbv5/atsc_eit.h
+++ b/lib/include/libdvbv5/atsc_eit.h
@@ -20,6 +20,7 @@
/**
* @file atsc_eit.h
+ * @ingroup dvb_table
* @brief Provides the table parser for the ATSC EIT (Event Information Table)
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -54,6 +55,7 @@
/**
* @struct atsc_table_eit_event
* @brief ATSC EIT event table
+ * @ingroup dvb_table
*
* @param event_id an uniquelly (inside a service ID) event ID
* @param title_length title length. Zero means no title
@@ -104,6 +106,7 @@ struct atsc_table_eit_event {
/**
* @union atsc_table_eit_desc_length
* @brief ATSC EIT descriptor length
+ * @ingroup dvb_table
*
* @param desc_length descriptor length
*
@@ -126,6 +129,7 @@ union atsc_table_eit_desc_length {
/**
* @struct atsc_table_eit
* @brief ATSC EIT table
+ * @ingroup dvb_table
*
* @param header struct dvb_table_header content
* @param protocol_version protocol version
@@ -148,6 +152,7 @@ struct atsc_table_eit {
/**
* @brief Macro used to find event on an ATSC EIT table
+ * @ingroup dvb_table
*
* @param _event event to seek
* @param _eit pointer to struct atsc_table_eit_event
@@ -163,6 +168,7 @@ extern "C" {
/**
* @brief Initializes and parses ATSC EIT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param buf buffer containing the EIT raw data
@@ -181,6 +187,7 @@ ssize_t atsc_table_eit_init(struct dvb_v5_fe_parms *parms, const uint8_t *buf,
/**
* @brief Frees all data allocated by the ATSC EIT table parser
+ * @ingroup dvb_table
*
* @param table pointer to struct atsc_table_eit to be freed
*/
@@ -188,6 +195,7 @@ void atsc_table_eit_free(struct atsc_table_eit *table);
/**
* @brief Prints the content of the ATSC EIT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param table pointer to struct atsc_table_eit
@@ -197,6 +205,7 @@ void atsc_table_eit_print(struct dvb_v5_fe_parms *parms,
/**
* @brief Converts an ATSC EIT formatted timestamp into struct tm
+ * @ingroup ancillary
*
* @param start_time event on ATSC EIT time format
* @param tm pointer to struct tm where the converted timestamp will
diff --git a/lib/include/libdvbv5/atsc_header.h b/lib/include/libdvbv5/atsc_header.h
index 773067fe..ca9bc84c 100644
--- a/lib/include/libdvbv5/atsc_header.h
+++ b/lib/include/libdvbv5/atsc_header.h
@@ -23,6 +23,7 @@
/**
* @file atsc_header.h
+ * @ingroup dvb_table
* @brief Provides some common ATSC stuff
* @copyright GNU General Public License version 2 (GPLv2)
* @author Andre Roth
@@ -39,6 +40,7 @@
/**
* @def ATSC_BASE_PID
* @brief ATSC PID for the Program and System Information Protocol
+ * @ingroup dvb_table
*/
#define ATSC_BASE_PID 0x1FFB
diff --git a/lib/include/libdvbv5/cat.h b/lib/include/libdvbv5/cat.h
index c78a412a..ddcd7f51 100644
--- a/lib/include/libdvbv5/cat.h
+++ b/lib/include/libdvbv5/cat.h
@@ -20,6 +20,7 @@
/**
* @file cat.h
+ * @ingroup dvb_table
* @brief Provides the table parser for the CAT (Conditional Access Table)
* @copyright GNU General Public License version 2 (GPLv2)
* @author Andre Roth
@@ -39,8 +40,10 @@
/**
* @def DVB_TABLE_CAT
* @brief ATSC CAT table ID
+ * @ingroup dvb_table
* @def DVB_TABLE_CAT_PID
* @brief ATSC PID table ID
+ * @ingroup dvb_table
*/
#define DVB_TABLE_CAT 0x01
#define DVB_TABLE_CAT_PID 0x0001
diff --git a/lib/include/libdvbv5/crc32.h b/lib/include/libdvbv5/crc32.h
index 08bfe4b8..d184b35e 100644
--- a/lib/include/libdvbv5/crc32.h
+++ b/lib/include/libdvbv5/crc32.h
@@ -21,6 +21,7 @@
/**
* @file crc32.h
+ * @ingroup ancillary
* @brief Provides ancillary code to calculate DVB crc32 checksum
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -41,6 +42,7 @@ extern "C" {
#endif
/** @brief Calculates the crc-32 as defined at the MPEG-TS specs
+ * @ingroup ancillary
*
* @param data Pointer to the buffer to be checked
* @param datalen Length of the buffer
diff --git a/lib/include/libdvbv5/descriptors.h b/lib/include/libdvbv5/descriptors.h
index cdc1ec97..34191603 100644
--- a/lib/include/libdvbv5/descriptors.h
+++ b/lib/include/libdvbv5/descriptors.h
@@ -20,6 +20,7 @@
/**
* @file descriptors.h
+ * @ingroup dvb_table
* @brief Provides a way to handle MPEG-TS descriptors found on Digital TV
* streams.
* @copyright GNU General Public License version 2 (GPLv2)
@@ -48,10 +49,16 @@
#include <stdint.h>
#include <arpa/inet.h>
-/** @brief Maximum size of a table session to be parsed */
+/**
+ * @brief Maximum size of a table session to be parsed
+ * @ingroup dvb_table
+ */
#define DVB_MAX_PAYLOAD_PACKET_SIZE 4096
-/** @brief number of bytes for the descriptor's CRC check */
+/**
+ * @brief number of bytes for the descriptor's CRC check
+ * @ingroup dvb_table
+ */
#define DVB_CRC_SIZE 4
@@ -62,6 +69,7 @@ struct dvb_v5_fe_parms;
/**
* @brief Function prototype for a function that initializes the
* descriptors parsing on a table
+ * @ingroup dvb_table
*
* @param parms Struct dvb_v5_fe_parms pointer
* @param buf Buffer with data to be parsed
@@ -73,7 +81,10 @@ typedef void (*dvb_table_init_func)(struct dvb_v5_fe_parms *parms,
const uint8_t *buf, ssize_t buflen,
void **table);
-/** @brief Table with all possible descriptors */
+/**
+ * @brief Table with all possible descriptors
+ * @ingroup dvb_table
+ */
extern const dvb_table_init_func dvb_table_initializers[256];
#ifndef _DOXYGEN
@@ -97,6 +108,7 @@ extern const dvb_table_init_func dvb_table_initializers[256];
* @struct dvb_desc
* @brief Linked list containing the several descriptors found on a
* MPEG-TS table
+ * @ingroup dvb_table
*
* @param type Descriptor type
* @param length Length of the descriptor
@@ -128,6 +140,7 @@ extern "C" {
/**
* @brief Converts from BCD to CPU integer internal representation
+ * @ingroup dvb_table
*
* @param bcd value in BCD encoding
*/
@@ -135,6 +148,7 @@ uint32_t dvb_bcd(uint32_t bcd);
/**
* @brief dumps data into the logs in hexadecimal format
+ * @ingroup dvb_table
*
* @param parms Struct dvb_v5_fe_parms pointer
* @param prefix String to be printed before the dvb_hexdump
@@ -146,6 +160,7 @@ void dvb_hexdump(struct dvb_v5_fe_parms *parms, const char *prefix,
/**
* @brief parse MPEG-TS descriptors
+ * @ingroup dvb_table
*
* @param parms Struct dvb_v5_fe_parms pointer
* @param buf Buffer with data to be parsed
@@ -169,6 +184,7 @@ int dvb_desc_parse(struct dvb_v5_fe_parms *parms, const uint8_t *buf,
/**
* @brief frees a dvb_desc linked list
+ * @ingroup dvb_table
*
* @param list struct dvb_desc pointer.
*/
@@ -176,6 +192,7 @@ void dvb_desc_free (struct dvb_desc **list);
/**
* @brief prints the contents of a struct dvb_desc linked list
+ * @ingroup dvb_table
*
* @param parms Struct dvb_v5_fe_parms pointer
* @param desc struct dvb_desc pointer.
@@ -188,6 +205,7 @@ void dvb_desc_print(struct dvb_v5_fe_parms *parms, struct dvb_desc *desc);
/**
* @brief Function prototype for the descriptors parsing init code
+ * @ingroup dvb_table
*
* @param parms Struct dvb_v5_fe_parms pointer
* @param buf buffer with the content of the descriptor
@@ -198,6 +216,7 @@ typedef int (*dvb_desc_init_func) (struct dvb_v5_fe_parms *parms,
/**
* @brief Function prototype for the descriptors parsing print code
+ * @ingroup dvb_table
*
* @param parms Struct dvb_v5_fe_parms pointer
* @param desc struct dvb_desc pointer
@@ -207,6 +226,7 @@ typedef void (*dvb_desc_print_func)(struct dvb_v5_fe_parms *parms,
/**
* @brief Function prototype for the descriptors memory free code
+ * @ingroup dvb_table
*
* @param desc pointer to struct dvb_desc pointer to be freed
*/
@@ -215,6 +235,7 @@ typedef void (*dvb_desc_free_func) (struct dvb_desc *desc);
/**
* @struct dvb_descriptor
* @brief Contains the parser information for the MPEG-TS parser code
+ * @ingroup dvb_table
*
* @param name String containing the name of the descriptor
* @param init Pointer to a function to initialize the descriptor
@@ -234,13 +255,15 @@ struct dvb_descriptor {
/**
* @brief Contains the parsers for the several descriptors
+ * @ingroup dvb_table
*/
extern const struct dvb_descriptor dvb_descriptors[];
/**
+ * @enum descriptors
* @brief List containing all descriptors used by Digital TV MPEG-TS
+ * @ingroup dvb_table
*
-
* @var video_stream_descriptor
* @brief video_stream descriptor - ISO/IEC 13818-1
* @var audio_stream_descriptor
diff --git a/lib/include/libdvbv5/dvb-demux.h b/lib/include/libdvbv5/dvb-demux.h
index 97fec91d..fd5b06c3 100644
--- a/lib/include/libdvbv5/dvb-demux.h
+++ b/lib/include/libdvbv5/dvb-demux.h
@@ -22,6 +22,7 @@
/**
* @file dvb-demux.h
+ * @ingroup demux
* @brief Provides interfaces to deal with DVB demux.
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -41,6 +42,7 @@ extern "C" {
/**
* @brief Opens a DVB demux in read/write mode
+ * @ingroup demux
*
* @param adapter DVB adapter number to open
* @param demux DVB demux number to open
@@ -53,6 +55,7 @@ int dvb_dmx_open(int adapter, int demux);
/**
* @brief Stops the DMX filter for the file descriptor and closes
+ * @ingroup demux
*
* @param dmx_fd File descriptor to close
*
@@ -61,8 +64,8 @@ int dvb_dmx_open(int adapter, int demux);
void dvb_dmx_close(int dmx_fd);
/**
- * @fn void dvb_dmx_stop(int dmx_fd)
* @brief Stops the DMX filter for a given file descriptor
+ * @ingroup demux
*
* @param dmx_fd File descriptor to close
*
@@ -73,6 +76,7 @@ void dvb_dmx_stop(int dmx_fd);
/**
* @brief Start a filter for a MPEG-TS Packetized Elementary
* Stream (PES)
+ * @ingroup demux
*
* @param dmxfd File descriptor for the demux device
* @param pid Program ID to filter. Use 0x2000 to select all PIDs
@@ -93,6 +97,7 @@ int dvb_set_pesfilter(int dmxfd, int pid, dmx_pes_type_t type,
/**
* @brief Sets a MPEG-TS section filter
+ * @ingroup demux
*
* @param dmxfd File descriptor for the demux device
* @param pid Program ID to filter. Use 0x2000 to select all PIDs
@@ -118,6 +123,7 @@ int dvb_set_section_filter(int dmxfd, int pid, unsigned filtsize,
/**
* @brief read the contents of the MPEG-TS PAT table, seeking for
* an specific service ID
+ * @ingroup demux
*
* @param dmxfd File descriptor for the demux device
* @param sid Session ID to seeking
diff --git a/lib/include/libdvbv5/dvb-fe.h b/lib/include/libdvbv5/dvb-fe.h
index e8e93187..398f2a62 100644
--- a/lib/include/libdvbv5/dvb-fe.h
+++ b/lib/include/libdvbv5/dvb-fe.h
@@ -35,6 +35,7 @@
/**
* @file dvb-fe.h
+ * @ingroup frontend
* @brief Provides interfaces to deal with DVB frontend.
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -59,12 +60,14 @@
/**
* @def ARRAY_SIZE(array)
* @brief Calculates the number of elements of an array
+ * @ingroup ancillary
*/
#define ARRAY_SIZE(x) (sizeof(x)/sizeof((x)[0]))
/**
* @def MAX_DELIVERY_SYSTEMS
* @brief Max number of delivery systems for a given frontend.
+ * @ingroup frontend
*/
#define MAX_DELIVERY_SYSTEMS 20
@@ -83,6 +86,7 @@
/**
* @struct dvb_v5_fe_parms
+ * @ingroup frontend
* @brief Keeps data needed to handle the DVB frontend
*
* @param info Contains the DVB info properties (RO)
@@ -150,6 +154,7 @@ extern "C" {
/**
* @brief Allocates a dummy frontend structure
+ * @ingroup frontend
*
* @details This is useful for some applications that may want to just use the
* frontend structure internally, without associating it with a real hardware
@@ -160,6 +165,7 @@ struct dvb_v5_fe_parms *dvb_fe_dummy(void);
/**
* @brief Opens a frontend and allocates a structure to work with
+ * @ingroup frontend
*
* @param adapter Number of the adapter to open
* @param frontend Number of the frontend to open
@@ -178,6 +184,7 @@ struct dvb_v5_fe_parms *dvb_fe_open(int adapter, int frontend,
/**
* @brief Opens a frontend and allocates a structure to work with
+ * @ingroup frontend
*
* @param adapter Number of the adapter to open
* @param frontend Number of the frontend to open
@@ -200,6 +207,7 @@ struct dvb_v5_fe_parms *dvb_fe_open2(int adapter, int frontend,
/**
* @brief Closes the frontend and frees allocated resources
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
*/
@@ -207,6 +215,7 @@ void dvb_fe_close(struct dvb_v5_fe_parms *parms);
/**
* @brief Returns the string name associated with a DVBv5 command
+ * @ingroup frontend
*
* @param cmd DVBv5 or libdvbv5 property
*
@@ -222,6 +231,7 @@ const char *dvb_cmd_name(int cmd);
/**
* @brief Returns an string array with the valid string values associated with a DVBv5 command
+ * @ingroup frontend
*
* @param cmd DVBv5 or libdvbv5 property
*
@@ -239,6 +249,7 @@ const char *const *dvb_attr_names(int cmd);
/**
* @brief Retrieves the value of a DVBv5/libdvbv5 property
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param cmd DVBv5 or libdvbv5 property
@@ -254,6 +265,7 @@ int dvb_fe_retrieve_parm(const struct dvb_v5_fe_parms *parms,
/**
* @brief Stores the value of a DVBv5/libdvbv5 property
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param cmd DVBv5 or libdvbv5 property
@@ -269,6 +281,7 @@ int dvb_fe_store_parm(struct dvb_v5_fe_parms *parms,
/**
* @brief Sets the delivery system
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param sys delivery system to be selected
@@ -286,6 +299,7 @@ int dvb_set_sys(struct dvb_v5_fe_parms *parms,
/**
* @brief Make dvb properties reflect the current standard
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param sys delivery system to be selected
@@ -302,6 +316,7 @@ int dvb_add_parms_for_sys(struct dvb_v5_fe_parms *parms,
/**
* @brief Sets the delivery system
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened
* device
@@ -323,6 +338,7 @@ int dvb_set_compat_delivery_system(struct dvb_v5_fe_parms *parms,
/**
* @brief Prints all the properties at the cache
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
*
@@ -332,6 +348,7 @@ void dvb_fe_prt_parms(const struct dvb_v5_fe_parms *parms);
/**
* @brief Prints all the properties at the cache
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
*
@@ -345,6 +362,7 @@ int dvb_fe_set_parms(struct dvb_v5_fe_parms *parms);
/**
* @brief Prints all the properties at the cache
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
*
@@ -361,6 +379,7 @@ int dvb_fe_get_parms(struct dvb_v5_fe_parms *parms);
/**
* @brief Retrieve the stats for a DTV layer from cache
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param cmd DVBv5 or libdvbv5 property
@@ -386,6 +405,7 @@ struct dtv_stats *dvb_fe_retrieve_stats_layer(struct dvb_v5_fe_parms *parms,
/**
* @brief Retrieve the stats for a DTV layer from cache
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param cmd DVBv5 or libdvbv5 property
@@ -402,6 +422,7 @@ int dvb_fe_retrieve_stats(struct dvb_v5_fe_parms *parms,
/**
* @brief Retrieve the stats from the Kernel
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
*
@@ -413,6 +434,7 @@ int dvb_fe_get_stats(struct dvb_v5_fe_parms *parms);
/**
* @brief Retrieve the BER stats from cache
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param layer DTV layer
@@ -440,6 +462,7 @@ float dvb_fe_retrieve_ber(struct dvb_v5_fe_parms *parms, unsigned layer,
/**
* @brief Retrieve the PER stats from cache
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param layer DTV layer
@@ -463,6 +486,7 @@ float dvb_fe_retrieve_per(struct dvb_v5_fe_parms *parms, unsigned layer);
/**
* @brief Ancillary function to sprintf on ENG format
+ * @ingroup frontend
*
* @param buf buffer to store the value
* @param len buffer length
@@ -479,6 +503,7 @@ int dvb_fe_snprintf_eng(char *buf, int len, float val);
/**
* @brief Ancillary function to sprintf on ENG format
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param cmd DVBv5 or libdvbv5 property
@@ -503,6 +528,7 @@ int dvb_fe_snprintf_eng(char *buf, int len, float val);
/**
* @brief Get both status statistics and dvb parameters
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
*
@@ -543,6 +569,7 @@ int dvb_fe_get_event(struct dvb_v5_fe_parms *parms);
/**
* @brief DVB ioctl wrapper for setting SEC voltage
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param on a value different than zero indicates to enable
@@ -556,6 +583,7 @@ int dvb_fe_sec_voltage(struct dvb_v5_fe_parms *parms, int on, int v18);
/**
* @brief DVB ioctl wrapper for setting SEC tone
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param tone tone setting, as defined by DVB fe_sec_tone_mode_t type
@@ -566,6 +594,7 @@ int dvb_fe_sec_tone(struct dvb_v5_fe_parms *parms, fe_sec_tone_mode_t tone);
/**
* @brief DVB ioctl wrapper for setting LNBf high voltage
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param on a value different than zero indicates to produce
@@ -577,6 +606,7 @@ int dvb_fe_lnb_high_voltage(struct dvb_v5_fe_parms *parms, int on);
/**
* @brief DVB ioctl wrapper for setting SEC DiSeqC tone burst to select between
* satellite A or B
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param mini_b if different than zero, sends a 22 KHz tone burst to
@@ -591,6 +621,7 @@ int dvb_fe_diseqc_burst(struct dvb_v5_fe_parms *parms, int mini_b);
/**
* @brief DVB ioctl wrapper for setting SEC DiSeqC command
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param len size of the DiSEqC command
@@ -603,6 +634,7 @@ int dvb_fe_diseqc_cmd(struct dvb_v5_fe_parms *parms, const unsigned len,
/**
* @brief DVB ioctl wrapper for getting SEC DiSEqC reply
+ * @ingroup frontend
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param len size of the DiSEqC command
@@ -616,6 +648,9 @@ int dvb_fe_diseqc_reply(struct dvb_v5_fe_parms *parms, unsigned *len, char *buf,
/**
* @brief DVB Ancillary routine to check if a given Delivery system is satellite
+ * @ingroup frontend
+ *
+ * @param delivery_system delivery system to be selected
*/
int dvb_fe_is_satellite(uint32_t delivery_system);
diff --git a/lib/include/libdvbv5/dvb-file.h b/lib/include/libdvbv5/dvb-file.h
index 063a351d..09cc6c0d 100644
--- a/lib/include/libdvbv5/dvb-file.h
+++ b/lib/include/libdvbv5/dvb-file.h
@@ -18,6 +18,7 @@
/**
* @file dvb-file.h
+ * @ingroup file
* @brief Provides interfaces to deal with DVB channel and program files.
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -47,6 +48,7 @@
/**
* @struct dvb_elementary_pid
* @brief associates an elementary stream type with its PID
+ * @ingroup file
*
* @param type Elementary stream type
* @param pid Elementary stream Program ID
@@ -59,6 +61,7 @@ struct dvb_elementary_pid {
/**
* @struct dvb_entry
* @brief Represents one entry on a DTV file
+ * @ingroup file
*
* @param props A property key/value pair. The keys are the ones
* specified at the DVB API, plus the ones defined
@@ -139,6 +142,7 @@ struct dvb_file {
/**
* @struct dvb_parse_table
* @brief Describes the fields to parse on a file
+ * @ingroup file
*
* @param prop Name of the DVBv5 or libdvbv5 property field
* @param table Name of a translation table for string to
@@ -163,6 +167,7 @@ struct dvb_parse_table {
/**
* @struct dvb_parse_struct
* @brief Describes the format to parse an specific delivery system
+ * @ingroup file
*
* @param id String that identifies the delivery system on the
* file to be parsed
@@ -198,16 +203,23 @@ struct dvb_parse_file {
/**
* @enum dvb_file_formats
* @brief Known file formats
+ * @ingroup file
*
- * @param FILE_UNKNOWN File format is unknown
- * @param FILE_ZAP File is at the dvb-apps "dvbzap" format
- * @param FILE_CHANNEL File is at the dvb-apps output format for dvb-zap
- * @param FILE_DVBV5 File is at libdvbv5 format
- *
+ * @details
* Please notice that the channel format defined here has a few optional
* fields that aren't part of the dvb-apps format, for DVB-S2 and for DVB-T2.
* They're there to match the formats found at dtv-scan-tables package up to
* September, 5 2014.
+ *
+ * @var FILE_UNKNOWN
+ * @brief File format is unknown
+ * @var FILE_ZAP
+ * @brief File is at the dvb-apps "dvbzap" format
+ * @var FILE_CHANNEL
+ * @brief File is at the dvb-apps output format for dvb-zap
+ * @var FILE_DVBV5
+ * @brief File is at libdvbv5 format
+ *
*/
enum dvb_file_formats {
FILE_UNKNOWN,
@@ -224,6 +236,7 @@ extern "C" {
/**
* @brief Deallocates memory associated with a struct dvb_file
+ * @ingroup file
*
* @param dvb_file dvb_file struct to be deallocated
*
@@ -260,10 +273,16 @@ static inline void dvb_file_free(struct dvb_file *dvb_file)
* the library can read natively.
*/
-/** @brief File format definitions for dvb-apps channel format */
+/**
+ * @brief File format definitions for dvb-apps channel format
+ * @ingroup file
+ */
extern const struct dvb_parse_file channel_file_format;
-/** @brief File format definitions for dvb-apps zap format */
+/**
+ * @brief File format definitions for dvb-apps zap format
+ * @ingroup file
+ */
extern const struct dvb_parse_file channel_file_zap_format;
/*
@@ -272,6 +291,7 @@ extern const struct dvb_parse_file channel_file_zap_format;
/**
* @brief Read a file at libdvbv5 format
+ * @ingroup file
*
* @param fname file name
*
@@ -282,6 +302,7 @@ struct dvb_file *dvb_read_file(const char *fname);
/**
* @brief Write a file at libdvbv5 format
+ * @ingroup file
*
* @param fname file name
* @param dvb_file contents of the file to be written
@@ -293,6 +314,7 @@ int dvb_write_file(const char *fname, struct dvb_file *dvb_file);
/**
* @brief Read a file on any format natively supported by
* the library
+ * @ingroup file
*
* @param fname file name
* @param delsys Delivery system, as specified by enum fe_delivery_system
@@ -308,6 +330,7 @@ struct dvb_file *dvb_read_file_format(const char *fname,
/**
* @brief Write a file on any format natively supported by
* the library
+ * @ingroup file
*
* @param fname file name
* @param dvb_file contents of the file to be written
@@ -324,6 +347,7 @@ int dvb_write_file_format(const char *fname,
/**
* @brief Stores a key/value pair on a DVB file entry
+ * @ingroup file
*
* @param entry entry to be filled
* @param cmd key for the property to be used. It be one of the DVBv5
@@ -341,6 +365,7 @@ int dvb_store_entry_prop(struct dvb_entry *entry,
/**
* @brief Retrieves the value associated witha key on a DVB file entry
+ * @ingroup file
*
* @param entry entry to be used
* @param cmd key for the property to be found. It be one of the DVBv5
@@ -357,6 +382,7 @@ int dvb_retrieve_entry_prop(struct dvb_entry *entry,
/**
* @brief stored a new scanned channel into a dvb_file struct
+ * @ingroup file
*
* @param dvb_file file struct to be filled
* @param parms struct dvb_v5_fe_parms used by libdvbv5 frontend
@@ -394,6 +420,7 @@ int dvb_store_channel(struct dvb_file **dvb_file,
/**
* @brief Ancillary function that seeks for a delivery system
+ * @ingroup file
*
* @param name string containing the name of the Delivery System to seek
*
@@ -413,6 +440,8 @@ int dvb_parse_delsys(const char *name);
/**
* @brief Ancillary function that parses the name of a file format
+ * @ingroup file
+ *
* @param name string containing the name of the format
* Current valid names are: ZAP, CHANNEL and DVBV5. The name is
* case-insensitive.
@@ -429,6 +458,7 @@ enum dvb_file_formats dvb_parse_format(const char *name);
/**
* @brief Read and parses a one line file format
+ * @ingroup file
*
* @param fname file name
* @param delsys delivery system
@@ -444,6 +474,7 @@ struct dvb_file *dvb_parse_format_oneline(const char *fname,
/**
* @brief Writes a file into an one line file format
+ * @ingroup file
*
* @param fname file name
* @param dvb_file contents of the file to be written
diff --git a/lib/include/libdvbv5/dvb-log.h b/lib/include/libdvbv5/dvb-log.h
index 2ab856d7..d07870f2 100644
--- a/lib/include/libdvbv5/dvb-log.h
+++ b/lib/include/libdvbv5/dvb-log.h
@@ -26,6 +26,7 @@
/**
* @file dvb-log.h
+ * @ingroup ancillary
* @brief Provides interfaces to handle libdvbv5 log messages.
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -38,6 +39,7 @@
/**
* @typedef void (*dvb_logfunc)(int level, const char *fmt, ...)
* @brief typedef used by dvb_fe_open2 for the log function
+ * @ingroup ancillary
*/
typedef void (*dvb_logfunc)(int level, const char *fmt, ...) __attribute__ (( format( printf, 2, 3 )));
@@ -98,7 +100,8 @@ typedef void (*dvb_logfunc)(int level, const char *fmt, ...) __attribute__ (( fo
/**
* @brief This is the prototype of the internal log function that it is used,
- * if the library client doesn't desire to override with something else.
+ * if the library client doesn't desire to override with something else.
+ * @ingroup ancillary
*
* @param level level of the message, as defined at syslog.h
* @param fmt format string (same as format string on sprintf)
diff --git a/lib/include/libdvbv5/dvb-sat.h b/lib/include/libdvbv5/dvb-sat.h
index 75c8ef83..d80a619d 100644
--- a/lib/include/libdvbv5/dvb-sat.h
+++ b/lib/include/libdvbv5/dvb-sat.h
@@ -23,6 +23,7 @@
/**
* @file dvb-sat.h
+ * @ingroup satellite
* @brief Provides interfaces to deal with DVB Satellite systems.
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -38,6 +39,7 @@
/**
* @struct dvbsat_freqrange
* @brief Defines a frequency range used by Satellite
+ * @ingroup satellite
*
* @param low low frequency, in kHz
* @param high high frequency, in kHz
@@ -49,6 +51,7 @@ struct dvbsat_freqrange {
/**
* @struct dvb_sat_lnb
* @brief Stores the information of a LNBf
+ * @ingroup satellite
*
* @param name long name of the LNBf type
* @param alias short name for the LNBf type
@@ -88,6 +91,7 @@ extern "C"
/**
* @brief search for a LNBf entry
+ * @ingroup satellite
*
* @param name name of the LNBf entry to seek.
*
@@ -100,6 +104,7 @@ int dvb_sat_search_lnb(const char *name);
/**
* @brief prints the contents of a LNBf entry at STDOUT.
+ * @ingroup satellite
*
* @param index index for the entry
*
@@ -109,6 +114,7 @@ int dvb_print_lnb(int index);
/**
* @brief Prints all LNBf entries at STDOUT.
+ * @ingroup satellite
*
* This function doesn't return anything. Internally, it calls dvb_print_lnb()
* for all entries inside its LNBf database.
@@ -117,6 +123,7 @@ void dvb_print_all_lnb(void);
/**
* @brief gets a LNBf entry at its internal database
+ * @ingroup satellite
*
* @param index index for the entry.
*
@@ -126,6 +133,7 @@ const struct dvb_sat_lnb *dvb_sat_get_lnb(int index);
/**
* @brief sets the satellite parameters
+ * @ingroup satellite
*
* @param parms struct dvb_v5_fe_parms pointer.
*
diff --git a/lib/include/libdvbv5/dvb-scan.h b/lib/include/libdvbv5/dvb-scan.h
index 689ea24c..fe506873 100644
--- a/lib/include/libdvbv5/dvb-scan.h
+++ b/lib/include/libdvbv5/dvb-scan.h
@@ -26,6 +26,7 @@
/**
* @file dvb-scan.h
+ * @ingroup frontend_scan
* @brief Provides interfaces to scan programs inside MPEG-TS digital TV streams.
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -47,6 +48,7 @@ struct dvb_entry;
/**
* @struct dvb_v5_descriptors_program
* @brief Associates PMT with PAT tables
+ * @ingroup frontend_scan
*
* @param pat_pgm pointer for PAT descriptor
* @param pmt pointer for PMT descriptor
@@ -59,6 +61,7 @@ struct dvb_v5_descriptors_program {
/**
* @struct dvb_v5_descriptors
* @brief Contains the descriptors needed to scan the Service ID and other relevant info at a MPEG-TS Digital TV stream
+ * @ingroup frontend_scan
*
* @param delivery_system Delivery system of the parsed MPEG-TS
* @param entry struct dvb_entry pointer (see dvb-file.h)
@@ -90,6 +93,7 @@ struct dvb_v5_descriptors {
/**
* @struct dvb_table_filter
* @brief Describes the PES filters used by DVB scan
+ * @ingroup frontend_scan
*
* @param tid Table ID
* @param pid Program ID
@@ -118,6 +122,7 @@ struct dvb_table_filter {
};
/**
* @brief deallocates all data associated with a table filter
+ * @ingroup frontend_scan
*
* @param sect table filter pointer
*/
@@ -125,6 +130,7 @@ void dvb_table_filter_free(struct dvb_table_filter *sect);
/**
* @brief read MPEG-TS tables that comes from a DTV card
+ * @ingroup frontend_scan
*
* @param parms pointer to struct dvb_v5_fe_parms created when the
* frontend is opened
@@ -169,6 +175,7 @@ int dvb_read_section(struct dvb_v5_fe_parms *parms, int dmx_fd,
/**
* @brief read MPEG-TS tables that comes from a DTV card
* with an specific table section ID
+ * @ingroup frontend_scan
*
* @param parms pointer to struct dvb_v5_fe_parms created when the
* frontend is opened
@@ -189,6 +196,7 @@ int dvb_read_section(struct dvb_v5_fe_parms *parms, int dmx_fd,
/**
* @brief read MPEG-TS tables that comes from a DTV card
+ * @ingroup frontend_scan
*
* @param parms pointer to struct dvb_v5_fe_parms created when the
* frontend is opened
@@ -205,6 +213,7 @@ int dvb_read_sections(struct dvb_v5_fe_parms *parms, int dmx_fd,
/**
* @brief allocates a struct dvb_v5_descriptors
+ * @ingroup frontend_scan
*
* @param delivery_system Delivery system to be used on the table
*
@@ -214,6 +223,7 @@ struct dvb_v5_descriptors *dvb_scan_alloc_handler_table(uint32_t delivery_system
/**
* @brief frees a struct dvb_v5_descriptors
+ * @ingroup frontend_scan
*
* @param dvb_scan_handler pointer to the struct to be freed.
*/
@@ -222,6 +232,7 @@ void dvb_scan_free_handler_table(struct dvb_v5_descriptors *dvb_scan_handler);
/**
* @brief Scans a DVB stream, looking for the tables needed to
* identify the programs inside a MPEG-TS
+ * @ingroup frontend_scan
*
* @param parms pointer to struct dvb_v5_fe_parms created when
* the frontend is opened
@@ -246,6 +257,7 @@ struct dvb_v5_descriptors *dvb_get_ts_tables(struct dvb_v5_fe_parms *parms, int
/**
* @brief frees a struct dvb_v5_descriptors
+ * @ingroup frontend_scan
*
* @param dvb_desc pointed to the structure to be freed.
*
@@ -256,6 +268,7 @@ void dvb_free_ts_tables(struct dvb_v5_descriptors *dvb_desc);
/**
* @brief Callback for the application to show the frontend status
+ * @ingroup frontend_scan
*
* @param args a pointer, opaque to libdvbv5, to be used by the
* application if needed.
@@ -266,6 +279,7 @@ typedef int (check_frontend_t)(void *args, struct dvb_v5_fe_parms *parms);
/**
* @brief Scans a DVB dvb_add_scaned_transponder
+ * @ingroup frontend_scan
*
* @param parms pointer to struct dvb_v5_fe_parms created when the
* frontend is opened
@@ -319,6 +333,7 @@ struct dvb_v5_descriptors *dvb_scan_transponder(struct dvb_v5_fe_parms *parms,
/**
* @brief Add new transponders to a dvb_file
+ * @ingroup frontend_scan
*
* @param parms pointer to struct dvb_v5_fe_parms created when the
* frontend is opened
diff --git a/lib/include/libdvbv5/dvb-v5-std.h b/lib/include/libdvbv5/dvb-v5-std.h
index 8f23c7d5..c03b0d36 100644
--- a/lib/include/libdvbv5/dvb-v5-std.h
+++ b/lib/include/libdvbv5/dvb-v5-std.h
@@ -28,6 +28,7 @@
/**
* @file dvb-v5-std.h
+ * @ingroup frontend
* @brief Provides libdvbv5 defined properties for the frontend.
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -50,39 +51,54 @@
/**
* @def DTV_USER_COMMAND_START
- * @brief Start number for libdvbv5 user commands
+ * @brief Start number for libdvbv5 user commands
+ * @ingroup frontend
* @def DTV_POLARIZATION
- * @brief Satellite polarization (for Satellite delivery systems)
+ * @brief Satellite polarization (for Satellite delivery systems)
+ * @ingroup frontend
* @def DTV_AUDIO_PID
* @brief Audio PID
+ * @ingroup frontend
* @def DTV_VIDEO_PID
* @brief Video PID
+ * @ingroup frontend
* @def DTV_SERVICE_ID
* @brief MPEG TS service ID
+ * @ingroup frontend
* @def DTV_CH_NAME
* @brief Digital TV service name
+ * @ingroup frontend
* @def DTV_VCHANNEL
* @brief Digital TV channel number. May contain symbols
+ * @ingroup frontend
* @def DTV_SAT_NUMBER
* @brief Number of the satellite (used on multi-dish Satellite systems)
+ * @ingroup frontend
* @def DTV_DISEQC_WAIT
* @brief Extra time needed to wait for DiSeqC to complete, in ms.
* The minimal wait time is 15 ms. The time here will be
* added to the minimal time.
+ * @ingroup frontend
* @def DTV_DISEQC_LNB
* @brief LNBf name
+ * @ingroup frontend
* @def DTV_FREQ_BPF
* @brief SCR/Unicable band-pass filter frequency in kHz
+ * @ingroup frontend
* @def DTV_PLS_CODE
* @brief DVB-T2 PLS code. Not used internally. It is needed
* only for file conversion.
+ * @ingroup frontend
* @def DTV_PLS_MODE
* @brief DVB-T2 PLS mode. Not used internally. It is needed
* only for file conversion.
+ * @ingroup frontend
* @def DTV_MAX_USER_COMMAND
* @brief Last user command
+ * @ingroup frontend
* @def DTV_USER_NAME_SIZE
* @brief Number of user commands
+ * @ingroup frontend
*/
#define DTV_USER_COMMAND_START 256
@@ -105,7 +121,9 @@
#define DTV_USER_NAME_SIZE (1 + DTV_MAX_USER_COMMAND - DTV_USER_COMMAND_START)
/**
- * enum dvb_sat_polarization - Polarization types for Satellite systems
+ * @enum dvb_sat_polarization
+ * @brief Polarization types for Satellite systems
+ * @ingroup satellite
*
* @param POLARIZATION_OFF Polarization disabled/unused.
* @param POLARIZATION_H Horizontal polarization
@@ -132,34 +150,44 @@ enum dvb_sat_polarization {
/**
* @def DTV_STAT_COMMAND_START
- * @brief Start number for libdvbv5 statistics commands
+ * @brief Start number for libdvbv5 statistics commands
+ * @ingroup frontend
* @def DTV_STATUS
* @brief Lock status of a DTV frontend. This actually comes from
* the Kernel, but it uses a separate ioctl.
+ * @ingroup frontend
* @def DTV_BER
* @brief Bit Error Rate. This is a parameter that it is
* derivated from two counters at the Kernel side
+ * @ingroup frontend
* @def DTV_PER
* @brief Packet Error Rate. This is a parameter that it is
* derivated from two counters at the Kernel side
+ * @ingroup frontend
* @def DTV_QUALITY
* @brief A quality indicator that represents if a locked
* channel provides a good, OK or poor signal. This is
* estimated considering the error rates, signal strengh
* and/or S/N ratio of the carrier.
+ * @ingroup frontend
* @def DTV_PRE_BER
* @brief Bit Error Rate before Viterbi. This is the error rate
* before applying the Forward Error Correction. This is
* a parameter that it is derivated from two counters
* at the Kernel side.
+ * @ingroup frontend
* @def DTV_MAX_STAT_COMMAND
- * @brief Last statistics command
+ * @brief Last statistics command
+ * @ingroup frontend
* @def DTV_STAT_NAME_SIZE
- * @brief Number of statistics commands
+ * @brief Number of statistics commands
+ * @ingroup frontend
* @def DTV_NUM_KERNEL_STATS
* @brief Number of statistics commands provided by the Kernel
+ * @ingroup frontend
* @def DTV_NUM_STATS_PROPS
* @brief Total number of statistics commands
+ * @ingroup frontend
*/
#define DTV_STAT_COMMAND_START 512
@@ -180,8 +208,10 @@ enum dvb_sat_polarization {
#define DTV_NUM_STATS_PROPS (DTV_NUM_KERNEL_STATS + DTV_STAT_NAME_SIZE)
/**
- * enum dvb_quality - provides an estimation about the user's experience
- * while watching to a given MPEG stream
+ * @enum dvb_quality
+ * @brief Provides an estimation about the user's experience
+ * while watching to a given MPEG stream
+ * @ingroup frontend
*
* @param DVB_QUAL_UNKNOWN Quality could not be estimated, as the Kernel driver
* doesn't provide enough statistics
diff --git a/lib/include/libdvbv5/eit.h b/lib/include/libdvbv5/eit.h
index 30bd0fac..04b34e2d 100644
--- a/lib/include/libdvbv5/eit.h
+++ b/lib/include/libdvbv5/eit.h
@@ -21,6 +21,7 @@
/**
* @file eit.h
+ * @ingroup dvb_table
* @brief Provides the table parser for the DVB EIT (Event Information Table)
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -49,14 +50,19 @@
/**
* @def DVB_TABLE_EIT
* @brief DVB EIT table ID for the actual TS
+ * @ingroup dvb_table
* @def DVB_TABLE_EIT_OTHER
* @brief DVB EIT table ID for other TS
+ * @ingroup dvb_table
* @def DVB_TABLE_EIT_PID
* @brief DVB EIT Program ID
+ * @ingroup dvb_table
* @def DVB_TABLE_EIT_SCHEDULE
* @brief Start table ID for the DVB EIT schedule data on the actual TS
+ * @ingroup dvb_table
* @def DVB_TABLE_EIT_SCHEDULE_OTHER
* @brief Start table ID for the DVB EIT schedule data on other TS
+ * @ingroup dvb_table
*/
#define DVB_TABLE_EIT 0x4E
#define DVB_TABLE_EIT_OTHER 0x4F
@@ -68,6 +74,7 @@
/**
* @struct dvb_table_eit_event
* @brief DVB EIT event table
+ * @ingroup dvb_table
*
* @param event_id an uniquelly (inside a service ID) event ID
* @param desc_length descriptor's length
@@ -119,6 +126,7 @@ struct dvb_table_eit_event {
/**
* @struct dvb_table_eit
* @brief DVB EIT table
+ * @ingroup dvb_table
*
* @param header struct dvb_table_header content
* @param transport_id transport id
@@ -145,6 +153,7 @@ struct dvb_table_eit {
/**
* @brief Macro used to find event on a DVB EIT table
+ * @ingroup dvb_table
*
* @param _event event to seek
* @param _eit pointer to struct dvb_table_eit_event
@@ -163,6 +172,7 @@ extern "C" {
/**
* @brief Initializes and parses EIT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param buf buffer containing the EIT raw data
@@ -181,6 +191,7 @@ ssize_t dvb_table_eit_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf,
/**
* @brief Frees all data allocated by the DVB EIT table parser
+ * @ingroup dvb_table
*
* @param table pointer to struct dvb_table_eit to be freed
*/
@@ -188,6 +199,7 @@ void dvb_table_eit_free(struct dvb_table_eit *table);
/**
* @brief Prints the content of the DVB EIT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param table pointer to struct dvb_table_eit
@@ -197,6 +209,7 @@ void dvb_table_eit_print(struct dvb_v5_fe_parms *parms,
/**
* @brief Converts a DVB EIT formatted timestamp into struct tm
+ * @ingroup dvb_table
*
* @param data event on DVB EIT time format
* @param tm pointer to struct tm where the converted timestamp will
diff --git a/lib/include/libdvbv5/header.h b/lib/include/libdvbv5/header.h
index 53efab22..cb528e66 100644
--- a/lib/include/libdvbv5/header.h
+++ b/lib/include/libdvbv5/header.h
@@ -28,6 +28,7 @@
/**
* @file header.h
+ * @ingroup dvb_table
* @brief Provides the MPEG TS table headers
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -40,6 +41,7 @@
/**
* @struct dvb_ts_packet_header
* @brief Header of a MPEG-TS transport packet
+ * @ingroup dvb_table
*
* @param sync_byte sync byte
* @param pid Program ID
@@ -75,6 +77,7 @@ struct dvb_ts_packet_header {
/**
* @struct dvb_table_header
* @brief Header of a MPEG-TS table
+ * @ingroup dvb_table
*
* @param table_id table id
* @param section_length section length
@@ -115,12 +118,14 @@ extern "C" {
/**
* @brief Initializes and parses MPEG-TS table header
+ * @ingroup dvb_table
*
* @param header pointer to struct dvb_table_header to be parsed
*/
void dvb_table_header_init (struct dvb_table_header *header);
/**
* @brief Prints the content of the MPEG-TS table header
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param header pointer to struct dvb_table_header to be printed
diff --git a/lib/include/libdvbv5/mgt.h b/lib/include/libdvbv5/mgt.h
index 218d23c4..c2dece01 100644
--- a/lib/include/libdvbv5/mgt.h
+++ b/lib/include/libdvbv5/mgt.h
@@ -20,6 +20,7 @@
/**
* @file mgt.h
+ * @ingroup dvb_table
* @brief Provides the table parser for the ATSC MGT (Master Guide Table)
* @copyright GNU General Public License version 2 (GPLv2)
* @author Andre Roth
@@ -46,12 +47,14 @@
/**
* @def ATSC_TABLE_MGT
* @brief ATSC MGT table ID
+ * @ingroup dvb_table
*/
#define ATSC_TABLE_MGT 0xC7
/**
* @struct atsc_table_mgt_table
* @brief ATSC tables descrition at MGT table
+ * @ingroup dvb_table
*
* @param type table type
* @param pid table type pid
@@ -98,6 +101,7 @@ struct atsc_table_mgt_table {
/**
* @struct atsc_table_mgt
* @brief ATSC MGT table
+ * @ingroup dvb_table
*
* @param header struct dvb_table_header content
* @param protocol_version protocol version
@@ -141,6 +145,7 @@ extern "C" {
/**
* @brief Initializes and parses MGT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param buf buffer containing the MGT raw data
@@ -159,6 +164,7 @@ ssize_t atsc_table_mgt_init(struct dvb_v5_fe_parms *parms, const uint8_t *buf,
/**
* @brief Frees all data allocated by the MGT table parser
+ * @ingroup dvb_table
*
* @param table pointer to struct atsc_table_mgt to be freed
*/
@@ -166,6 +172,7 @@ void atsc_table_mgt_free(struct atsc_table_mgt *table);
/**
* @brief Prints the content of the MGT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param table pointer to struct atsc_table_mgt
diff --git a/lib/include/libdvbv5/nit.h b/lib/include/libdvbv5/nit.h
index 38562c67..be5d1cfc 100644
--- a/lib/include/libdvbv5/nit.h
+++ b/lib/include/libdvbv5/nit.h
@@ -30,6 +30,7 @@
/**
* @file nit.h
+ * @ingroup dvb_table
* @brief Provides the descriptors for NIT MPEG-TS table
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -50,10 +51,13 @@
/**
* @def DVB_TABLE_NIT
* @brief NIT table ID
+ * @ingroup dvb_table
* @def DVB_TABLE_NIT2
* @brief NIT table ID (alternative table ID)
+ * @ingroup dvb_table
* @def DVB_TABLE_NIT_PID
* @brief NIT Program ID
+ * @ingroup dvb_table
*/
#define DVB_TABLE_NIT 0x40
#define DVB_TABLE_NIT2 0x41
@@ -62,6 +66,7 @@
/**
* @union dvb_table_nit_transport_header
* @brief MPEG-TS NIT transport header
+ * @ingroup dvb_table
*
* @param transport_length transport length
*
@@ -83,6 +88,7 @@ union dvb_table_nit_transport_header {
/**
* @struct dvb_table_nit_transport
* @brief MPEG-TS NIT transport table
+ * @ingroup dvb_table
*
* @param transport_id transport id
* @param network_id network id
@@ -118,6 +124,7 @@ struct dvb_table_nit_transport {
/**
* @struct dvb_table_nit
* @brief MPEG-TS NIT table
+ * @ingroup dvb_table
*
* @param header struct dvb_table_header content
* @param desc_length descriptor length
@@ -149,6 +156,7 @@ struct dvb_table_nit {
/**
* @brief typedef for a callback used when a NIT table entry is found
+ * @ingroup dvb_table
*
* @param nit a struct dvb_table_nit pointer
* @param desc a struct dvb_desc pointer
@@ -160,6 +168,7 @@ typedef void nit_handler_callback_t(struct dvb_table_nit *nit,
/**
* @brief typedef for a callback used when a NIT transport table entry is found
+ * @ingroup dvb_table
*
* @param nit a struct dvb_table_nit pointer
* @param tran a struct dvb_table_nit_transport pointer
@@ -173,6 +182,7 @@ typedef void nit_tran_handler_callback_t(struct dvb_table_nit *nit,
/**
* @brief Macro used to find a transport inside a NIT table
+ * @ingroup dvb_table
*
* @param _tran transport to seek
* @param _nit pointer to struct dvb_table_nit_transport
@@ -188,6 +198,7 @@ extern "C" {
/**
* @brief Initializes and parses NIT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param buf buffer containing the NIT raw data
@@ -206,6 +217,7 @@ ssize_t dvb_table_nit_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf,
/**
* @brief Frees all data allocated by the NIT table parser
+ * @ingroup dvb_table
*
* @param table pointer to struct dvb_table_nit to be freed
*/
@@ -213,6 +225,7 @@ void dvb_table_nit_free(struct dvb_table_nit *table);
/**
* @brief Prints the content of the NIT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param table pointer to struct dvb_table_nit
@@ -221,6 +234,7 @@ void dvb_table_nit_print(struct dvb_v5_fe_parms *parms, struct dvb_table_nit *ta
/**
* @brief For each entry at NIT and NIT transport tables, call a callback
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param table pointer to struct dvb_table_nit
diff --git a/lib/include/libdvbv5/pat.h b/lib/include/libdvbv5/pat.h
index 6eb96d84..c12f123b 100644
--- a/lib/include/libdvbv5/pat.h
+++ b/lib/include/libdvbv5/pat.h
@@ -21,6 +21,7 @@
/**
* @file pat.h
+ * @ingroup dvb_table
* @brief Provides the descriptors for PAT MPEG-TS table
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -47,8 +48,10 @@
/**
* @def DVB_TABLE_PAT
* @brief PAT table ID
+ * @ingroup dvb_table
* @def DVB_TABLE_PAT_PID
* @brief PAT Program ID
+ * @ingroup dvb_table
*/
#define DVB_TABLE_PAT 0x00
#define DVB_TABLE_PAT_PID 0x0000
@@ -56,6 +59,7 @@
/**
* @struct dvb_table_pat_program
* @brief MPEG-TS PAT program table
+ * @ingroup dvb_table
*
* @param service_id service id
* @param pid pid
@@ -86,6 +90,7 @@ struct dvb_table_pat_program {
/**
* @struct dvb_table_pat
* @brief MPEG-TS PAT table
+ * @ingroup dvb_table
*
* @param header struct dvb_table_header content
* @param programs number of programs
@@ -109,6 +114,7 @@ struct dvb_table_pat {
/**
* @brief Macro used to find programs on a PAT table
+ * @ingroup dvb_table
*
* @param _pgm program to seek
* @param _pat pointer to struct dvb_table_pat_program
@@ -124,6 +130,7 @@ extern "C" {
/**
* @brief Initializes and parses PAT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param buf buffer containing the PAT raw data
@@ -142,6 +149,7 @@ ssize_t dvb_table_pat_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf,
/**
* @brief Frees all data allocated by the PAT table parser
+ * @ingroup dvb_table
*
* @param table pointer to struct dvb_table_pat to be freed
*/
@@ -149,6 +157,7 @@ void dvb_table_pat_free(struct dvb_table_pat *table);
/**
* @brief Prints the content of the PAT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param table pointer to struct dvb_table_pat
diff --git a/lib/include/libdvbv5/pmt.h b/lib/include/libdvbv5/pmt.h
index dc4ea734..e043b71c 100644
--- a/lib/include/libdvbv5/pmt.h
+++ b/lib/include/libdvbv5/pmt.h
@@ -21,6 +21,7 @@
/**
* @file pmt.h
+ * @ingroup dvb_table
* @brief Provides the descriptors for PMT MPEG-TS table
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -47,12 +48,14 @@
/**
* @def DVB_TABLE_PMT
* @brief PMT table ID
+ * @ingroup dvb_table
*/
#define DVB_TABLE_PMT 0x02
/**
* @enum dvb_streams
- * @brief Add support for MPEG-TS Stream types
+ * @brief Add support for MPEG-TS Stream types
+ * @ingroup dvb_table
*
* @var stream_reserved0
* @brief ITU-T | ISO/IEC Reserved
@@ -129,12 +132,14 @@ enum dvb_streams {
/**
* @brief Converts from enum dvb_streams into a string
+ * @ingroup dvb_table
*/
extern const char *pmt_stream_name[];
/**
* @struct dvb_table_pmt_stream
* @brief MPEG-TS PMT stream table
+ * @ingroup dvb_table
*
* @param type stream type
* @param elementary_pid elementary pid
@@ -178,7 +183,8 @@ struct dvb_table_pmt_stream {
/**
* @struct dvb_table_pmt
* @brief MPEG-TS PMT table
- *
+ * @ingroup dvb_table
+ *
* @param header struct dvb_table_header content
* @param pcr_pid PCR PID
* @param desc_length descriptor length
@@ -225,6 +231,7 @@ struct dvb_table_pmt {
/**
* @brief Macro used to find streams on a PMT table
+ * @ingroup dvb_table
*
* @param _stream stream to seek
* @param _pmt pointer to struct dvb_table_pmt_stream
@@ -240,6 +247,7 @@ extern "C" {
/**
* @brief Initializes and parses PMT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param buf buffer containing the PMT raw data
@@ -258,6 +266,7 @@ ssize_t dvb_table_pmt_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf,
/**
* @brief Frees all data allocated by the PMT table parser
+ * @ingroup dvb_table
*
* @param table pointer to struct dvb_table_pmt to be freed
*/
@@ -265,6 +274,7 @@ void dvb_table_pmt_free(struct dvb_table_pmt *table);
/**
* @brief Prints the content of the PAT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param table pointer to struct dvb_table_pmt
diff --git a/lib/include/libdvbv5/sdt.h b/lib/include/libdvbv5/sdt.h
index 5a85dbc6..e54683ab 100644
--- a/lib/include/libdvbv5/sdt.h
+++ b/lib/include/libdvbv5/sdt.h
@@ -24,6 +24,7 @@
/**
* @file sdt.h
+ * @ingroup dvb_table
* @brief Provides the descriptors for SDT MPEG-TS table
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -47,10 +48,13 @@
/**
* @def DVB_TABLE_SDT
* @brief SDT table ID
+ * @ingroup dvb_table
* @def DVB_TABLE_SDT2
* @brief SDT table ID (alternative table ID)
+ * @ingroup dvb_table
* @def DVB_TABLE_SDT_PID
* @brief SDT Program ID
+ * @ingroup dvb_table
*/
#define DVB_TABLE_SDT 0x42
#define DVB_TABLE_SDT2 0x46
@@ -59,6 +63,7 @@
/**
* @struct dvb_table_sdt_service
* @brief MPEG-TS SDT service table
+ * @ingroup dvb_table
*
* @param service_id service id
* @param EIT_present_following EIT present following
@@ -100,6 +105,7 @@ struct dvb_table_sdt_service {
/**
* @struct dvb_table_sdt
* @brief MPEG-TS SDT table
+ * @ingroup dvb_table
*
* @param header struct dvb_table_header content
* @param network_id network id
@@ -124,6 +130,7 @@ struct dvb_table_sdt {
/**
* @brief Macro used to find services on a SDT table
+ * @ingroup dvb_table
*
* @param _service service to seek
* @param _sdt pointer to struct dvb_table_sdt_service
@@ -139,6 +146,7 @@ extern "C" {
/**
* @brief Initializes and parses SDT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param buf buffer containing the SDT raw data
@@ -157,6 +165,7 @@ ssize_t dvb_table_sdt_init (struct dvb_v5_fe_parms *parms, const uint8_t *buf,
/**
* @brief Frees all data allocated by the SDT table parser
+ * @ingroup dvb_table
*
* @param table pointer to struct dvb_table_sdt to be freed
*/
@@ -164,6 +173,7 @@ void dvb_table_sdt_free(struct dvb_table_sdt *table);
/**
* @brief Prints the content of the SDT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param table pointer to struct dvb_table_sdt
diff --git a/lib/include/libdvbv5/vct.h b/lib/include/libdvbv5/vct.h
index 98e7b786..b79e1325 100644
--- a/lib/include/libdvbv5/vct.h
+++ b/lib/include/libdvbv5/vct.h
@@ -21,6 +21,7 @@
/**
* @file vct.h
+ * @ingroup dvb_table
* @brief Provides the descriptors for TVCT and CVCT tables
* @copyright GNU General Public License version 2 (GPLv2)
* @author Mauro Carvalho Chehab
@@ -48,10 +49,13 @@
/**
* @def ATSC_TABLE_TVCT
* @brief TVCT table ID
+ * @ingroup dvb_table
* @def ATSC_TABLE_CVCT
* @brief CVCT table ID
+ * @ingroup dvb_table
* @def ATSC_TABLE_VCT_PID
* @brief Program ID with the VCT tables on it
+ * @ingroup dvb_table
*/
#define ATSC_TABLE_TVCT 0xc8
#define ATSC_TABLE_CVCT 0xc9
@@ -60,6 +64,7 @@
/**
* @struct atsc_table_vct_channel
* @brief ATSC VCT channel table (covers both CVCT and TVCT)
+ * @ingroup dvb_table
*
* @param modulation_mode modulation mode
* @param minor_channel_number minor channel number
@@ -150,6 +155,7 @@ struct atsc_table_vct_channel {
/**
* @struct atsc_table_vct
* @brief ATSC VCT table (covers both CVCT and TVCT)
+ * @ingroup dvb_table
*
* @param header struct dvb_table_header content
* @param protocol_version protocol version
@@ -173,6 +179,7 @@ struct atsc_table_vct {
/**
* @union atsc_table_vct_descriptor_length
* @brief ATSC VCT descriptor length
+ * @ingroup dvb_table
*
* @param descriptor_length descriptor length
*
@@ -188,6 +195,7 @@ union atsc_table_vct_descriptor_length {
/**
* @brief Macro used to find channels on a VCT table
+ * @ingroup dvb_table
*
* @param _channel channel to seek
* @param _vct pointer to struct atsc_table_vct_channel
@@ -203,6 +211,7 @@ extern "C" {
/**
* @brief Initializes and parses VCT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param buf buffer containing the VCT raw data
@@ -220,12 +229,14 @@ ssize_t atsc_table_vct_init(struct dvb_v5_fe_parms *parms, const uint8_t *buf,
ssize_t buflen, struct atsc_table_vct **table);
/**
* @brief Frees all data allocated by the VCT table parser
+ * @ingroup dvb_table
*
* @param table pointer to struct atsc_table_vct to be freed
*/
void atsc_table_vct_free(struct atsc_table_vct *table);
/**
* @brief Prints the content of the VCT table
+ * @ingroup dvb_table
*
* @param parms struct dvb_v5_fe_parms pointer to the opened device
* @param table pointer to struct atsc_table_vct

Privacy Policy