Commit 52d1a27c authored by Jean-Paul Saman's avatar Jean-Paul Saman

src/descriptors: doxygen documentation fixes.

Fix not document functions and wrongly documented functions.
parent bddf441f
...@@ -84,7 +84,7 @@ dvbpsi_stuffing_dr_t* dvbpsi_DecodeStuffingDr( ...@@ -84,7 +84,7 @@ dvbpsi_stuffing_dr_t* dvbpsi_DecodeStuffingDr(
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenStuffingDr( * \fn dvbpsi_descriptor_t * dvbpsi_GenStuffingDr(
dvbpsi_stuffing_data_dr_t * p_decoded, int b_duplicate) dvbpsi_stuffing_dr_t *p_decoded, int b_duplicate)
* \brief "stuffing" descriptor generator. * \brief "stuffing" descriptor generator.
* \param p_decoded pointer to a decoded "stuffing" descriptor * \param p_decoded pointer to a decoded "stuffing" descriptor
* structure * structure
......
...@@ -79,7 +79,7 @@ dvbpsi_stream_identifier_dr_t* dvbpsi_DecodeStreamIdentifierDr( ...@@ -79,7 +79,7 @@ dvbpsi_stream_identifier_dr_t* dvbpsi_DecodeStreamIdentifierDr(
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenStreamIdentifierDr( * \fn dvbpsi_descriptor_t * dvbpsi_GenStreamIdentifierDr(
dvbpsi_service_dr_t * p_decoded, int b_duplicate) dvbpsi_stream_identifier_dr_t *p_decoded, int b_duplicate)
* \brief "stream identifier" descriptor generator. * \brief "stream identifier" descriptor generator.
* \param p_decoded pointer to a decoded "stream identifier" descriptor * \param p_decoded pointer to a decoded "stream identifier" descriptor
* structure * structure
......
...@@ -89,7 +89,7 @@ typedef struct dvbpsi_teletext_dr_s ...@@ -89,7 +89,7 @@ typedef struct dvbpsi_teletext_dr_s
* dvbpsi_DecodeTeletextDataDr * dvbpsi_DecodeTeletextDataDr
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \fn dvbpsi_teletext_dr_t * dvbpsi_DecodeTeletextDataDr( * \fn dvbpsi_teletext_dr_t * dvbpsi_DecodeTeletextDr(
dvbpsi_descriptor_t * p_descriptor) dvbpsi_descriptor_t * p_descriptor)
* \brief "teletext" descriptor decoder. * \brief "teletext" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure * \param p_descriptor pointer to the descriptor structure
......
...@@ -108,7 +108,7 @@ dvbpsi_local_time_offset_dr_t* dvbpsi_DecodeLocalTimeOffsetDr( ...@@ -108,7 +108,7 @@ dvbpsi_local_time_offset_dr_t* dvbpsi_DecodeLocalTimeOffsetDr(
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenLocalTimeOffsetDr( * \fn dvbpsi_descriptor_t * dvbpsi_GenLocalTimeOffsetDr(
dvbpsi_local_time_offset_data_dr_t * p_decoded, int b_duplicate) dvbpsi_local_time_offset_dr_t * p_decoded, int b_duplicate)
* \brief "local time offset" descriptor generator. * \brief "local time offset" descriptor generator.
* \param p_decoded pointer to a decoded "local time offset" descriptor * \param p_decoded pointer to a decoded "local time offset" descriptor
* structure * structure
......
...@@ -78,7 +78,7 @@ dvbpsi_PDC_dr_t* dvbpsi_DecodePDCDr(dvbpsi_descriptor_t * p_descriptor); ...@@ -78,7 +78,7 @@ dvbpsi_PDC_dr_t* dvbpsi_DecodePDCDr(dvbpsi_descriptor_t * p_descriptor);
* dvbpsi_GenPDCDr * dvbpsi_GenPDCDr
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenVStreamDr( * \fn dvbpsi_descriptor_t * dvbpsi_GenPDCDr(
dvbpsi_PDC_dr_t * p_decoded, int b_duplicate) dvbpsi_PDC_dr_t * p_decoded, int b_duplicate)
* \brief PDC descriptor generator. * \brief PDC descriptor generator.
* \param p_decoded pointer to a decoded PDC descriptor structure * \param p_decoded pointer to a decoded PDC descriptor structure
......
...@@ -85,7 +85,7 @@ dvbpsi_cuei_dr_t * dvbpsi_DecodeCUEIDr(dvbpsi_descriptor_t * p_descriptor) ...@@ -85,7 +85,7 @@ dvbpsi_cuei_dr_t * dvbpsi_DecodeCUEIDr(dvbpsi_descriptor_t * p_descriptor)
/***************************************************************************** /*****************************************************************************
* dvbpsi_GenCUEIDr * dvbpsi_GenCUEIDr
*****************************************************************************/ *****************************************************************************/
dvbpsi_descriptor_t * dvbpsi_GenCUEIDr(dvbpsi_cuei_dr_t * p_decoded) dvbpsi_descriptor_t * dvbpsi_GenCUEIDr(dvbpsi_cuei_dr_t * p_decoded, int b_duplicate)
{ {
/* Create the descriptor */ /* Create the descriptor */
dvbpsi_descriptor_t * p_descriptor = dvbpsi_descriptor_t * p_descriptor =
......
...@@ -84,7 +84,7 @@ dvbpsi_cuei_dr_t* dvbpsi_DecodeCUEIDr(dvbpsi_descriptor_t * p_descriptor); ...@@ -84,7 +84,7 @@ dvbpsi_cuei_dr_t* dvbpsi_DecodeCUEIDr(dvbpsi_descriptor_t * p_descriptor);
* the descriptor * the descriptor
* \return a pointer to a new descriptor structure which contains encoded data. * \return a pointer to a new descriptor structure which contains encoded data.
*/ */
dvbpsi_descriptor_t * dvbpsi_GenCUEIDr(dvbpsi_cuei_dr_t * p_decoded); dvbpsi_descriptor_t * dvbpsi_GenCUEIDr(dvbpsi_cuei_dr_t * p_decoded, int b_duplicate);
#ifdef __cplusplus #ifdef __cplusplus
......
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