Skip to content

L
libdvbpsi
Commit 5a62b3a6 authored by Arnaud de Bossoreille de Ribou's avatar Arnaud de Bossoreille de Ribou
Browse files
Options

* ALL: doc fixes.

parent 8b8a9736
Hide whitespace changes
Inline Side-by-side
Showing with 43 additions and 44 deletions
src/descriptors/dr_02.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_02.h
* (c)2001-2002 VideoLAN
* $Id: dr_02.h,v 1.2 2002/05/08 13:33:52 bozo Exp $
* $Id: dr_02.h,v 1.3 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -75,7 +75,7 @@ typedef struct dvbpsi_vstream_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_vstream_dr_t * dvbpsi_DecodeVStreamDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "video stream" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "video stream" descriptor structure which
......@@ -89,7 +89,7 @@ dvbpsi_vstream_dr_t* dvbpsi_DecodeVStreamDr(dvbpsi_descriptor_t * p_descriptor);
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenVStreamDr(
* dvbpsi_vstream_dr_t * p_decoded, int b_duplicate)
dvbpsi_vstream_dr_t * p_decoded, int b_duplicate)
* \brief "video stream" descriptor generator.
* \param p_decoded pointer to a decoded "video stream" descriptor structure
* \param b_duplicate if non zero then duplicate the p_decoded structure into
......
src/descriptors/dr_03.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_03.h
* (c)2001-2002 VideoLAN
* $Id: dr_03.h,v 1.1 2002/05/08 13:33:52 bozo Exp $
* $Id: dr_03.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -68,7 +68,7 @@ typedef struct dvbpsi_astream_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_astream_dr_t * dvbpsi_DecodeAStreamDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "audio stream" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "audio stream" descriptor structure which
......@@ -82,7 +82,7 @@ dvbpsi_astream_dr_t* dvbpsi_DecodeAStreamDr(dvbpsi_descriptor_t * p_descriptor);
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenAStreamDr(
* dvbpsi_astream_dr_t * p_decoded, int b_duplicate)
dvbpsi_astream_dr_t * p_decoded, int b_duplicate)
* \brief "audio stream" descriptor generator.
* \param p_decoded pointer to a decoded "video stream" descriptor structure
* \param b_duplicate if non zero then duplicate the p_decoded structure into
......
src/descriptors/dr_04.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_04.h
* (c)2001-2002 VideoLAN
* $Id: dr_04.h,v 1.1 2002/05/08 14:56:28 bozo Exp $
* $Id: dr_04.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -69,7 +69,7 @@ typedef struct dvbpsi_hierarchy_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_hierarchy_dr_t * dvbpsi_DecodeHierarchyDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "hierarchy" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "hierarchy" descriptor structure which
......@@ -84,7 +84,7 @@ dvbpsi_hierarchy_dr_t* dvbpsi_DecodeHierarchyDr(
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenHierarchyDr(
* dvbpsi_hierarchy_dr_t * p_decoded, int b_duplicate)
dvbpsi_hierarchy_dr_t * p_decoded, int b_duplicate)
* \brief "hierarchy" descriptor generator.
* \param p_decoded pointer to a decoded "hierarchy" descriptor structure
* \param b_duplicate if non zero then duplicate the p_decoded structure into
......
src/descriptors/dr_05.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_05.h
* (c)2001-2002 VideoLAN
* $Id: dr_05.h,v 1.1 2002/05/08 14:56:28 bozo Exp $
* $Id: dr_05.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -69,7 +69,7 @@ typedef struct dvbpsi_registration_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_registration_dr_t * dvbpsi_DecodeRegistrationDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "registration" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "registration" descriptor structure which
......@@ -84,7 +84,7 @@ dvbpsi_registration_dr_t* dvbpsi_DecodeRegistrationDr(
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenRegistrationDr(
* dvbpsi_registration_dr_t * p_decoded, int b_duplicate)
dvbpsi_registration_dr_t * p_decoded, int b_duplicate)
* \brief "registration" descriptor generator.
* \param p_decoded pointer to a decoded "registration" descriptor structure
* \param b_duplicate if non zero then duplicate the p_decoded structure into
......
src/descriptors/dr_06.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_06.h
* (c)2001-2002 VideoLAN
* $Id: dr_06.h,v 1.1 2002/05/08 15:55:32 bozo Exp $
* $Id: dr_06.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -66,7 +66,7 @@ typedef struct dvbpsi_ds_alignment_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_ds_alignment_dr_t * dvbpsi_DecodeDSAlignmentDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "data stream alignment" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "data stream alignment" descriptor structure
......@@ -81,7 +81,7 @@ dvbpsi_ds_alignment_dr_t* dvbpsi_DecodeDSAlignmentDr(
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenDSAlignmentDr(
* dvbpsi_ds_alignment_dr_t * p_decoded, int b_duplicate)
dvbpsi_ds_alignment_dr_t * p_decoded, int b_duplicate)
* \brief "data stream alignment" descriptor generator.
* \param p_decoded pointer to a decoded "data stream alignment" descriptor
* structure
......
src/descriptors/dr_07.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_07.h
* (c)2001-2002 VideoLAN
* $Id: dr_07.h,v 1.1 2002/05/08 15:55:32 bozo Exp $
* $Id: dr_07.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -68,7 +68,7 @@ typedef struct dvbpsi_target_bg_grid_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_target_bg_grid_dr_t * dvbpsi_DecodeTargetBgGridDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "target background grid" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "target background grid" descriptor structure
......@@ -83,7 +83,7 @@ dvbpsi_target_bg_grid_dr_t* dvbpsi_DecodeTargetBgGridDr(
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenTargetBgGridDr(
* dvbpsi_target_bg_grid_dr_t * p_decoded, int b_duplicate)
dvbpsi_target_bg_grid_dr_t * p_decoded, int b_duplicate)
* \brief "target background grid" descriptor generator.
* \param p_decoded pointer to a decoded "target background grid" descriptor
* structure
......
src/descriptors/dr_08.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_08.h
* (c)2001-2002 VideoLAN
* $Id: dr_08.h,v 1.2 2002/05/08 16:45:33 bozo Exp $
* $Id: dr_08.h,v 1.3 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -68,7 +68,7 @@ typedef struct dvbpsi_vwindow_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_vwindow_dr_t * dvbpsi_DecodeVWindowDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "video window" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "video window" descriptor structure which
......@@ -82,7 +82,7 @@ dvbpsi_vwindow_dr_t* dvbpsi_DecodeVWindowDr(dvbpsi_descriptor_t * p_descriptor);
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenVWindowDr(
* dvbpsi_vwindow_dr_t * p_decoded, int b_duplicate)
dvbpsi_vwindow_dr_t * p_decoded, int b_duplicate)
* \brief "video window" descriptor generator.
* \param p_decoded pointer to a decoded "video window" descriptor structure
* \param b_duplicate if non zero then duplicate the p_decoded structure into
......
src/descriptors/dr_09.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_09.h
* (c)2001-2002 VideoLAN
* $Id: dr_09.h,v 1.1 2002/05/08 16:45:33 bozo Exp $
* $Id: dr_09.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -70,7 +70,7 @@ typedef struct dvbpsi_ca_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_ca_dr_t * dvbpsi_DecodeCADr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "conditional access" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "conditional access" descriptor structure which
......@@ -84,7 +84,7 @@ dvbpsi_ca_dr_t* dvbpsi_DecodeCADr(dvbpsi_descriptor_t * p_descriptor);
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenCADr(
* dvbpsi_ca_dr_t * p_decoded, int b_duplicate)
dvbpsi_ca_dr_t * p_decoded, int b_duplicate)
* \brief "conditional access" descriptor generator.
* \param p_decoded pointer to a decoded "conditional access" descriptor
* structure
......
src/descriptors/dr_0a.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_0a.h
* (c)2001-2002 VideoLAN
* $Id: dr_0a.h,v 1.1 2002/05/08 16:45:33 bozo Exp $
* $Id: dr_0a.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -69,7 +69,7 @@ typedef struct dvbpsi_iso639_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_iso639_dr_t * dvbpsi_DecodeISO639Dr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "ISO 639 language" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "ISO 639 language" descriptor structure which
......@@ -83,7 +83,7 @@ dvbpsi_iso639_dr_t* dvbpsi_DecodeISO639Dr(dvbpsi_descriptor_t * p_descriptor);
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenISO639Dr(
* dvbpsi_iso639_dr_t * p_decoded, int b_duplicate)
dvbpsi_iso639_dr_t * p_decoded, int b_duplicate)
* \brief "ISO 639 language" descriptor generator.
* \param p_decoded pointer to a decoded "ISO 639 language" descriptor
* structure
......
src/descriptors/dr_0b.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_0b.h
* (c)2001-2002 VideoLAN
* $Id: dr_0b.h,v 1.1 2002/05/10 22:58:53 bozo Exp $
* $Id: dr_0b.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -69,7 +69,7 @@ typedef struct dvbpsi_system_clock_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_system_clock_dr_t * dvbpsi_DecodeSystemClockDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "system clock" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "system clock" descriptor structure which
......@@ -84,7 +84,7 @@ dvbpsi_system_clock_dr_t* dvbpsi_DecodeSystemClockDr(
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenSystemClockDr(
* dvbpsi_system_clock_dr_t * p_decoded, int b_duplicate)
dvbpsi_system_clock_dr_t * p_decoded, int b_duplicate)
* \brief "system clock" descriptor generator.
* \param p_decoded pointer to a decoded "system clock" descriptor
* structure
......
src/descriptors/dr_0c.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_0c.h
* (c)2001-2002 VideoLAN
* $Id: dr_0c.h,v 1.1 2002/05/10 22:58:53 bozo Exp $
* $Id: dr_0c.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -51,8 +51,7 @@ extern "C" {
* descriptor. (ISO/IEC 13818-1 section 2.6.22).
*/
/*!
* \typedef struct dvbpsi_mx_buff_utilization_dr_s
* dvbpsi_mx_buff_utilization_dr_t
* \typedef struct dvbpsi_mx_buff_utilization_dr_s dvbpsi_mx_buff_utilization_dr_t
* \brief dvbpsi_systemclock_dr_t type definition.
*/
typedef struct dvbpsi_mx_buff_utilization_dr_s
......@@ -69,7 +68,7 @@ typedef struct dvbpsi_mx_buff_utilization_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_mx_buff_utilization_dr_t * dvbpsi_DecodeMxBuffUtilizationDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "multiplex buffer utilization" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "multiplex buffer utilization" descriptor
......@@ -84,7 +83,7 @@ dvbpsi_mx_buff_utilization_dr_t* dvbpsi_DecodeMxBuffUtilizationDr(
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenMxBuffUtilizationDr(
* dvbpsi_mx_buff_utilization_dr_t * p_decoded, int b_duplicate)
dvbpsi_mx_buff_utilization_dr_t * p_decoded, int b_duplicate)
* \brief "multiplex buffer utilization" descriptor generator.
* \param p_decoded pointer to a decoded "system clock" descriptor
* structure
......
src/descriptors/dr_0d.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_0d.h
* (c)2001-2002 VideoLAN
* $Id: dr_0d.h,v 1.1 2002/05/10 22:58:53 bozo Exp $
* $Id: dr_0d.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -69,7 +69,7 @@ typedef struct dvbpsi_copyright_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_copyright_dr_t * dvbpsi_DecodeCopyrightDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "copyright" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "copyright" descriptor structure which
......@@ -84,7 +84,7 @@ dvbpsi_copyright_dr_t* dvbpsi_DecodeCopyrightDr(
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenCopyrightDr(
* dvbpsi_copyright_dr_t * p_decoded, int b_duplicate)
dvbpsi_copyright_dr_t * p_decoded, int b_duplicate)
* \brief "copyright" descriptor generator.
* \param p_decoded pointer to a decoded "copyright" descriptor structure
* \param b_duplicate if non zero then duplicate the p_decoded structure into
......
src/descriptors/dr_0e.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_0e.h
* (c)2001-2002 VideoLAN
* $Id: dr_0e.h,v 1.1 2002/05/10 22:58:53 bozo Exp $
* $Id: dr_0e.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -66,7 +66,7 @@ typedef struct dvbpsi_max_bitrate_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_max_bitrate_dr_t * dvbpsi_DecodeMaxBitrateDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "maximum bitrate" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "maximum bitrate" descriptor structure which
......@@ -81,7 +81,7 @@ dvbpsi_max_bitrate_dr_t* dvbpsi_DecodeMaxBitrateDr(
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenMaxBitrateDr(
* dvbpsi_max_bitrate_dr_t * p_decoded, int b_duplicate)
dvbpsi_max_bitrate_dr_t * p_decoded, int b_duplicate)
* \brief "maximum bitrate" descriptor generator.
* \param p_decoded pointer to a decoded "maximum bitrate" descriptor structure
* \param b_duplicate if non zero then duplicate the p_decoded structure into
......
src/descriptors/dr_0f.h
View file @ 5a62b3a6
/*****************************************************************************
* dr_0f.h
* (c)2001-2002 VideoLAN
* $Id: dr_0f.h,v 1.1 2002/05/10 22:58:53 bozo Exp $
* $Id: dr_0f.h,v 1.2 2002/05/10 23:50:36 bozo Exp $
*
* Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
*
......@@ -66,7 +66,7 @@ typedef struct dvbpsi_private_data_dr_s
*****************************************************************************/
/*!
* \fn dvbpsi_private_data_dr_t * dvbpsi_DecodePrivateDataDr(
* dvbpsi_descriptor_t * p_descriptor)
dvbpsi_descriptor_t * p_descriptor)
* \brief "private data indicator" descriptor decoder.
* \param p_descriptor pointer to the descriptor structure
* \return a pointer to a new "private data indicator" descriptor structure
......@@ -81,7 +81,7 @@ dvbpsi_private_data_dr_t* dvbpsi_DecodePrivateDataDr(
*****************************************************************************/
/*!
* \fn dvbpsi_descriptor_t * dvbpsi_GenPrivateDataDr(
* dvbpsi_private_data_dr_t * p_decoded, int b_duplicate)
dvbpsi_private_data_dr_t * p_decoded, int b_duplicate)
* \brief "private data indicator" descriptor generator.
* \param p_decoded pointer to a decoded "private data indicator" descriptor
* structure
......
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