Commit b5ed56e4 authored by Jean-Paul Saman's avatar Jean-Paul Saman

Doxygen updates

Fixes in documentation for:
 src/descriptors/dr_4b.h   document dvbpsi_nvod_ref_s
 src/descriptors/dr_76.h   document CRID_* defines
 src/tables/atsc_eit.h     document all arguments of dvbpsi_atsc_NewEIT()
 src/tables/atsc_ett.h     document all arguments of dvbpsi_atsc_NewETT()
 src/tables/atsc_stt.h     document missing arguments of dvbpsi_atsc_DetachSTT()
 src/tables/atsc_vct.h     document fix for functions dvbpsi_atsc_InitVCT() and dvbpsi_atsc_NewVCT()
 src/tables/bat.h          document arguments of dvbpsi_bat_ts_add()
 src/table/eit.h           document arguments of dvbpsi_eit_init()
 src/tables/sdt.h          remove unused argument from function dvbpsi_sdt_init()
 src/tables/tot.h          remove unused argument from function dvbpsi_tot_init()
parent e3451586
...@@ -52,7 +52,7 @@ extern "C" { ...@@ -52,7 +52,7 @@ extern "C" {
* \brief dvbpsi_nvod_ref_dr_t type definition. * \brief dvbpsi_nvod_ref_dr_t type definition.
*/ */
/*! /*!
* \struct dvbpsi_linkage_s * \struct dvbpsi_nvod_ref_s
* \brief struct dvbpsi_nvod_ref_s @see dvbpsi_nvod_ref_t * \brief struct dvbpsi_nvod_ref_s @see dvbpsi_nvod_ref_t
*/ */
typedef struct dvbpsi_nvod_ref_s typedef struct dvbpsi_nvod_ref_s
...@@ -83,7 +83,7 @@ typedef struct dvbpsi_nvod_ref_s ...@@ -83,7 +83,7 @@ typedef struct dvbpsi_nvod_ref_s
typedef struct dvbpsi_nvod_ref_dr_s typedef struct dvbpsi_nvod_ref_dr_s
{ {
uint8_t i_references; /*!< number of nvod references */ uint8_t i_references; /*!< number of nvod references */
dvbpsi_nvod_ref_t p_nvod_refs[43]; /*!< NVOD references */ dvbpsi_nvod_ref_t p_nvod_refs[43]; /*!< NVOD references */
} dvbpsi_nvod_ref_dr_t; } dvbpsi_nvod_ref_dr_t;
/***************************************************************************** /*****************************************************************************
......
...@@ -34,11 +34,28 @@ Decode Content Identifier Descriptor. ...@@ -34,11 +34,28 @@ Decode Content Identifier Descriptor.
extern "C" { extern "C" {
#endif #endif
/*!
* \def CRID_TYPE_CONTENT
* \brief Content Resource Identifier Descriptor for type content
*
* \def CRID_TYPE_SERIES
* \brief Content Resource Identifier Descriptor for type series content
*
* \def CRID_TYPE_RECOMMENDATION
* \brief Content Resource Identifier Descriptor for type recommended content
*/
#define CRID_TYPE_UNDEFINED 0 #define CRID_TYPE_UNDEFINED 0
#define CRID_TYPE_CONTENT 1 #define CRID_TYPE_CONTENT 1
#define CRID_TYPE_SERIES 2 #define CRID_TYPE_SERIES 2
#define CRID_TYPE_RECOMMENDATION 3 #define CRID_TYPE_RECOMMENDATION 3
/*!
* \def CRID_LOCATION_DESCRIPTOR
* \brief Content Resource Identifier Descriptor for location
*
* \def CRID_LOCATION_CIT
* \brief Content Resource Identifier Descriptor for CIT(?)
*/
#define CRID_LOCATION_DESCRIPTOR 0 #define CRID_LOCATION_DESCRIPTOR 0
#define CRID_LOCATION_CIT 1 #define CRID_LOCATION_CIT 1
......
...@@ -158,11 +158,10 @@ void dvbpsi_atsc_InitEIT(dvbpsi_atsc_eit_t* p_eit, uint8_t i_table_id, uint16_t ...@@ -158,11 +158,10 @@ void dvbpsi_atsc_InitEIT(dvbpsi_atsc_eit_t* p_eit, uint8_t i_table_id, uint16_t
* \brief Allocate and initialize a new dvbpsi_eit_t structure. Use ObjectRefDec to delete it. * \brief Allocate and initialize a new dvbpsi_eit_t structure. Use ObjectRefDec to delete it.
* \param i_table_id Table ID, 0xCB. * \param i_table_id Table ID, 0xCB.
* \param i_extension Table ID extension, here TS ID. * \param i_extension Table ID extension, here TS ID.
* \param i_network_id network id
* \param i_version EIT version * \param i_version EIT version
* \param b_current_next current next indicator
* \param i_protocol PSIP Protocol version. * \param i_protocol PSIP Protocol version.
* \param b_cable_eit Whether this is CEIT or a TEIT. * \param i_source_id Source id.
* \param b_current_next current next indicator
* \return p_eit pointer to the EIT structure or NULL on error * \return p_eit pointer to the EIT structure or NULL on error
*/ */
dvbpsi_atsc_eit_t *dvbpsi_atsc_NewEIT(uint8_t i_table_id, uint16_t i_extension, dvbpsi_atsc_eit_t *dvbpsi_atsc_NewEIT(uint8_t i_table_id, uint16_t i_extension,
......
...@@ -145,6 +145,7 @@ void dvbpsi_atsc_InitETT(dvbpsi_atsc_ett_t *p_ett, uint8_t i_table_id, uint16_t ...@@ -145,6 +145,7 @@ void dvbpsi_atsc_InitETT(dvbpsi_atsc_ett_t *p_ett, uint8_t i_table_id, uint16_t
* \brief Allocate and initialize a new dvbpsi_atsc_ett_t structure. Use ObjectRefDec to delete it. * \brief Allocate and initialize a new dvbpsi_atsc_ett_t structure. Use ObjectRefDec to delete it.
* \param i_table_id Table ID, 0xCC. * \param i_table_id Table ID, 0xCC.
* \param i_extension Table ID extension, normally 0x0000. * \param i_extension Table ID extension, normally 0x0000.
* \param i_version version
* \param i_protocol PSIP Protocol version. * \param i_protocol PSIP Protocol version.
* \param i_etm_id ETM Identifier. * \param i_etm_id ETM Identifier.
* \param b_current_next current next indicator * \param b_current_next current next indicator
......
...@@ -91,7 +91,7 @@ bool dvbpsi_atsc_AttachSTT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_ex ...@@ -91,7 +91,7 @@ bool dvbpsi_atsc_AttachSTT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_ex
* dvbpsi_atsc_DetachSTT * dvbpsi_atsc_DetachSTT
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \fn void dvbpsi_atsc_DetachSTT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_externsion) * \fn void dvbpsi_atsc_DetachSTT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension)
* *
* \brief Destroy a STT decoder. * \brief Destroy a STT decoder.
* \param p_dvbpsi dvbpsi handle to Subtable demultiplexor to which the decoder is attached. * \param p_dvbpsi dvbpsi handle to Subtable demultiplexor to which the decoder is attached.
...@@ -110,10 +110,10 @@ void dvbpsi_atsc_DetachSTT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_ex ...@@ -110,10 +110,10 @@ void dvbpsi_atsc_DetachSTT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_ex
uint16_t i_extension, uint8_t i_protocol, uint16_t i_extension, uint8_t i_protocol,
bool b_current_next) bool b_current_next)
* \brief Initialize a user-allocated dvbpsi_atsc_stt_t structure. * \brief Initialize a user-allocated dvbpsi_atsc_stt_t structure.
* \param p_stt pointer to the STT structure
* \param i_table_id Table ID, 0xCD. * \param i_table_id Table ID, 0xCD.
* \param i_extension Table extension, ignored as this should always be 0. * \param i_extension Table extension, ignored as this should always be 0.
* \param p_stt pointer to the STT structure * \param i_protocol PSIP Protocol version.
* \param i_version PSIP Protocol version.
* \param b_current_next current next indicator * \param b_current_next current next indicator
* \return nothing. * \return nothing.
*/ */
......
...@@ -150,8 +150,7 @@ void dvbpsi_atsc_DetachVCT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_ex ...@@ -150,8 +150,7 @@ void dvbpsi_atsc_DetachVCT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_ex
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \fn void dvbpsi_atsc_InitVCT(dvbpsi_atsc_vct_t* p_vct, uint8_t i_table_id, * \fn void dvbpsi_atsc_InitVCT(dvbpsi_atsc_vct_t* p_vct, uint8_t i_table_id,
uint16_t i_extension, uint8_t i_protocol, uint16_t i_extension, uint8_t i_protocol, bool b_cable_vct,
uint16_t i_ts_id, bool b_cable_vct,
uint8_t i_version, bool b_current_next) uint8_t i_version, bool b_current_next)
* \brief Initialize a user-allocated dvbpsi_atsc_vct_t structure. * \brief Initialize a user-allocated dvbpsi_atsc_vct_t structure.
* \param p_vct pointer to the VCT structure * \param p_vct pointer to the VCT structure
...@@ -178,7 +177,6 @@ void dvbpsi_atsc_InitVCT(dvbpsi_atsc_vct_t* p_vct, uint8_t i_table_id, ...@@ -178,7 +177,6 @@ void dvbpsi_atsc_InitVCT(dvbpsi_atsc_vct_t* p_vct, uint8_t i_table_id,
* \param i_table_id Table ID, 0xC8 or 0xC9. * \param i_table_id Table ID, 0xC8 or 0xC9.
* \param i_extension Table ID extension, here TS ID. * \param i_extension Table ID extension, here TS ID.
* \param i_protocol PSIP Protocol version. * \param i_protocol PSIP Protocol version.
* \param i_network_id network id
* \param b_cable_vct Whether this is CVCT or a TVCT. * \param b_cable_vct Whether this is CVCT or a TVCT.
* \param i_version VCT version * \param i_version VCT version
* \param b_current_next current next indicator * \param b_current_next current next indicator
......
...@@ -237,13 +237,15 @@ dvbpsi_bat_ts_t *dvbpsi_bat_ts_add(dvbpsi_bat_t* p_bat, ...@@ -237,13 +237,15 @@ dvbpsi_bat_ts_t *dvbpsi_bat_ts_add(dvbpsi_bat_t* p_bat,
uint8_t *p_data) uint8_t *p_data)
* \brief Add a descriptor in the BAT TS descriptors. * \brief Add a descriptor in the BAT TS descriptors.
* \param p_bat pointer to the BAT structure * \param p_bat pointer to the BAT structure
* \param i_ts_id descriptor's transport stream id * \param i_tag descriptor number
* \param i_orig_network_id descriptor's original network id * \param i_length length of descriptor in bytes
* \param p_data pointer to descriptor data
* \return a pointer to the added descriptor. * \return a pointer to the added descriptor.
*/ */
dvbpsi_descriptor_t *dvbpsi_bat_ts_descriptor_add(dvbpsi_bat_ts_t *p_ts, dvbpsi_descriptor_t *dvbpsi_bat_ts_descriptor_add(dvbpsi_bat_ts_t *p_ts,
uint8_t i_tag, uint8_t i_length, uint8_t i_tag, uint8_t i_length,
uint8_t *p_data); uint8_t *p_data);
/***************************************************************************** /*****************************************************************************
* dvbpsi_bat_sections_generate * dvbpsi_bat_sections_generate
*****************************************************************************/ *****************************************************************************/
......
...@@ -146,10 +146,10 @@ void dvbpsi_eit_detach(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extens ...@@ -146,10 +146,10 @@ void dvbpsi_eit_detach(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extens
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \fn void dvbpsi_eit_init(dvbpsi_eit_t* p_eit, uint8_t i_table_id, * \fn void dvbpsi_eit_init(dvbpsi_eit_t* p_eit, uint8_t i_table_id,
uint16_t i_extension, uint16_t i_service_id, uint16_t i_extension, uint8_t i_version,
uint8_t i_version, bool b_current_next, uint16_t i_ts_id, bool b_current_next, uint16_t i_ts_id, uint16_t i_network_id,
uint16_t i_network_id, uint8_t i_segment_last_section_number, uint8_t i_segment_last_section_number,
uint8_t i_last_table_id) uint8_t i_last_table_id);
* \brief Initialize a user-allocated dvbpsi_eit_t structure. * \brief Initialize a user-allocated dvbpsi_eit_t structure.
* \param p_eit pointer to the EIT structure * \param p_eit pointer to the EIT structure
* \param i_table_id Table ID, 0x4E, 0x4F, or 0x50-0x6F. * \param i_table_id Table ID, 0x4E, 0x4F, or 0x50-0x6F.
......
...@@ -167,7 +167,6 @@ void dvbpsi_sdt_init(dvbpsi_sdt_t *p_sdt, uint8_t i_table_id, uint16_t i_extensi ...@@ -167,7 +167,6 @@ void dvbpsi_sdt_init(dvbpsi_sdt_t *p_sdt, uint8_t i_table_id, uint16_t i_extensi
* \brief Allocate and initialize a new dvbpsi_sdt_t structure. * \brief Allocate and initialize a new dvbpsi_sdt_t structure.
* \param i_table_id Table ID, 0x42 or 0x46. * \param i_table_id Table ID, 0x42 or 0x46.
* \param i_extension Table ID extension, here TS ID. * \param i_extension Table ID extension, here TS ID.
* \param i_ts_id transport stream ID
* \param i_version SDT version * \param i_version SDT version
* \param b_current_next current next indicator * \param b_current_next current next indicator
* \param i_network_id original network id * \param i_network_id original network id
......
...@@ -118,7 +118,7 @@ void dvbpsi_tot_detach(dvbpsi_t* p_dvbpsi, uint8_t i_table_id, ...@@ -118,7 +118,7 @@ void dvbpsi_tot_detach(dvbpsi_t* p_dvbpsi, uint8_t i_table_id,
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \fn void dvbpsi_tot_init(dvbpsi_tot_t* p_tot, uint8_t i_table_id, uint16_t i_extension, * \fn void dvbpsi_tot_init(dvbpsi_tot_t* p_tot, uint8_t i_table_id, uint16_t i_extension,
uint16_t i_ts_id, uint8_t i_version, bool b_current_next, uint64_t i_utc_time); uint8_t i_version, bool b_current_next, uint64_t i_utc_time);
* \brief Initialize a user-allocated dvbpsi_tot_t structure. * \brief Initialize a user-allocated dvbpsi_tot_t structure.
* \param p_tot pointer to the TDT/TOT structure * \param p_tot pointer to the TDT/TOT structure
* \param i_table_id Table ID, usually 0x70 * \param i_table_id Table ID, usually 0x70
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment