From fccce9b760ecca78aa3eb6765a7c37417559b845 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Thu, 11 Sep 2014 21:26:09 -0300 Subject: [PATCH] libdvbv5 documentation review General cleanup at the libdvbv5 documentation, in order to fix some minor issues. Signed-off-by: Mauro Carvalho Chehab --- lib/include/libdvbv5/atsc_eit.h | 12 ++-- lib/include/libdvbv5/atsc_header.h | 2 + lib/include/libdvbv5/cat.h | 2 +- lib/include/libdvbv5/crc32.h | 8 ++- lib/include/libdvbv5/descriptors.h | 49 ++++++++++---- lib/include/libdvbv5/dvb-demux.h | 11 ---- lib/include/libdvbv5/dvb-fe.h | 122 ++++++++++++++++++----------------- lib/include/libdvbv5/dvb-file.h | 127 ++++++++++++++++++++----------------- lib/include/libdvbv5/dvb-log.h | 3 + lib/include/libdvbv5/dvb-sat.h | 13 ++-- lib/include/libdvbv5/dvb-scan.h | 59 +++++++++-------- lib/include/libdvbv5/eit.h | 7 +- lib/include/libdvbv5/header.h | 3 - lib/include/libdvbv5/mgt.h | 2 +- lib/include/libdvbv5/nit.h | 21 +++--- lib/include/libdvbv5/pat.h | 15 +++-- lib/include/libdvbv5/pmt.h | 17 ++--- lib/include/libdvbv5/sdt.h | 19 +++--- lib/include/libdvbv5/vct.h | 5 +- 19 files changed, 273 insertions(+), 224 deletions(-) diff --git a/lib/include/libdvbv5/atsc_eit.h b/lib/include/libdvbv5/atsc_eit.h index 2be3578..8029ac9 100644 --- a/lib/include/libdvbv5/atsc_eit.h +++ b/lib/include/libdvbv5/atsc_eit.h @@ -56,15 +56,13 @@ * @brief ATSC EIT event table * * @param event_id an uniquelly (inside a service ID) event ID - * @param one Always '1' * @param title_length title length. Zero means no title * @param duration duration in seconds * @param etm Extended Text Message location - * @param one2 Always '1' - * @param descriptor pointer to struct descriptor - * @param next pointer to struct next - * @param source_id source id (obtained from ATSC header) + * @param descriptor pointer to struct dvb_desc + * @param next pointer to struct atsc_table_eit_event * @param start event start (in struct tm format) + * @param source_id source id (obtained from ATSC header) * * This structure is used to store the original ATSC EIT event table, * converting the integer fields to the CPU endianness, and converting the @@ -132,7 +130,7 @@ union atsc_table_eit_desc_length { * @param header struct dvb_table_header content * @param protocol_version protocol version * @param events events - * @param event pointer to struct event + * @param event pointer to struct atsc_table_eit_event * * This structure is used to store the original ATSC EIT table, * converting the integer fields to the CPU endianness. @@ -192,7 +190,7 @@ void atsc_table_eit_free(struct atsc_table_eit *table); * @brief Prints the content of the ATSC EIT table * * @param parms struct dvb_v5_fe_parms pointer to the opened device - * @param table pointe to struct atsc_table_eit + * @param table pointer to struct atsc_table_eit */ void atsc_table_eit_print(struct dvb_v5_fe_parms *parms, struct atsc_table_eit *table); diff --git a/lib/include/libdvbv5/atsc_header.h b/lib/include/libdvbv5/atsc_header.h index 2c57d80..773067f 100644 --- a/lib/include/libdvbv5/atsc_header.h +++ b/lib/include/libdvbv5/atsc_header.h @@ -43,6 +43,8 @@ #define ATSC_BASE_PID 0x1FFB #ifndef _DOXYGEN + +/* Deprecated, as it causes troubles with doxygen */ #define ATSC_HEADER() \ struct dvb_table_header header; \ uint8_t protocol_version; \ diff --git a/lib/include/libdvbv5/cat.h b/lib/include/libdvbv5/cat.h index 0b3375f..c78a412 100644 --- a/lib/include/libdvbv5/cat.h +++ b/lib/include/libdvbv5/cat.h @@ -92,7 +92,7 @@ void dvb_table_cat_free(struct dvb_table_cat *table); * @brief Prints the content of the CAT table * * @param parms struct dvb_v5_fe_parms pointer to the opened device - * @param table pointe to struct dvb_table_cat + * @param table pointer to struct dvb_table_cat */ void dvb_table_cat_print(struct dvb_v5_fe_parms *parms, struct dvb_table_cat *table); diff --git a/lib/include/libdvbv5/crc32.h b/lib/include/libdvbv5/crc32.h index a533f4e..08bfe4b 100644 --- a/lib/include/libdvbv5/crc32.h +++ b/lib/include/libdvbv5/crc32.h @@ -40,7 +40,13 @@ extern "C" { #endif -/** @brief Calculates the crc-32 as defined at the MPEG-TS specs */ +/** @brief Calculates the crc-32 as defined at the MPEG-TS specs + * + * @param data Pointer to the buffer to be checked + * @param datalen Length of the buffer + * @param crc Initial value for the crc checksum. To calculate the + * checksum of the entire packet at once, use 0xFFFFFFFF + */ uint32_t dvb_crc32(uint8_t *data, size_t datalen, uint32_t crc); #ifdef __cplusplus diff --git a/lib/include/libdvbv5/descriptors.h b/lib/include/libdvbv5/descriptors.h index 4f8b1d1..cdc1ec9 100644 --- a/lib/include/libdvbv5/descriptors.h +++ b/lib/include/libdvbv5/descriptors.h @@ -59,8 +59,19 @@ struct dvb_v5_fe_parms; #endif -/** @brief Function prototype for a function that initializes the descriptors parsing */ -typedef void (*dvb_table_init_func)(struct dvb_v5_fe_parms *parms, const uint8_t *buf, ssize_t buflen, void **table); +/** + * @brief Function prototype for a function that initializes the + * descriptors parsing on a table + * + * @param parms Struct dvb_v5_fe_parms pointer + * @param buf Buffer with data to be parsed + * @param buflen Size of the buffer to be parsed + * @param table pointer to a place where the allocated memory with the + * table structure will be stored. + */ +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 */ extern const dvb_table_init_func dvb_table_initializers[256]; @@ -89,10 +100,9 @@ extern const dvb_table_init_func dvb_table_initializers[256]; * * @param type Descriptor type * @param length Length of the descriptor - * @param next pointer to the next descriptor + * @param next pointer to the dvb_desc descriptor * @param data Descriptor data */ - struct dvb_desc { uint8_t type; uint8_t length; @@ -126,7 +136,7 @@ uint32_t dvb_bcd(uint32_t bcd); /** * @brief dumps data into the logs in hexadecimal format * - * @param parms Struct dvb_v5_fe_parms pointer + * @param parms Struct dvb_v5_fe_parms pointer * @param prefix String to be printed before the dvb_hexdump * @param buf Buffer to hex dump * @param len Number of bytes to show @@ -168,7 +178,7 @@ void dvb_desc_free (struct dvb_desc **list); * @brief prints the contents of a struct dvb_desc linked list * * @param parms Struct dvb_v5_fe_parms pointer - * @param desc struct dvb_desc pointer. + * @param desc struct dvb_desc pointer. */ void dvb_desc_print(struct dvb_v5_fe_parms *parms, struct dvb_desc *desc); @@ -176,13 +186,30 @@ void dvb_desc_print(struct dvb_v5_fe_parms *parms, struct dvb_desc *desc); } #endif -/** @brief Function prototype for the descriptors parsing init code */ -typedef int (*dvb_desc_init_func) (struct dvb_v5_fe_parms *parms, const uint8_t *buf, struct dvb_desc *desc); +/** + * @brief Function prototype for the descriptors parsing init code + * + * @param parms Struct dvb_v5_fe_parms pointer + * @param buf buffer with the content of the descriptor + * @param desc struct dvb_desc pointer + */ +typedef int (*dvb_desc_init_func) (struct dvb_v5_fe_parms *parms, + const uint8_t *buf, struct dvb_desc *desc); -/** @brief Function prototype for the descriptors parsing print code */ -typedef void (*dvb_desc_print_func)(struct dvb_v5_fe_parms *parms, const struct dvb_desc *desc); +/** + * @brief Function prototype for the descriptors parsing print code + * + * @param parms Struct dvb_v5_fe_parms pointer + * @param desc struct dvb_desc pointer + */ +typedef void (*dvb_desc_print_func)(struct dvb_v5_fe_parms *parms, + const struct dvb_desc *desc); -/** @brief Function prototype for the descriptors memory free code */ +/** + * @brief Function prototype for the descriptors memory free code + * + * @param desc pointer to struct dvb_desc pointer to be freed + */ typedef void (*dvb_desc_free_func) (struct dvb_desc *desc); /** diff --git a/lib/include/libdvbv5/dvb-demux.h b/lib/include/libdvbv5/dvb-demux.h index 6badac4..97fec91 100644 --- a/lib/include/libdvbv5/dvb-demux.h +++ b/lib/include/libdvbv5/dvb-demux.h @@ -40,7 +40,6 @@ extern "C" { #endif /** - * @fn int dvb_dmx_open(int adapter, int demux) * @brief Opens a DVB demux in read/write mode * * @param adapter DVB adapter number to open @@ -53,7 +52,6 @@ extern "C" { int dvb_dmx_open(int adapter, int demux); /** - * @fn void dvb_dmx_close(int dmx_fd) * @brief Stops the DMX filter for the file descriptor and closes * * @param dmx_fd File descriptor to close @@ -73,8 +71,6 @@ void dvb_dmx_close(int dmx_fd); void dvb_dmx_stop(int dmx_fd); /** - * @fn int dvb_set_pesfilter(int dmxfd, int pid, dmx_pes_type_t type, - * dmx_output_t output, int buffersize) * @brief Start a filter for a MPEG-TS Packetized Elementary * Stream (PES) * @@ -96,12 +92,6 @@ int dvb_set_pesfilter(int dmxfd, int pid, dmx_pes_type_t type, dmx_output_t output, int buffersize); /** - * @fn int dvb_set_section_filter(int dmxfd, int pid, unsigned filtsize, - * unsigned char *filter, - * unsigned char *mask, - * unsigned char *mode, - * unsigned int flags) - * @brief Sets a MPEG-TS section filter * * @param dmxfd File descriptor for the demux device @@ -126,7 +116,6 @@ int dvb_set_section_filter(int dmxfd, int pid, unsigned filtsize, unsigned int flags); /** - * @fn int dvb_get_pmt_pid(int dmxfd, int sid) * @brief read the contents of the MPEG-TS PAT table, seeking for * an specific service ID * diff --git a/lib/include/libdvbv5/dvb-fe.h b/lib/include/libdvbv5/dvb-fe.h index 8a39c07..e8e9318 100644 --- a/lib/include/libdvbv5/dvb-fe.h +++ b/lib/include/libdvbv5/dvb-fe.h @@ -85,25 +85,25 @@ * @struct dvb_v5_fe_parms * @brief Keeps data needed to handle the DVB frontend * - * @param info Contains the DVB info properties (RO) + * @param info Contains the DVB info properties (RO) * @param version Version of the Linux DVB API (RO) - * @param has_v5_stats a value different than 0 indicates that the frontend - * supports DVBv5 stats (RO) - * @param current_sys currently selected delivery system (RO) - * @param num_systems number of delivery systems (RO) - * @param systems delivery systems supported by the hardware (RO) - * @param legacy_fe a value different than 0 indicates a legacy Kernel - * driver using DVBv3 API only, or that DVBv3 only mode - * was forced by the client (RO) - * @param abort Client should set it to abort a pending operation - * like DTV scan (RW) - * @param lna: sets the LNA mode 0 disables; 1 enables, -1 uses - * auto mode (RW) - * @param lnb LNBf description (RW) - * @param sat_number number of the satellite (used by DISEqC setup) (RW) + * @param has_v5_stats A value different than 0 indicates that the + * frontend supports DVBv5 stats (RO) + * @param current_sys Currently selected delivery system (RO) + * @param num_systems Number of delivery systems (RO) + * @param systems Delivery systems supported by the hardware (RO) + * @param legacy_fe A value different than 0 indicates a legacy + * Kernel driver using DVBv3 API only, or that + * DVBv3 only mode was forced by the client (RO) + * @param abort Client should set it to abort a pending + * operation like DTV scan (RW) + * @param lna: Sets the LNA mode 0 disables; 1 enables, -1 uses + * auto mode (RW) + * @param lnb LNBf description (RW) + * @param sat_number Number of the satellite (used by DISEqC setup) (RW) * @param freq_bpf SCR/Unicable band-pass filter frequency to use, in kHz * @param verbose Verbosity level of the library (RW) - * @param dvb_logfunc Function used to write log messages (RO) + * @param dvb_logfunc Function used to write log messages (RO) * @param default_charset Name of the charset used by the DVB standard (RW) * @param output_charset Name of the charset to output (system specific) (RW) * @@ -149,7 +149,6 @@ extern "C" { #endif /** - * @fn struct dvb_v5_fe_parms *dvb_fe_dummy(void) * @brief Allocates a dummy frontend structure * * @details This is useful for some applications that may want to just use the @@ -160,8 +159,6 @@ extern "C" { struct dvb_v5_fe_parms *dvb_fe_dummy(void); /** - * @fn struct dvb_v5_fe_parms *dvb_fe_open(int adapter, int frontend, - * unsigned verbose, unsigned use_legacy_call) * @brief Opens a frontend and allocates a structure to work with * * @param adapter Number of the adapter to open @@ -180,9 +177,6 @@ struct dvb_v5_fe_parms *dvb_fe_open(int adapter, int frontend, unsigned verbose, unsigned use_legacy_call); /** - * @fn struct dvb_v5_fe_parms *dvb_fe_open2(int adapter, int frontend, - * unsigned verbose, unsigned use_legacy_call, - * dvb_logfunc logfunc) * @brief Opens a frontend and allocates a structure to work with * * @param adapter Number of the adapter to open @@ -205,13 +199,13 @@ struct dvb_v5_fe_parms *dvb_fe_open2(int adapter, int frontend, dvb_logfunc logfunc); /** - * @fn void dvb_fe_close(struct dvb_v5_fe_parms *parms) * @brief Closes the frontend and frees allocated resources + * + * @param parms struct dvb_v5_fe_parms pointer to the opened device */ void dvb_fe_close(struct dvb_v5_fe_parms *parms); /** - * @fn const char *dvb_cmd_name(int cmd) * @brief Returns the string name associated with a DVBv5 command * * @param cmd DVBv5 or libdvbv5 property @@ -227,7 +221,6 @@ void dvb_fe_close(struct dvb_v5_fe_parms *parms); const char *dvb_cmd_name(int cmd); /** - * @fn const char *const *dvb_attr_names(int cmd) * @brief Returns an string array with the valid string values associated with a DVBv5 command * * @param cmd DVBv5 or libdvbv5 property @@ -238,15 +231,13 @@ const char *dvb_cmd_name(int cmd); * dvb_cmd_name(DTV_CODE_RATE_HP) would return an array with the * possible values for the code rates: * { "1/2", "2/3", ... NULL } - * @note: The array always ends with NULL. + * @note The array always ends with NULL. */ const char *const *dvb_attr_names(int cmd); /* Get/set delivery system parameters */ /** - * @fn int dvb_fe_retrieve_parm(const struct dvb_v5_fe_parms *parms, - * unsigned cmd, uint32_t *value) * @brief Retrieves the value of a DVBv5/libdvbv5 property * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -262,8 +253,6 @@ int dvb_fe_retrieve_parm(const struct dvb_v5_fe_parms *parms, unsigned cmd, uint32_t *value); /** - * @fn int dvb_fe_store_parm(struct dvb_v5_fe_parms *parms, - * unsigned cmd, uint32_t value) * @brief Stores the value of a DVBv5/libdvbv5 property * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -279,8 +268,6 @@ int dvb_fe_store_parm(struct dvb_v5_fe_parms *parms, unsigned cmd, uint32_t value); /** - * @fn int dvb_set_sys(struct dvb_v5_fe_parms *parms, - * fe_delivery_system_t sys) * @brief Sets the delivery system * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -298,8 +285,6 @@ int dvb_set_sys(struct dvb_v5_fe_parms *parms, fe_delivery_system_t sys); /** - * @fn int dvb_add_parms_for_sys(struct dvb_v5_fe_parms *parms, - fe_delivery_system_t sys) * @brief Make dvb properties reflect the current standard * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -316,8 +301,6 @@ int dvb_add_parms_for_sys(struct dvb_v5_fe_parms *parms, fe_delivery_system_t sys); /** - * @fn int dvb_set_compat_delivery_system(struct dvb_v5_fe_parms *parms, - * uint32_t desired_system) * @brief Sets the delivery system * * @param parms struct dvb_v5_fe_parms pointer to the opened @@ -330,8 +313,8 @@ int dvb_add_parms_for_sys(struct dvb_v5_fe_parms *parms, * able to store the properties for the new delivery system via * dvb_fe_store_parm(). * - * This function is an enhanced version of dvb_set_sys(): it has an special - * logic inside to work with Kernels that supports onld DVBv3. + * This function is an enhanced version of dvb_set_sys(). It has an special + * logic inside to work with Kernels that supports only DVBv3. * * @return Return 0 if success, EINVAL otherwise. */ @@ -339,7 +322,6 @@ int dvb_set_compat_delivery_system(struct dvb_v5_fe_parms *parms, uint32_t desired_system); /** - * @fn void dvb_fe_prt_parms(const struct dvb_v5_fe_parms *parms) * @brief Prints all the properties at the cache * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -349,7 +331,6 @@ int dvb_set_compat_delivery_system(struct dvb_v5_fe_parms *parms, void dvb_fe_prt_parms(const struct dvb_v5_fe_parms *parms); /** - * @fn int dvb_fe_set_parms(struct dvb_v5_fe_parms *parms) * @brief Prints all the properties at the cache * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -363,7 +344,6 @@ void dvb_fe_prt_parms(const struct dvb_v5_fe_parms *parms); int dvb_fe_set_parms(struct dvb_v5_fe_parms *parms); /** - * @fn int dvb_fe_get_parms(struct dvb_v5_fe_parms *parms) * @brief Prints all the properties at the cache * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -380,8 +360,6 @@ int dvb_fe_get_parms(struct dvb_v5_fe_parms *parms); */ /** - * @fn struct dtv_stats *dvb_fe_retrieve_stats_layer(struct dvb_v5_fe_parms *parms, - * unsigned cmd, unsigned layer) * @brief Retrieve the stats for a DTV layer from cache * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -407,8 +385,6 @@ struct dtv_stats *dvb_fe_retrieve_stats_layer(struct dvb_v5_fe_parms *parms, unsigned cmd, unsigned layer); /** - * @fn int dvb_fe_retrieve_stats(struct dvb_v5_fe_parms *parms, - * unsigned cmd, uint32_t *value) * @brief Retrieve the stats for a DTV layer from cache * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -425,7 +401,6 @@ int dvb_fe_retrieve_stats(struct dvb_v5_fe_parms *parms, unsigned cmd, uint32_t *value); /** - * @fn int dvb_fe_get_stats(struct dvb_v5_fe_parms *parms) * @brief Retrieve the stats from the Kernel * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -437,8 +412,6 @@ int dvb_fe_retrieve_stats(struct dvb_v5_fe_parms *parms, int dvb_fe_get_stats(struct dvb_v5_fe_parms *parms); /** - * @fn float dvb_fe_retrieve_ber(struct dvb_v5_fe_parms *parms, unsigned layer, - * enum fecap_scale_params *scale) * @brief Retrieve the BER stats from cache * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -466,7 +439,6 @@ float dvb_fe_retrieve_ber(struct dvb_v5_fe_parms *parms, unsigned layer, enum fecap_scale_params *scale); /** - * @fn float dvb_fe_retrieve_per(struct dvb_v5_fe_parms *parms, unsigned layer) * @brief Retrieve the PER stats from cache * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -490,7 +462,6 @@ float dvb_fe_retrieve_ber(struct dvb_v5_fe_parms *parms, unsigned layer, float dvb_fe_retrieve_per(struct dvb_v5_fe_parms *parms, unsigned layer); /** - * @fn int dvb_fe_snprintf_eng(char *buf, int len, float val) * @brief Ancillary function to sprintf on ENG format * * @param buf buffer to store the value @@ -507,9 +478,6 @@ int dvb_fe_snprintf_eng(char *buf, int len, float val); /** - * @fn int dvb_fe_snprintf_eng(struct dvb_v5_fe_parms *parms, uint32_t cmd, - * char *display_name, int layer, - * char **buf, int *len, int *show_layer_name) * @brief Ancillary function to sprintf on ENG format * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -534,7 +502,6 @@ int dvb_fe_snprintf_eng(char *buf, int len, float val); char **buf, int *len, int *show_layer_name); /** - * @fn int dvb_fe_get_event(struct dvb_v5_fe_parms *parms) * @brief Get both status statistics and dvb parameters * * @param parms struct dvb_v5_fe_parms pointer to the opened device @@ -551,7 +518,7 @@ int dvb_fe_get_event(struct dvb_v5_fe_parms *parms); * The functions bellow are just wrappers for the Kernel calls, in order to * manually control satellite systems. * - * Instead of using them, the best is to set the LNBf parameters, and let + * Instead of using most them, the best is to set the LNBf parameters, and let * the libdvbv5 to automatically handle the calls. * * NOTE: It currently lacks support for two ioctl's: @@ -576,32 +543,73 @@ int dvb_fe_get_event(struct dvb_v5_fe_parms *parms); /** * @brief DVB ioctl wrapper for setting SEC voltage + * + * @param parms struct dvb_v5_fe_parms pointer to the opened device + * @param on a value different than zero indicates to enable + * voltage on a Satellite Equipment Control (SEC) + * @param v18 if on != 0, a value different than zero means 18 Volts; + * zero means 13 Volts. + * + * If dvb_v5_fe_parms::lnb is set, this is controlled automatically. */ int dvb_fe_sec_voltage(struct dvb_v5_fe_parms *parms, int on, int v18); /** * @brief DVB ioctl wrapper for setting SEC tone + * + * @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 + * + * If dvb_v5_fe_parms::lnb is set, this is controlled automatically. */ 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 + * + * @param parms struct dvb_v5_fe_parms pointer to the opened device + * @param on a value different than zero indicates to produce + * lightly higher voltages instead of 13/18V, in order + * to compensate for long cables. */ int dvb_fe_lnb_high_voltage(struct dvb_v5_fe_parms *parms, int on); /** - * @brief DVB ioctl wrapper for setting SEC DiSeqC burst + * @brief DVB ioctl wrapper for setting SEC DiSeqC tone burst to select between + * satellite A or B + * + * @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 + * select satellite B. Otherwise, sends tone to select + * satellite A. + * + * Valid only on certain DISEqC arrangements. + * + * If dvb_v5_fe_parms::lnb is set, this is controlled automatically. */ int dvb_fe_diseqc_burst(struct dvb_v5_fe_parms *parms, int mini_b); /** * @brief DVB ioctl wrapper for setting SEC DiSeqC command + * + * @param parms struct dvb_v5_fe_parms pointer to the opened device + * @param len size of the DiSEqC command + * @param buf DiSEqC command to be sent + * + * If dvb_v5_fe_parms::lnb is set, this is controlled automatically. */ int dvb_fe_diseqc_cmd(struct dvb_v5_fe_parms *parms, const unsigned len, const unsigned char *buf); /** - * @brief DVB ioctl wrapper for getting SEC DiSeqC reply + * @brief DVB ioctl wrapper for getting SEC DiSEqC reply + * + * @param parms struct dvb_v5_fe_parms pointer to the opened device + * @param len size of the DiSEqC command + * @param buf DiSEqC command to be sent + * @param timeout maximum time to receive the command, in ms. + * + * If dvb_v5_fe_parms::lnb is set, this is controlled automatically. */ int dvb_fe_diseqc_reply(struct dvb_v5_fe_parms *parms, unsigned *len, char *buf, int timeout); diff --git a/lib/include/libdvbv5/dvb-file.h b/lib/include/libdvbv5/dvb-file.h index a39f719..063a351 100644 --- a/lib/include/libdvbv5/dvb-file.h +++ b/lib/include/libdvbv5/dvb-file.h @@ -60,35 +60,41 @@ struct dvb_elementary_pid { * @struct dvb_entry * @brief Represents one entry on a DTV file * - * @param props a property key/value pair. The keys are the ones - * specified at the DVB API, plus the ones defined - * internally by libdvbv5, at the dvb-v5-std.h header file. - * @param next a pointer to the next entry. NULL if this is the last - * one. + * @param props A property key/value pair. The keys are the ones + * specified at the DVB API, plus the ones defined + * internally by libdvbv5, at the dvb-v5-std.h + * header file. + * @param next a pointer to the next entry. NULL if this is + * the last one. * @param service_id Service ID associated with a program inside a - * transponder. Please note that pure "channel" files - * will have this field filled with 0. + * transponder. Please note that pure "channel" + * files will have this field filled with 0. * @param video_pid Array with the video program IDs inside a service * @param audio_pid Array with the audio program IDs inside a service - * @param other_el_pid Array with all non-audio/video program IDs inside a - * service - * @param video_pid_len Size of the video_pid array - * @param audio_pid_len Size of the audio_pid array + * @param other_el_pid Array with all non-audio/video program IDs + * inside a service + * @param video_pid_len Size of the video_pid array + * @param audio_pid_len Size of the audio_pid array * @param other_el_pid_len Size of the other_el_pid array * @param channel String containing the name of the channel * @param vchannel String representing the Number of the channel * @param location String representing the location of the channel - * @param sat_number For satellite streams, this represents the number of - * the satellite dish on a DiSeqC arrangement. Should be - * zero on arrangements without DiSeqC. - * @param freq_bpf SCR/Unicable band-pass filter frequency to use, in kHz. - * For non SRC/Unicable arrangements, it should be zero. - * @param diseqc_wait Extra time to wait for DiSeqC commands to complete, - * in ms. The library will use 15 ms as the minimal time, - * plus the time specified on this field. - * @param lnb String with the name of the LNBf to be used for - * satellite tuning. The names should match the names - * provided by dvb_sat_get_lnb() call (see dvb-sat.h). + * @param sat_number For satellite streams, this represents the + * number of the satellite dish on a DiSeqC + * arrangement. Should be zero on arrangements + * without DiSeqC. + * @param freq_bpf SCR/Unicable band-pass filter frequency to + * use, in kHz. + * For non SRC/Unicable arrangements, it should + * be zero. + * @param diseqc_wait Extra time to wait for DiSeqC commands to + * complete, in ms. The library will use 15 ms + * as the minimal time, + * plus the time specified on this field. + * @param lnb String with the name of the LNBf to be used for + * satellite tuning. The names should match the + * names provided by dvb_sat_get_lnb() call + * (see dvb-sat.h). */ struct dvb_entry { struct dtv_property props[DTV_MAX_COMMAND]; @@ -114,7 +120,7 @@ struct dvb_entry { * @brief Describes an entire DVB file opened * * @param fname name of the file - * @param n_entries number of the entries read + * @param n_entries number of the entries read * @param first_entry entry for the first entry. NULL if the file is empty. */ struct dvb_file { @@ -134,14 +140,17 @@ struct dvb_file { * @struct dvb_parse_table * @brief Describes the fields to parse on a file * - * @param prop Name of the DVBv5 or libdvbv5 property field - * @param table Name of a translation table for string to int conversion - * @param size Size of the translation table - * @param mult_factor Multiply factor - Used, for example, to multiply the - * symbol rate read from a DVB-S table by 1000. - * @param has_default_value It is different than zero when the property can be - * optional. In this case, the next field should be present - * @param default_value Default value for the optional field + * @param prop Name of the DVBv5 or libdvbv5 property field + * @param table Name of a translation table for string to + * int conversion + * @param size Size of the translation table + * @param mult_factor Multiply factor - Used, for example, to + * multiply the symbol rate read from a DVB-S + * table by 1000. + * @param has_default_value It is different than zero when the property + * can be optional. In this case, the next field + * should be present + * @param default_value Default value for the optional field */ struct dvb_parse_table { unsigned int prop; @@ -154,6 +163,7 @@ struct dvb_parse_table { /** * @struct dvb_parse_struct * @brief Describes the format to parse an specific delivery system + * * @param id String that identifies the delivery system on the * file to be parsed * @param delsys Delivery system @@ -213,7 +223,6 @@ extern "C" { #endif /** - * @fn void dvb_file_free(struct dvb_file *dvb_file) * @brief Deallocates memory associated with a struct dvb_file * * @param dvb_file dvb_file struct to be deallocated @@ -262,10 +271,9 @@ extern const struct dvb_parse_file channel_file_zap_format; */ /** - * @fn struct dvb_file *dvb_read_file(const char *fname) * @brief Read a file at libdvbv5 format * - * @param fname file name + * @param fname file name * * @return It returns a pointer to struct dvb_file describing the entries that * were read from the file. If it fails, NULL is returned. @@ -273,10 +281,9 @@ extern const struct dvb_parse_file channel_file_zap_format; struct dvb_file *dvb_read_file(const char *fname); /** - * @fn int dvb_write_file(const char *fname, struct dvb_file *dvb_file) * @brief Write a file at libdvbv5 format * - * @param fname file name + * @param fname file name * @param dvb_file contents of the file to be written * * @return It returns zero if success, or a positive error number if it fails. @@ -284,13 +291,10 @@ struct dvb_file *dvb_read_file(const char *fname); int dvb_write_file(const char *fname, struct dvb_file *dvb_file); /** - * @fn struct dvb_file *dvb_read_file_format(const char *fname, - * uint32_t delsys, - * enum dvb_file_formats format) * @brief Read a file on any format natively supported by * the library * - * @param fname file name + * @param fname file name * @param delsys Delivery system, as specified by enum fe_delivery_system * @param format Name of the format to be read * @@ -302,10 +306,6 @@ struct dvb_file *dvb_read_file_format(const char *fname, enum dvb_file_formats format); /** - * @fn int dvb_write_file(const char *fname, - struct dvb_file *dvb_file, - uint32_t delsys, - enum dvb_file_formats format) * @brief Write a file on any format natively supported by * the library * @@ -314,7 +314,7 @@ struct dvb_file *dvb_read_file_format(const char *fname, * @param delsys Delivery system, as specified by enum fe_delivery_system * @param format Name of the format to be read * - * @return It returns zero if success, or a positive error number if it fails. + * @return It a pointer to struct dvb_file on success, NULL otherwise. */ int dvb_write_file_format(const char *fname, struct dvb_file *dvb_file, @@ -323,8 +323,6 @@ int dvb_write_file_format(const char *fname, /** - * @fn int dvb_store_entry_prop(struct dvb_entry *entry, - * uint32_t cmd, uint32_t value) * @brief Stores a key/value pair on a DVB file entry * * @param entry entry to be filled @@ -342,8 +340,6 @@ int dvb_store_entry_prop(struct dvb_entry *entry, uint32_t cmd, uint32_t value); /** - * @fn int dvb_retrieve_entry_prop(struct dvb_entry *entry, - * uint32_t cmd, uint32_t *value) * @brief Retrieves the value associated witha key on a DVB file entry * * @param entry entry to be used @@ -360,11 +356,6 @@ int dvb_retrieve_entry_prop(struct dvb_entry *entry, uint32_t cmd, uint32_t *value); /** - * @fn int dvb_store_channel(struct dvb_file **dvb_file, - * struct dvb_v5_fe_parms *parms, - * struct dvb_v5_descriptors *dvb_desc, - * int get_detected, int get_nit) - * * @brief stored a new scanned channel into a dvb_file struct * * @param dvb_file file struct to be filled @@ -402,7 +393,6 @@ int dvb_store_channel(struct dvb_file **dvb_file, int get_detected, int get_nit); /** - * @fn int dvb_parse_delsys(const char *name) * @brief Ancillary function that seeks for a delivery system * * @param name string containing the name of the Delivery System to seek @@ -422,7 +412,6 @@ int dvb_store_channel(struct dvb_file **dvb_file, int dvb_parse_delsys(const char *name); /** - * @fn enum dvb_file_formats dvb_parse_format(const char *name) * @brief Ancillary function that parses the name of a file format * @param name string containing the name of the format * Current valid names are: ZAP, CHANNEL and DVBV5. The name is @@ -438,15 +427,37 @@ enum dvb_file_formats dvb_parse_format(const char *name); * dvb_read_file_format() or dvb_write_file_format() */ -#ifndef _DOXYGEN +/** + * @brief Read and parses a one line file format + * + * @param fname file name + * @param delsys delivery system + * @param parse_file pointer struct dvb_parse_file + * + * @return It a pointer to struct dvb_file on success, NULL otherwise. + * + * This function is called internally by dvb_read_file_format. + */ struct dvb_file *dvb_parse_format_oneline(const char *fname, uint32_t delsys, const struct dvb_parse_file *parse_file); + +/** + * @brief Writes a file into an one line file format + * + * @param fname file name + * @param dvb_file contents of the file to be written + * @param delsys delivery system + * @param parse_file pointer struct dvb_parse_file + * + * @return It returns zero if success, or a positive error number if it fails. + * + * This function is called internally by dvb_write_file_format. + */ int dvb_write_format_oneline(const char *fname, struct dvb_file *dvb_file, uint32_t delsys, const struct dvb_parse_file *parse_file); -#endif #ifdef __cplusplus } diff --git a/lib/include/libdvbv5/dvb-log.h b/lib/include/libdvbv5/dvb-log.h index 481e9e6..2ab856d 100644 --- a/lib/include/libdvbv5/dvb-log.h +++ b/lib/include/libdvbv5/dvb-log.h @@ -99,6 +99,9 @@ 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. + * + * @param level level of the message, as defined at syslog.h + * @param fmt format string (same as format string on sprintf) */ void dvb_default_log(int level, const char *fmt, ...) __attribute__ (( format( printf, 2, 3 ))); diff --git a/lib/include/libdvbv5/dvb-sat.h b/lib/include/libdvbv5/dvb-sat.h index af3e210..75c8ef8 100644 --- a/lib/include/libdvbv5/dvb-sat.h +++ b/lib/include/libdvbv5/dvb-sat.h @@ -87,7 +87,6 @@ extern "C" /* From libsat.c */ /** - * @fn int dvb_sat_search_lnb(const char *name) * @brief search for a LNBf entry * * @param name name of the LNBf entry to seek. @@ -100,17 +99,15 @@ extern "C" int dvb_sat_search_lnb(const char *name); /** - * @fn int dvb_print_lnb(int i) * @brief prints the contents of a LNBf entry at STDOUT. * - * @param i index for the entry + * @param index index for the entry * * @return returns -1 if the index is out of range, zero otherwise. */ -int dvb_print_lnb(int i); +int dvb_print_lnb(int index); /** - * @fn void dvb_print_all_lnb() * @brief Prints all LNBf entries at STDOUT. * * This function doesn't return anything. Internally, it calls dvb_print_lnb() @@ -119,17 +116,15 @@ int dvb_print_lnb(int i); void dvb_print_all_lnb(void); /** - * @fn const struct dvb_sat_lnb *dvb_sat_get_lnb(int i) * @brief gets a LNBf entry at its internal database * - * @param i index for the entry. + * @param index index for the entry. * * @return returns NULL if not found, of a struct dvb_sat_lnb pointer otherwise. */ -const struct dvb_sat_lnb *dvb_sat_get_lnb(int i); +const struct dvb_sat_lnb *dvb_sat_get_lnb(int index); /** - * @fn int dvb_sat_set_parms(struct dvb_v5_fe_parms *parms) * @brief sets the satellite parameters * * @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 778d3a7..689ea24 100644 --- a/lib/include/libdvbv5/dvb-scan.h +++ b/lib/include/libdvbv5/dvb-scan.h @@ -117,7 +117,6 @@ struct dvb_table_filter { void *priv; }; /** - * @fn dvb_table_filter_free(struct dvb_table_filter *sect) * @brief deallocates all data associated with a table filter * * @param sect table filter pointer @@ -127,12 +126,12 @@ void dvb_table_filter_free(struct dvb_table_filter *sect); /** * @brief read MPEG-TS tables that comes from a DTV card * - * @param parms pointer to struct dvb_v5_fe_parms created when the frontend is - * opened + * @param parms pointer to struct dvb_v5_fe_parms created when the + * frontend is opened * @param dmx_fd an opened demux file descriptor - * @param tid Table ID - * @param pid Program ID - * @param table pointer to a pointer for the table struct to be filled + * @param tid Table ID + * @param pid Program ID + * @param table pointer to a pointer for the table struct to be filled * @param timeout Limit, in seconds, to read a MPEG-TS table * * This function is used to read the DVB tables by specifying a table ID and @@ -171,15 +170,15 @@ 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 * - * @param parms pointer to struct dvb_v5_fe_parms created when the frontend is - * opened + * @param parms pointer to struct dvb_v5_fe_parms created when the + * frontend is opened * @param dmx_fd an opened demux file descriptor - * @param tid Table ID - * @param pid Program ID - * @param ts_id Table section ID (for multisession filtering). If no - * specific table section is needed, -1 should be used - * @param table pointer to a pointer for the table struct to be filled - * @param timeout Limit, in seconds, to read a MPEG-TS table + * @param tid Table ID + * @param pid Program ID + * @param ts_id Table section ID (for multisession filtering). If no + * specific table section is needed, -1 should be used + * @param table pointer to a pointer for the table struct to be filled + * @param timeout limit, in seconds, to read a MPEG-TS table * * This is a variant of dvb_read_section() that also seeks for an specific * table section ID given by ts_id. @@ -191,11 +190,11 @@ int dvb_read_section(struct dvb_v5_fe_parms *parms, int dmx_fd, /** * @brief read MPEG-TS tables that comes from a DTV card * - * @param parms pointer to struct dvb_v5_fe_parms created when the frontend is - * opened + * @param parms pointer to struct dvb_v5_fe_parms created when the + * frontend is opened * @param dmx_fd an opened demux file descriptor - * @param sect section filter pointer - * @param timeout Limit, in seconds, to read a MPEG-TS table + * @param sect section filter pointer + * @param timeout limit, in seconds, to read a MPEG-TS table * * This is a variant of dvb_read_section() that uses a struct dvb_table_filter * to specify the filter to use. @@ -224,13 +223,14 @@ 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 * - * @param parms pointer to struct dvb_v5_fe_parms created when the - * frontend is opened + * @param parms pointer to struct dvb_v5_fe_parms created when + * the frontend is opened * @param dmx_fd an opened demux file descriptor - * @param delivery_system Delivery system to be scanned - * @param other_nit Use alternate table IDs for NIT and other tables - * @param timeout_multiply Improves the timeout for each table reception, by - * using a value that will multiply the wait time. + * @param delivery_system delivery system to be scanned + * @param other_nit use alternate table IDs for NIT and other tables + * @param timeout_multiply improves the timeout for each table reception + * by using a value that will multiply the wait + * time. * * Given an opened frontend and demux, this function seeks for all programs * available at the transport stream, and parses the following tables: @@ -254,6 +254,14 @@ struct dvb_v5_descriptors *dvb_get_ts_tables(struct dvb_v5_fe_parms *parms, int */ void dvb_free_ts_tables(struct dvb_v5_descriptors *dvb_desc); +/** + * @brief Callback for the application to show the frontend status + * + * @param args a pointer, opaque to libdvbv5, to be used by the + * application if needed. + * @param parms pointer to struct dvb_v5_fe_parms created when the + * frontend is opened + */ typedef int (check_frontend_t)(void *args, struct dvb_v5_fe_parms *parms); /** @@ -355,6 +363,7 @@ void dvb_add_scaned_transponders(struct dvb_v5_fe_parms *parms, struct dvb_entry *first_entry, struct dvb_entry *entry); +#ifndef _DOXYGEN /* * Some ancillary functions used internally inside the library, used to * identify duplicated transport streams and add new found transponder entries @@ -374,7 +383,7 @@ void dvb_update_transponders(struct dvb_v5_fe_parms *parms, struct dvb_v5_descriptors *dvb_scan_handler, struct dvb_entry *first_entry, struct dvb_entry *entry); - +#endif #ifdef __cplusplus } diff --git a/lib/include/libdvbv5/eit.h b/lib/include/libdvbv5/eit.h index 16e978e..30bd0fa 100644 --- a/lib/include/libdvbv5/eit.h +++ b/lib/include/libdvbv5/eit.h @@ -76,8 +76,8 @@ * @param running_status running status of the event. The status can * be translated to string via * dvb_eit_running_status_name string table. - * @param descriptor pointer to struct descriptor - * @param next pointer to struct next + * @param descriptor pointer to struct dvb_desc + * @param next pointer to struct dvb_table_eit_event * @param tm_start event start (in struct tm format) * @param duration duration in seconds * @param service_id service ID @@ -120,6 +120,7 @@ struct dvb_table_eit_event { * @struct dvb_table_eit * @brief DVB EIT table * + * @param header struct dvb_table_header content * @param transport_id transport id * @param network_id network id * @param last_segment last segment @@ -189,7 +190,7 @@ void dvb_table_eit_free(struct dvb_table_eit *table); * @brief Prints the content of the DVB EIT table * * @param parms struct dvb_v5_fe_parms pointer to the opened device - * @param table pointe to struct dvb_table_eit + * @param table pointer to struct dvb_table_eit */ void dvb_table_eit_print(struct dvb_v5_fe_parms *parms, struct dvb_table_eit *table); diff --git a/lib/include/libdvbv5/header.h b/lib/include/libdvbv5/header.h index ed4d6ee..53efab2 100644 --- a/lib/include/libdvbv5/header.h +++ b/lib/include/libdvbv5/header.h @@ -78,13 +78,10 @@ struct dvb_ts_packet_header { * * @param table_id table id * @param section_length section length - * @param one one - * @param zero zero * @param syntax syntax * @param id TS ID * @param current_next current next * @param version version - * @param one2 one2 * @param section_id section number * @param last_section last section number * diff --git a/lib/include/libdvbv5/mgt.h b/lib/include/libdvbv5/mgt.h index 9780515..218d23c 100644 --- a/lib/include/libdvbv5/mgt.h +++ b/lib/include/libdvbv5/mgt.h @@ -168,7 +168,7 @@ void atsc_table_mgt_free(struct atsc_table_mgt *table); * @brief Prints the content of the MGT table * * @param parms struct dvb_v5_fe_parms pointer to the opened device - * @param table pointe to struct atsc_table_mgt + * @param table pointer to struct atsc_table_mgt */ void atsc_table_mgt_print(struct dvb_v5_fe_parms *parms, struct atsc_table_mgt *table); diff --git a/lib/include/libdvbv5/nit.h b/lib/include/libdvbv5/nit.h index f2eb4cb..38562c6 100644 --- a/lib/include/libdvbv5/nit.h +++ b/lib/include/libdvbv5/nit.h @@ -87,8 +87,8 @@ union dvb_table_nit_transport_header { * @param transport_id transport id * @param network_id network id * @param desc_length desc length - * @param descriptor pointer to struct descriptor - * @param next pointer to struct next + * @param descriptor pointer to struct dvb_desc + * @param next pointer to struct dvb_table_nit_transport * * This structure is used to store the original NIT transport table, * converting the integer fields to the CPU endianness. @@ -119,9 +119,10 @@ struct dvb_table_nit_transport { * @struct dvb_table_nit * @brief MPEG-TS NIT table * - * @param desc_length desc length - * @param descriptor pointer to struct descriptor - * @param transport pointer to struct transport + * @param header struct dvb_table_header content + * @param desc_length descriptor length + * @param descriptor pointer to struct dvb_desc + * @param transport pointer to struct dvb_table_nit_transport * * This structure is used to store the original NIT table, * converting the integer fields to the CPU endianness. @@ -174,7 +175,7 @@ typedef void nit_tran_handler_callback_t(struct dvb_table_nit *nit, * @brief Macro used to find a transport inside a NIT table * * @param _tran transport to seek - * @param _nit pointer to struct dvb_table_pat_program + * @param _nit pointer to struct dvb_table_nit_transport */ #define dvb_nit_transport_foreach( _tran, _nit ) \ for (struct dvb_table_nit_transport *_tran = _nit->transport; _tran; _tran = _tran->next) \ @@ -191,7 +192,7 @@ extern "C" { * @param parms struct dvb_v5_fe_parms pointer to the opened device * @param buf buffer containing the NIT raw data * @param buflen length of the buffer - * @param table pointer to struct dvb_table_sdt to be allocated and filled + * @param table pointer to struct dvb_table_nit to be allocated and filled * * This function allocates a NIT table and fills the fields inside * the struct. It also makes sure that all fields will follow the CPU @@ -206,7 +207,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 * - * @param table pointer to struct dvb_table_sdt to be freed + * @param table pointer to struct dvb_table_nit to be freed */ void dvb_table_nit_free(struct dvb_table_nit *table); @@ -214,7 +215,7 @@ void dvb_table_nit_free(struct dvb_table_nit *table); * @brief Prints the content of the NIT table * * @param parms struct dvb_v5_fe_parms pointer to the opened device - * @param table pointer to struct dvb_table_sdt + * @param table pointer to struct dvb_table_nit */ void dvb_table_nit_print(struct dvb_v5_fe_parms *parms, struct dvb_table_nit *table); @@ -222,7 +223,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 * * @param parms struct dvb_v5_fe_parms pointer to the opened device - * @param table pointer to struct dvb_table_sdt + * @param table pointer to struct dvb_table_nit * @param descriptor indicates the NIT table descriptor to seek * @param call_nit a nit_handler_callback_t function to be called when a * new entry at the NIT table is found (or NULL). diff --git a/lib/include/libdvbv5/pat.h b/lib/include/libdvbv5/pat.h index 84c2761..6eb96d8 100644 --- a/lib/include/libdvbv5/pat.h +++ b/lib/include/libdvbv5/pat.h @@ -58,8 +58,8 @@ * @brief MPEG-TS PAT program table * * @param service_id service id - * @param pid pid - * @param next pointer to struct next + * @param pid pid + * @param next pointer to struct dvb_table_pat_program * * This structure is used to store the original PAT program table, * converting the integer fields to the CPU endianness. @@ -87,9 +87,10 @@ struct dvb_table_pat_program { * @struct dvb_table_pat * @brief MPEG-TS PAT table * - * @param programs programs - * @param program pointer to struct program - * + * @param header struct dvb_table_header content + * @param programs number of programs + * @param program pointer to struct dvb_table_pat_program + * This structure is used to store the original PAT table, * converting the integer fields to the CPU endianness. * @@ -107,7 +108,7 @@ struct dvb_table_pat { } __attribute__((packed)); /** - * @brief Macro used to find all programs on a PAT table + * @brief Macro used to find programs on a PAT table * * @param _pgm program to seek * @param _pat pointer to struct dvb_table_pat_program @@ -150,7 +151,7 @@ void dvb_table_pat_free(struct dvb_table_pat *table); * @brief Prints the content of the PAT table * * @param parms struct dvb_v5_fe_parms pointer to the opened device - * @param table pointe to struct dvb_table_pat + * @param table pointer to struct dvb_table_pat */ void dvb_table_pat_print(struct dvb_v5_fe_parms *parms, struct dvb_table_pat *table); diff --git a/lib/include/libdvbv5/pmt.h b/lib/include/libdvbv5/pmt.h index 0167dff..dc4ea73 100644 --- a/lib/include/libdvbv5/pmt.h +++ b/lib/include/libdvbv5/pmt.h @@ -140,8 +140,9 @@ extern const char *pmt_stream_name[]; * @param elementary_pid elementary pid * @param desc_length descriptor length * @param zero zero - * @param descriptor pointer to struct descriptor - * @param next pointer to struct next + * @param descriptor pointer to struct dvb_desc + * @param next pointer to struct dvb_table_pmt_stream + * * This structure is used to store the original PMT stream table, * converting the integer fields to the CPU endianness. @@ -177,12 +178,12 @@ struct dvb_table_pmt_stream { /** * @struct dvb_table_pmt * @brief MPEG-TS PMT table - * + * + * @param header struct dvb_table_header content * @param pcr_pid PCR PID * @param desc_length descriptor length - * @param zero3 zero3 - * @param descriptor pointer to struct descriptor - * @param stream pointer to struct stream + * @param descriptor pointer to struct dvb_desc + * @param stream pointer to struct dvb_table_pmt_stream * * This structure is used to store the original PMT stream table, * converting the integer fields to the CPU endianness. @@ -223,7 +224,7 @@ struct dvb_table_pmt { #define dvb_pmt_field_last descriptor /** - * @brief Macro used to find all streams on a PMT table + * @brief Macro used to find streams on a PMT table * * @param _stream stream to seek * @param _pmt pointer to struct dvb_table_pmt_stream @@ -266,7 +267,7 @@ void dvb_table_pmt_free(struct dvb_table_pmt *table); * @brief Prints the content of the PAT table * * @param parms struct dvb_v5_fe_parms pointer to the opened device - * @param table pointe to struct dvb_table_pmt + * @param table pointer to struct dvb_table_pmt */ void dvb_table_pmt_print(struct dvb_v5_fe_parms *parms, const struct dvb_table_pmt *table); diff --git a/lib/include/libdvbv5/sdt.h b/lib/include/libdvbv5/sdt.h index 9710136..5a85dbc 100644 --- a/lib/include/libdvbv5/sdt.h +++ b/lib/include/libdvbv5/sdt.h @@ -60,14 +60,14 @@ * @struct dvb_table_sdt_service * @brief MPEG-TS SDT service table * - * @param service_id service id + * @param service_id service id * @param EIT_present_following EIT present following - * @param EIT_schedule EIT schedule - * @param desc_length desc length - * @param free_CA_mode free CA mode + * @param EIT_schedule EIT schedule + * @param desc_length desc length + * @param free_CA_mode free CA mode * @param running_status running status - * @param descriptor pointer to struct descriptor - * @param next pointer to struct next + * @param descriptor pointer to struct dvb_desc + * @param next pointer to struct dvb_table_sdt_service * * This structure is used to store the original SDT service table, * converting the integer fields to the CPU endianness. @@ -101,8 +101,9 @@ struct dvb_table_sdt_service { * @struct dvb_table_sdt * @brief MPEG-TS SDT table * + * @param header struct dvb_table_header content * @param network_id network id - * @param service pointer to struct service + * @param service pointer to struct dvb_table_sdt_service * * This structure is used to store the original SDT table, * converting the integer fields to the CPU endianness. @@ -125,7 +126,7 @@ struct dvb_table_sdt { * @brief Macro used to find services on a SDT table * * @param _service service to seek - * @param _sdt pointer to struct dvb_table_pat_program + * @param _sdt pointer to struct dvb_table_sdt_service */ #define dvb_sdt_service_foreach(_service, _sdt) \ for (struct dvb_table_sdt_service *_service = _sdt->service; _service; _service = _service->next ) \ @@ -165,7 +166,7 @@ void dvb_table_sdt_free(struct dvb_table_sdt *table); * @brief Prints the content of the SDT table * * @param parms struct dvb_v5_fe_parms pointer to the opened device - * @param table pointe to struct dvb_table_sdt + * @param table pointer to struct dvb_table_sdt */ void dvb_table_sdt_print(struct dvb_v5_fe_parms *parms, struct dvb_table_sdt *table); diff --git a/lib/include/libdvbv5/vct.h b/lib/include/libdvbv5/vct.h index acd4529..98e7b78 100644 --- a/lib/include/libdvbv5/vct.h +++ b/lib/include/libdvbv5/vct.h @@ -154,7 +154,6 @@ struct atsc_table_vct_channel { * @param header struct dvb_table_header content * @param protocol_version protocol version * @param num_channels_in_section num channels in section - * * @param channel pointer to struct channel * @param descriptor pointer to struct descriptor * @@ -188,7 +187,7 @@ union atsc_table_vct_descriptor_length { } __attribute__((packed)); /** - * @brief Macro used to find all channels on a VCT table + * @brief Macro used to find channels on a VCT table * * @param _channel channel to seek * @param _vct pointer to struct atsc_table_vct_channel @@ -229,7 +228,7 @@ void atsc_table_vct_free(struct atsc_table_vct *table); * @brief Prints the content of the VCT table * * @param parms struct dvb_v5_fe_parms pointer to the opened device - * @param table pointe to struct atsc_table_vct + * @param table pointer to struct atsc_table_vct */ void atsc_table_vct_print(struct dvb_v5_fe_parms *parms, struct atsc_table_vct *table); -- 2.7.4