src/tables: Documentation fixes

Correct function definitions in doxygen blocks.

src/demux.h

@@ -126,7 +126,7 @@ struct dvbpsi_demux_s
  * dvbpsi_AttachDemux
  *****************************************************************************/
 /*!
- * \fn dvbpsi_t *dvbpsi_NewPSISection(dvbpsi_t *p_dvbpsi, dvbpsi_demux_new_cb_t pf_new_cb, void * p_new_cb_data)
+ * \fn dvbpsi_t *dvbpsi_AttachDemux(dvbpsi_t *p_dvbpsi, dvbpsi_demux_new_cb_t pf_new_cb, void * p_new_cb_data)
  * \brief Creates a new demux structure.
  * \param p_dvbpsi pointer to dvbpsi_t handle
  * \param pf_new_cb A callcack called when a new type of subtable is found.
@@ -141,7 +141,7 @@ dvbpsi_t *dvbpsi_AttachDemux(dvbpsi_t *            p_dvbpsi,
  * dvbpsi_DetachDemux
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_DetachDemux(dvbpsi_decoder_t *p_decoder)
+ * \fn void dvbpsi_DetachDemux(dvbpsi_t *p_dvbpsi)
  * \brief Destroys a demux structure.
  * \param h_dvbpsi The handle of the demux to be destroyed.
  */

src/dvbpsi.c

@@ -182,7 +182,7 @@ dvbpsi_decoder_t *dvbpsi_NewDecoder(dvbpsi_t *handle, dvbpsi_callback *callback)
 }
 
 /*****************************************************************************
- * dvbpsi_DeletDecoder
+ * dvbpsi_DeleteDecoder
  *****************************************************************************/
 void dvbpsi_DeleteDecoder(dvbpsi_t *handle)
 {

src/dvbpsi.h

@@ -91,7 +91,7 @@ struct dvbpsi_s
  * dvbpsi_NewHandle
  *****************************************************************************/
 /*!
- * \fn dvbpsi_t *dvbpsi_NewHandle(dvbpsi_message_cb *callback)
+ * \fn dvbpsi_t *dvbpsi_NewHandle(dvbpsi_message_cb *callback, int level)
  * \brief Create a new dvbpsi_t handle to be used by PSI decoders or encoders
  * \param callback message callback handler, if NULL then no errors, warnings
  *        or debug messages will be sent to the caller application
@@ -122,15 +122,15 @@ void dvbpsi_DeleteHandle(dvbpsi_t *handle);
  * dvbpsi_PushPacket
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_PushPacket(dvbpsi_handle h_dvbpsi, uint8_t* p_data)
+ * \fn void dvbpsi_PushPacket(dvbpsi_t *p_dvbpsi, uint8_t* p_data)
  * \brief Injection of a TS packet into a PSI decoder.
- * \param h_dvbpsi handle to the decoder
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param p_data pointer to a 188 bytes playload of a TS packet
  * \return nothing.
  *
  * Injection of a TS packet into a PSI decoder.
  */
-void dvbpsi_PushPacket(dvbpsi_t * h_dvbpsi, uint8_t* p_data);
+void dvbpsi_PushPacket(dvbpsi_t *p_dvbpsi, uint8_t* p_data);
 
 /*****************************************************************************
  * The following definitions are just here to allow external decoders but
@@ -188,29 +188,30 @@ struct dvbpsi_decoder_s
  * dvbpsi_NewDecoder
  *****************************************************************************/
 /*!
- * \fn dvbpsi_decoder_t *dvbpsi_NewDecoder(dvbpsi_t *handle, dvbpsi_callback *callback)
+ * \fn dvbpsi_decoder_t *dvbpsi_NewDecoder(dvbpsi_t *p_dvbpsi, dvbpsi_callback *callback)
  * \brief Create a new dvbpsi_decoder_t.
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param callback dvbpsi_callback handler
  * \return pointer to dvbpsi_decoder_t&
  *
  * Creates a dvbpsi_decoder_t pointer to struct dvbpsi_decoder_s. It should be
  * delete with dvbpsi_DeleteDecoder() function.
  */
-dvbpsi_decoder_t *dvbpsi_NewDecoder(dvbpsi_t *handle, dvbpsi_callback *callback);
+dvbpsi_decoder_t *dvbpsi_NewDecoder(dvbpsi_t *p_dvbpsi, dvbpsi_callback *callback);
 
 /*****************************************************************************
- * dvbpsi_DeletDecoder
+ * dvbpsi_DeleteDecoder
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_DeleteDecoder(dvbpsi_t *handle);
+ * \fn void dvbpsi_DeleteDecoder(dvbpsi_t *p_dvbpsi);
  * \brief Deletes attached decoder struct from dvbpsi_t handle and frees its memory
- * \param pointer to dvbpsi_t malloced data
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \return nothing
  *
  * Delets a dvbpsi_t handle by calling free(handle). Make sure to detach any
  * decoder of encoder before deleting the dvbpsi handle.
  */
-void dvbpsi_DeleteDecoder(dvbpsi_t *handle);
+void dvbpsi_DeleteDecoder(dvbpsi_t *p_dvbpsi);
 
 #ifdef __cplusplus
 };

