Commit 162b9716 authored by Mélanie Benoit's avatar Mélanie Benoit Committed by Jean-Paul Saman

nit: fix invalid documentation

Signed-off-by: default avatarJean-Paul Saman <jpsaman@videolan.org>
parent b01ab1ee
...@@ -113,8 +113,8 @@ typedef void (* dvbpsi_nit_callback)(void* p_cb_data, dvbpsi_nit_t* p_new_nit); ...@@ -113,8 +113,8 @@ typedef void (* dvbpsi_nit_callback)(void* p_cb_data, dvbpsi_nit_t* p_new_nit);
dvbpsi_nit_callback pf_callback, void* p_cb_data) dvbpsi_nit_callback pf_callback, void* p_cb_data)
* \brief Creation and initialization of a NIT decoder. It is attached to p_dvbpsi. * \brief Creation and initialization of a NIT decoder. It is attached to p_dvbpsi.
* \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.
* \param i_table_id Table ID, 0x4E, 0x4F, or 0x50-0x6F. * \param i_table_id Table ID, 0x40 (actual) or 0x41 (other).
* \param i_extension Table ID extension, here service ID. * \param i_extension Table ID extension, here network ID.
* \param pf_callback function to call back on new NIT. * \param pf_callback function to call back on new NIT.
* \param p_cb_data private data given in argument to the callback. * \param p_cb_data private data given in argument to the callback.
* \return true on success, false on failure * \return true on success, false on failure
...@@ -130,8 +130,8 @@ bool dvbpsi_nit_attach(dvbpsi_t* p_dvbpsi, uint8_t i_table_id, uint16_t i_extens ...@@ -130,8 +130,8 @@ bool dvbpsi_nit_attach(dvbpsi_t* p_dvbpsi, uint8_t i_table_id, uint16_t i_extens
uint16_t i_extension) uint16_t i_extension)
* \brief Destroy a NIT decoder. * \brief Destroy a NIT 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.
* \param i_table_id Table ID, 0x4E, 0x4F, or 0x50-0x6F. * \param i_table_id Table ID, 0x40 (actual) or 0x41 (other).
* \param i_extension Table ID extension, here service ID. * \param i_extension Table ID extension, here network ID.
* \return nothing. * \return nothing.
*/ */
void dvbpsi_nit_detach(dvbpsi_t* p_dvbpsi, uint8_t i_table_id, void dvbpsi_nit_detach(dvbpsi_t* p_dvbpsi, uint8_t i_table_id,
...@@ -144,8 +144,8 @@ void dvbpsi_nit_detach(dvbpsi_t* p_dvbpsi, uint8_t i_table_id, ...@@ -144,8 +144,8 @@ void dvbpsi_nit_detach(dvbpsi_t* p_dvbpsi, uint8_t i_table_id,
* \fn void dvbpsi_nit_init(dvbpsi_nit_t* p_nit, uint8_t i_table_id, uint16_t i_extension, * \fn void dvbpsi_nit_init(dvbpsi_nit_t* p_nit, uint8_t i_table_id, uint16_t i_extension,
uint16_t i_network_id, uint8_t i_version, bool b_current_next) uint16_t i_network_id, uint8_t i_version, bool b_current_next)
* \brief Initialize a user-allocated dvbpsi_nit_t structure. * \brief Initialize a user-allocated dvbpsi_nit_t structure.
* \param i_table_id Table ID, 0x4E, 0x4F, or 0x50-0x6F. * \param i_table_id Table ID, 0x40 (actual) or 0x41 (other).
* \param i_extension Table ID extension, here service ID. * \param i_extension Table ID extension, here network ID.
* \param p_nit pointer to the NIT structure * \param p_nit pointer to the NIT structure
* \param i_network_id network id * \param i_network_id network id
* \param i_version NIT version * \param i_version NIT version
...@@ -160,8 +160,8 @@ void dvbpsi_nit_init(dvbpsi_nit_t* p_nit, uint8_t i_table_id, uint16_t i_extensi ...@@ -160,8 +160,8 @@ void dvbpsi_nit_init(dvbpsi_nit_t* p_nit, uint8_t i_table_id, uint16_t i_extensi
* uint16_t i_network_id, uint8_t i_version, * uint16_t i_network_id, uint8_t i_version,
* bool b_current_next); * bool b_current_next);
* \brief Allocate and initialize a new dvbpsi_nit_t structure. * \brief Allocate and initialize a new dvbpsi_nit_t structure.
* \param i_table_id Table ID, 0x4E, 0x4F, or 0x50-0x6F. * \param i_table_id Table ID, 0x40 (actual) or 0x41 (other)
* \param i_extension Table ID extension, here service ID. * \param i_extension Table ID extension, here network ID.
* \param i_network_id network id * \param i_network_id network id
* \param i_version NIT version * \param i_version NIT version
* \param b_current_next current next indicator * \param b_current_next current next indicator
......
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