Documentation updates.

src/descriptors/dr_7c.h

@@ -41,12 +41,9 @@ extern "C" {
  * dvbpsi_aac_dr_t
  *****************************************************************************/
 /*!
- * \struct dvbpsi_aac_dr_s
- * \brief "AAC Audio" descriptor structure.
- *
- * The AAC Audio descriptor is used to label the PIDs that carry AAC audio data.
+ * \enum dvbpsi_aac_profile_and_level_s
+ * \brief enumeration of AAC profile and levels as specified in ISO/IEC 13818-1:2007 table 2.71
  */
-
 /*!
  * \typedef enum dvbpsi_aac_profile_and_level_s dvbpsi_aac_profile_and_level_t
  * \brief AAC profile and level as specified in ISO/IEC 13818-1:2007 table 2.71
@@ -171,6 +168,13 @@ typedef enum dvbpsi_aac_profile_and_level_s
     /* 0x5C-0xFF RESERVED */
 } dvbpsi_aac_profile_and_level_t;
 
+/*!
+ * \enum dvbpsi_aac_type_s
+ * \brief AAC type information as described in table 26, page 41 where column
+ *
+ * The AAC Audio descriptor is used to label the PIDs that carry AAC audio data.
+ * 'stream_content' has value 0x06 as specified in ISO/IEC 13818-1:2007.
+ */
 /*!
  * \typedef enum dvbpsi_aac_type_s dvbpsi_aac_type_t
  * \brief   AAC type information as descripted in table 26, page 41 where column
@@ -233,6 +237,12 @@ typedef enum dvbpsi_aac_type_s
     DVBPSI_AAC_RESERVED5 = 0xFF /*!< reserved for future use */
 } dvbpsi_aac_type_t;
 
+/*!
+ * \struct dvbpsi_aac_dr_s
+ * \brief "AAC Audio" descriptor structure.
+ *
+ * The AAC Audio descriptor is used to label the PIDs that carry AAC audio data.
+ */
 /*!
  * \typedef struct dvbpsi_aac_dr_s dvbpsi_aac_dr_t
  * \brief dvbpsi_aac_dr_t type definition.

src/dvbpsi.h

@@ -304,6 +304,11 @@ bool dvbpsi_decoder_present(dvbpsi_t *p_dvbpsi);
 typedef struct dvbpsi_decoder_s * dvbpsi_handle;// __attribute__((deprecated));
 
 /* dvbpsi.h */
+/*!
+ * \fn void dvbpsi_PushPacket(dvbpsi_handle h_dvbpsi, uint8_t* p_data)
+ * \brief function is deprecated and should no longer be used. Use
+ * function dvbpsi_packet_push() instead.
+ */
 __attribute__((deprecated))
 void dvbpsi_PushPacket(dvbpsi_handle h_dvbpsi, uint8_t* p_data);
 #define dvbpsi_PushPacket(h,p)  dvbpsi_packet_push(h,p)

src/tables/bat.h