src/tables/bat.h

@@ -206,8 +206,9 @@ do {                                                                    \
  * dvbpsi_GenBATSections
  *****************************************************************************/
 /*!
- * \fn dvbpsi_psi_section_t* dvbpsi_GenBATSections(dvbpsi_bat_t* p_bat)
+ * \fn dvbpsi_psi_section_t* dvbpsi_GenBATSections(dvbpsi_t *p_dvbpsi, dvbpsi_bat_t* p_bat)
  * \brief BAT generator
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param p_bat BAT structure
  * \return a pointer to the list of generated PSI sections.
  *

src/tables/cat.h

@@ -92,8 +92,9 @@ dvbpsi_t *dvbpsi_AttachCAT(dvbpsi_t *p_dvbpsi, dvbpsi_cat_callback pf_callback,
  * dvbpsi_DetachCAT
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_DetachCAT(dvbpsi_handle h_dvbpsi)
+ * \fn void dvbpsi_DetachCAT(dvbpsi_t *p_dvbpsi)
  * \brief Destroy a CAT decoder.
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param p_dvbpsi handle holds the decoder pointer
  * \return nothing.
  *
@@ -179,9 +180,9 @@ dvbpsi_descriptor_t* dvbpsi_CATAddDescriptor(dvbpsi_cat_t* p_cat,
  * dvbpsi_GenCATSections
  *****************************************************************************/
 /*!
- * \fn dvbpsi_psi_section_t* dvbpsi_GenCATSections(dvbpsi_cat_t* p_cat)
+ * \fn dvbpsi_psi_section_t* dvbpsi_GenCATSections(dvbpsi_t *p_dvbpsi, dvbpsi_cat_t* p_cat)
  * \brief CAT generator
- * \param p_dvbpsi is a pointer to dvbpsi_t
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param p_cat CAT structure
  * \return a pointer to the list of generated PSI sections.
  *

src/tables/eit.h

@@ -131,7 +131,7 @@ dvbpsi_t *dvbpsi_AttachEIT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id,
  * dvbpsi_DetachEIT
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_DetachEIT(dvbpsi_demux_t * p_demux, uint8_t i_table_id,
+ * \fn void dvbpsi_DetachEIT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id,
           uint16_t i_extension)
  * \brief Destroy a EIT decoder.
  * \param p_dvbpsi dvbpsi handle pointing to Subtable demultiplexor to which the

src/tables/nit.h

@@ -125,7 +125,7 @@ int dvbpsi_AttachNIT(dvbpsi_t* p_dvbpsi, uint8_t i_table_id,
  * dvbpsi_DetachNIT
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_DetachNIT(dvbpsi_demux_t * p_demux, uint8_t i_table_id,
+ * \fn void dvbpsi_DetachNIT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id,
                              uint16_t i_extension)
  * \brief Destroy a NIT decoder.
  * \param p_dvbpsi dvbpsi handle to Subtable demultiplexor to which the decoder is attached.
@@ -218,10 +218,10 @@ dvbpsi_descriptor_t* dvbpsi_NITAddDescriptor(dvbpsi_nit_t* p_nit,
  *****************************************************************************/
 /*!
  * \fn dvbpsi_nit_ts_t* dvbpsi_NITAddTS(dvbpsi_nit_t* p_nit,
-                                        uint8_t i_type, uint16_t i_pid)
+                                        uint8_t i_ts_id, uint16_t i_orig_network_id)
  * \brief Add an TS in the NIT.
  * \param p_nit pointer to the NIT structure
- * \param i_type type of TS
+ * \param i_ts_id type of TS
  * \param i_pid PID of the TS
  * \return a pointer to the added TS.
  */
@@ -251,10 +251,10 @@ dvbpsi_descriptor_t* dvbpsi_NITTSAddDescriptor(dvbpsi_nit_ts_t* p_ts,
  * dvbpsi_GenNITSections
  *****************************************************************************/
 /*!
- * \fn dvbpsi_psi_section_t* dvbpsi_GenNITSections(dvbpsi_nit_t* p_nit,
+ * \fn dvbpsi_psi_section_t* dvbpsi_GenNITSections(dvbpsi_t *p_dvbpsi, dvbpsi_nit_t* p_nit,
                                                    uint8_t i_table_id)
  * \brief NIT generator
- * \parma p_dvbpsi dvbpsi handle
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param p_nit NIT structure
  * \param i_table_id table id, 0x40 = actual network / 0x41 = other network
  * \return a pointer to the list of generated PSI sections.

src/tables/pat.h

@@ -98,14 +98,13 @@ typedef struct dvbpsi_pat_s
  */
 typedef void (* dvbpsi_pat_callback)(void* p_cb_data, dvbpsi_pat_t* p_new_pat);
 
-
 /*****************************************************************************
  * dvbpsi_AttachPAT
  *****************************************************************************/
 /*!
- * \fn dvbpsi_t *dvbpsi_AttachPAT(dvbpsi_pat_callback pf_callback, void* p_cb_data)
+ * \fn dvbpsi_t *dvbpsi_AttachPAT(dvbpsi_t *p_dvbpsi, dvbpsi_pat_callback pf_callback, void* p_cb_data)
  * \brief Creation and initialization of a PAT decoder.
- * \param p_dvbpsi pointer to dvbpsi_t handle
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param pf_callback function to call back on new PAT
  * \param p_cb_data private data given in argument to the callback
  * \return a pointer to the decoder for future calls.
@@ -113,7 +112,6 @@ typedef void (* dvbpsi_pat_callback)(void* p_cb_data, dvbpsi_pat_t* p_new_pat);
 dvbpsi_t *dvbpsi_AttachPAT(dvbpsi_t *p_dvbpsi, dvbpsi_pat_callback pf_callback,
                            void* p_cb_data);
 
-
 /*****************************************************************************
  * dvbpsi_DetachPAT
  *****************************************************************************/
@@ -127,7 +125,6 @@ dvbpsi_t *dvbpsi_AttachPAT(dvbpsi_t *p_dvbpsi, dvbpsi_pat_callback pf_callback,
  */
 void dvbpsi_DetachPAT(dvbpsi_t *p_dvbpsi);
 
-
 /*****************************************************************************
  * dvbpsi_InitPAT/dvbpsi_NewPAT
  *****************************************************************************/
@@ -160,7 +157,6 @@ do {                                                                    \
     dvbpsi_InitPAT(p_pat, i_ts_id, i_version, b_current_next);          \
 } while(0);
 
-
 /*****************************************************************************
  * dvbpsi_EmptyPAT/dvbpsi_DeletePAT
  *****************************************************************************/
@@ -184,7 +180,6 @@ do {                                                                    \
   free(p_pat);                                                          \
 } while(0);
 
-
 /*****************************************************************************
  * dvbpsi_PATAddProgram
  *****************************************************************************/
@@ -205,10 +200,10 @@ dvbpsi_pat_program_t* dvbpsi_PATAddProgram(dvbpsi_pat_t* p_pat,
  * dvbpsi_GenPATSections
  *****************************************************************************/
 /*!
- * \fn dvbpsi_psi_section_t* dvbpsi_GenPATSections(dvbpsi_pat_t* p_pat,
+ * \fn dvbpsi_psi_section_t* dvbpsi_GenPATSections(dvbpsi_t *p_dvbpsi, dvbpsi_pat_t* p_pat,
                                                    int i_max_pps);
  * \brief PAT generator.
- * \param p_dvbpsi is a pointer to dvbpsi_t
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param p_pat pointer to the PAT structure
  * \param i_max_pps limitation of the number of program in each section
  * (max: 253).

src/tables/pmt.h

@@ -255,7 +255,7 @@ dvbpsi_descriptor_t* dvbpsi_PMTESAddDescriptor(dvbpsi_pmt_es_t* p_es,
  * \fn dvbpsi_psi_section_t* dvbpsi_GenPMTSections(dvbpsi_t *p_dvbpsi,
                                                    dvbpsi_pmt_t* p_pmt)
  * \brief PMT generator
- * \param p_dvbpsi is a pointer to dvbpsi_t
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param p_pmt PMT structure
  * \return a pointer to the list of generated PSI sections.
  *

src/tables/sdt.h

@@ -110,7 +110,7 @@ typedef void (* dvbpsi_sdt_callback)(void* p_cb_data, dvbpsi_sdt_t* p_new_sdt);
  * dvbpsi_AttachSDT
  *****************************************************************************/
 /*!
- * \fn int dvbpsi_AttachSDT(dvbpsi_demux_t * p_demux, uint8_t i_table_id,
+ * \fn int dvbpsi_AttachSDT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id,
           uint16_t i_extension, dvbpsi_sdt_callback pf_callback,
                                void* p_cb_data)
  * \brief Creation and initialization of a SDT decoder.
@@ -129,7 +129,7 @@ dvbpsi_t *dvbpsi_AttachSDT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id,
  * dvbpsi_DetachSDT
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_DetachSDT(dvbpsi_demux_t *p_demux, uint8_t i_table_id,
+ * \fn void dvbpsi_DetachSDT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id,
                              uint16_t i_extension)
  * \brief Destroy a SDT decoder.
  * \param p_dvbpsi pointer holding decoder/demuxer structure
@@ -248,11 +248,11 @@ dvbpsi_descriptor_t *dvbpsi_SDTServiceAddDescriptor(
  * \fn dvbpsi_psi_section_t* dvbpsi_GenSDTSections(dvbpsi_t *p_dvbpsi,
                                                     dvbpsi_sdt_t * p_sdt)
  * \brief SDT generator
- * \param p_dvbpsi is a pointer to dvbpsi_t
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param p_sdt SDT structure
  * \return a pointer to the list of generated PSI sections.
  *
- * Generate PMT sections based on the dvbpsi_pmt_t structure.
+ * Generate SDT sections based on the dvbpsi_sdt_t structure.
  */
 dvbpsi_psi_section_t *dvbpsi_GenSDTSections(dvbpsi_t *p_dvbpsi, dvbpsi_sdt_t * p_sdt);
 

src/tables/sis.h

@@ -108,7 +108,7 @@ typedef void (* dvbpsi_sis_callback)(void* p_cb_data, dvbpsi_sis_t* p_new_sis);
  * dvbpsi_AttachSIS
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_AttachSIS(dvbpsi_demux_t * p_demux, uint8_t i_table_id,
+ * \fn void dvbpsi_AttachSIS(dvbpsi_t *p_dvbpsi, uint8_t i_table_id,
           uint16_t i_extension, dvbpsi_sis_callback pf_callback,
                                void* p_cb_data)
  * \brief Creation and initialization of a SIS decoder.
@@ -127,8 +127,8 @@ int dvbpsi_AttachSIS(dvbpsi_t* p_dvbpsi, uint8_t i_table_id,
  * dvbpsi_DetachSIS
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_DetachSIS(dvbpsi_demux_t * p_demux, uint8_t i_table_id,
-          uint16_t i_extension)
+ * \fn void dvbpsi_DetachSIS(dvbpsi_t *p_dvbpsi, uint8_t i_table_id,
+                             uint16_t i_extension)
  * \brief Destroy a SIS decoder.
  * \param p_dvbpsi pointer to dvbpsi to hold decoder/demuxer structure
  * \param i_table_id Table ID, 0xFC.
@@ -142,8 +142,7 @@ void dvbpsi_DetachSIS(dvbpsi_t *p_dvbpsi, uint8_t i_table_id,
  * dvbpsi_InitSIS/dvbpsi_NewSIS
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_InitSIS(dvbpsi_sis_t* p_sis, uint16_t i_ts_id,
-          uint8_t i_version, int b_current_next, uint16_t i_network_id)
+ * \fn void dvbpsi_InitSIS(dvbpsi_sis_t* p_sis, uint8_t i_protocol_version)
  * \brief Initialize a user-allocated dvbpsi_sis_t structure.
  * \param p_sis pointer to the SIS structure
  * \param i_protocol_version SIS protocol version (currently 0)
@@ -211,6 +210,15 @@ dvbpsi_descriptor_t *dvbpsi_SISAddDescriptor(dvbpsi_sis_t *p_sis,
  *****************************************************************************
  * Generate SIS sections based on the dvbpsi_sis_t structure.
  *****************************************************************************/
+/*!
+ * \fn dvbpsi_psi_section_t *dvbpsi_GenSISSections(dvbpsi_t *p_dvbpsi, dvbpsi_sis_t * p_sis);
+ * \brief SIS generator
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
+ * \param p_sis SIS structure
+ * \return a pointer to the list of generated PSI sections.
+ *
+ * Generate SIS sections based on the dvbpsi_sis_t structure.
+ */
 dvbpsi_psi_section_t *dvbpsi_GenSISSections(dvbpsi_t *p_dvbpsi, dvbpsi_sis_t * p_sis);
 
 #ifdef __cplusplus

src/tables/tot.h

@@ -78,7 +78,7 @@ typedef void (* dvbpsi_tot_callback)(void* p_cb_data, dvbpsi_tot_t* p_new_tot);
  * dvbpsi_AttachTOT
  *****************************************************************************/
 /*!
- * \fn int dvbpsi_AttachTOT(dvbpsi_t* p_dvbpsi, uint8_t i_table_id,
+ * \fn int dvbpsi_AttachTOT(dvbpsi_t* p_dvbpsi, uint8_t i_table_id, uint16_t i_extension,
                             dvbpsi_tot_callback pf_callback, void* p_cb_data)
  * \brief Creation and initialization of a TDT/TOT decoder.
  * \param p_dvbpsi dvbpsi handle pointing to Subtable demultiplexor to which the decoder is attached.
@@ -96,7 +96,7 @@ int dvbpsi_AttachTOT(dvbpsi_t* p_dvbpsi, uint8_t i_table_id,
  * dvbpsi_DetachTOT
  *****************************************************************************/
 /*!
- * \fn int dvbpsi_DetachTOT(dvbpsi_demux_t * p_demux, uint8_t i_table_id)
+ * \fn int dvbpsi_DetachTOT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension)
  * \brief Destroy a TDT/TOT decoder.
  * \param p_demux Subtable demultiplexor to which the decoder is attached.
  * \param i_table_id Table ID, usually 0x70
@@ -110,7 +110,7 @@ void dvbpsi_DetachTOT(dvbpsi_t* p_dvbpsi, uint8_t i_table_id,
  * dvbpsi_InitTOT/dvbpsi_NewTOT
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_InitTOT(dvbpsi_tot_t* p_tot)
+ * \fn void dvbpsi_InitTOT(dvbpsi_tot_t* p_tot, uint64_t i_utc_time)
  * \brief Initialize a user-allocated dvbpsi_tot_t structure.
  * \param p_tot pointer to the TDT/TOT structure
  * \param i_utc_time the time in UTC
@@ -119,7 +119,7 @@ void dvbpsi_DetachTOT(dvbpsi_t* p_dvbpsi, uint8_t i_table_id,
 void dvbpsi_InitTOT(dvbpsi_tot_t* p_tot, uint64_t i_utc_time);
 
 /*!
- * \def dvbpsi_NewTOT(p_tot)
+ * \def dvbpsi_NewTOT(p_tot, i_utc_time)
  * \brief Allocate and initialize a new dvbpsi_tot_t structure.
  * \param p_tot pointer to the TDT/TOT structure
  * \param i_utc_time the time in UTC
@@ -178,9 +178,9 @@ dvbpsi_descriptor_t* dvbpsi_TOTAddDescriptor(dvbpsi_tot_t* p_tot,
  * dvbpsi_GenTOTSections
  *****************************************************************************/
 /*!
- * \fn dvbpsi_psi_section_t* dvbpsi_GenTOTSections(dvbpsi_Ttot_t* p_tot)
+ * \fn dvbpsi_psi_section_t* dvbpsi_GenTOTSections(dvbpsi_t *p_dvbpsi, dvbpsi_Ttot_t* p_tot)
  * \brief TDT/TOT generator
- * \param p_dvbpsi dvbpsi handle
+ * \param p_dvbpsi handle to dvbpsi with attached decoder
  * \param p_tot TDT/TOT structure
  * \return a pointer to the list of generated PSI sections.
  *