@@ -185,7 +185,7 @@ dvbpsi_bat_t *dvbpsi_bat_new(uint16_t i_bouquet_id, uint8_t i_version,
 void dvbpsi_bat_empty(dvbpsi_bat_t *p_bat);
 
 /*!
- * \fn dvbpsi_DeleteBAT(dvbpsi_bat_t *p_bat)
+ * \fn dvbpsi_bat_delete(dvbpsi_bat_t *p_bat)
  * \brief Clean and free a dvbpsi_bat_t structure.
  * \param p_bat pointer to the BAT structure
  * \return nothing.

src/tables/pmt.h

@@ -178,7 +178,7 @@ dvbpsi_pmt_t* dvbpsi_pmt_new(uint16_t i_program_number, uint8_t i_version,
 void dvbpsi_pmt_empty(dvbpsi_pmt_t* p_pmt);
 
 /*!
- * \fn void dvbpsi_DeletePMT(dvbpsi_pmt_t* p_pmt)
+ * \fn void dvbpsi_pmt_delete(dvbpsi_pmt_t* p_pmt)
  * \brief Clean and free a dvbpsi_pmt_t structure.
  * \param p_pmt pointer to the PMT structure
  * \return nothing.

src/tables/rst.h

@@ -68,7 +68,7 @@ typedef struct dvbpsi_rst_event_s
  * dvbpsi_rst_t
  *****************************************************************************/
 /*!
- * \struct dvbpsi_rst_t
+ * \struct dvbpsi_rst_s
  * \brief RST structure.
  *
  * This structure is used to store a decoded RST service description.
@@ -127,8 +127,7 @@ void dvbpsi_rst_detach(dvbpsi_t *p_dvbpsi);
  * dvbpsi_rst_init/dvbpsi_rst_new
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_rst_init(dvbpsi_rst_t* p_rst,
-                           uint8_t i_version, bool b_current_next)
+ * \fn void dvbpsi_rst_init(dvbpsi_rst_t* p_rst)
  * \brief Initialize a user-allocated dvbpsi_cat_t structure.
  * \param p_rst pointer to the RST structure
  * \return nothing.
@@ -136,8 +135,7 @@ void dvbpsi_rst_detach(dvbpsi_t *p_dvbpsi);
 void dvbpsi_rst_init(dvbpsi_rst_t* p_rst);
 
 /*!
- * \fn dvbpsi_rst_t *dvbpsi_rst_new(uint8_t i_version,
- *                                  bool b_current_next)
+ * \fn dvbpsi_rst_t *dvbpsi_rst_new(void)
  * \brief Allocate and initialize a new dvbpsi_rst_t structure.
  * \return p_rst pointer to the RST structure
  */

src/tables/sis.h

@@ -379,7 +379,8 @@ void dvbpsi_sis_detach(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extens
  * dvbpsi_sis_init/dvbpsi_sis_new
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_sis_init(dvbpsi_sis_t* p_sis, uint8_t i_protocol_version)
+ * \fn void dvbpsi_sis_init(dvbpsi_sis_t *p_sis, uint16_t i_ts_id, uint8_t i_version,
+                    bool b_current_next, uint8_t i_protocol_version);
  * \brief Initialize a user-allocated dvbpsi_sis_t structure.
  * \param p_sis pointer to the SIS structure
  * \param i_ts_id transport stream ID
@@ -392,7 +393,8 @@ void dvbpsi_sis_init(dvbpsi_sis_t *p_sis, uint16_t i_ts_id, uint8_t i_version,
                     bool b_current_next, uint8_t i_protocol_version);
 
 /*!
- * \fn dvbpsi_sis_t* dvbpsi_sis_new(uint8_t i_protocol_version)
+ * \fn dvbpsi_sis_t* dvbpsi_sis_new(uint16_t i_ts_id, uint8_t i_version,
+                            bool b_current_next, uint8_t i_protocol_version);
  * \brief Allocate and initialize a new dvbpsi_sis_t structure.
  * \param i_ts_id transport stream ID
  * \param i_version SIS version

src/tables/tot.h

@@ -114,7 +114,8 @@ void dvbpsi_tot_detach(dvbpsi_t* p_dvbpsi, uint8_t i_table_id,
  * dvbpsi_tot_init/dvbpsi_tot_new
  *****************************************************************************/
 /*!
- * \fn void dvbpsi_tot_init(dvbpsi_tot_t* p_tot, uint64_t i_utc_time)
+ * \fn void dvbpsi_tot_init(dvbpsi_tot_t* p_tot, uint16_t i_ts_id, uint8_t i_version,
+                    bool b_current_next, 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_ts_id transport stream ID
@@ -127,7 +128,8 @@ void dvbpsi_tot_init(dvbpsi_tot_t* p_tot, uint16_t i_ts_id, uint8_t i_version,
                     bool b_current_next, uint64_t i_utc_time);
 
 /*!
- * \fn dvbpsi_tot_t *dvbpsi_tot_new(uint64_t i_utc_time)
+ * \fn dvbpsi_tot_t *dvbpsi_tot_new(uint16_t i_ts_id, uint8_t i_version,
+                            bool b_current_next, uint64_t i_utc_time);
  * \brief Allocate and initialize a new dvbpsi_tot_t structure.
  * \param i_ts_id transport stream ID
  * \param i_version SDT version