Commit 89570ee7 authored by Jean-Paul Saman's avatar Jean-Paul Saman

Documentation fixes.

parent d3b5bbb6
...@@ -4,7 +4,7 @@ Changes between 0.2.2 and 1.0.0: ...@@ -4,7 +4,7 @@ Changes between 0.2.2 and 1.0.0:
* new example application dvbinfo * new example application dvbinfo
* updated documentation (new api howto) * updated documentation (new api howto)
* add log callback (remove fprintf's) * add log callback (remove fprintf's)
* make API more consistent * make API more consistent, see doxygen "howto-new-api" section for converting your code:
- introduces dvbpsi_t typedef - introduces dvbpsi_t typedef
- removed dvbpis_handle - removed dvbpis_handle
* EIT table generation * EIT table generation
......
...@@ -26,18 +26,24 @@ describes how to use it and the "C" API.</p> ...@@ -26,18 +26,24 @@ describes how to use it and the "C" API.</p>
<p>libdvbpsi was originally released under the GPLv2 and later relicensed under the LGPLv2. All versions prior to version 0.2.0 are GPLv2, versions 0.2.0 and later are LGPLv2.1.<p> <p>libdvbpsi was originally released under the GPLv2 and later relicensed under the LGPLv2. All versions prior to version 0.2.0 are GPLv2, versions 0.2.0 and later are LGPLv2.1.<p>
<h2>Tables and Descriptors</h2> <h2>Tables and Descriptors</h2>
<p>libdvbpsi supports the following PSI tables and many descriptors regularly found in MPEG/DVB Transport streams</p> <p>libdvbpsi supports the following PSI tables and many descriptors regularly found in MPEG/DVB/ATSC Transport streams</p>
<ul> <ul>
<li>Bouquet Association Table (<em>BAT</em>)</li> <li>Bouquet Association Table (<em>BAT</em>)</li>
<li>Conditional Access Table (<em>CAT</em>)</li> <li>Conditional Access Table (<em>CAT</em>)</li>
<li>EPG Information Table (<em>EIT</em>)</li> <li>Event Information Table (<em>EIT</em>)</li>
<li>Network Information Table (<em>NIT</em>)</li> <li>Network Information Table (<em>NIT</em>)</li>
<li>Program Association Table (<em>PAT</em>)</li> <li>Program Association Table (<em>PAT</em>)</li>
<li>Program Map Table (<em>PMT</em>)</li> <li>Program Map Table (<em>PMT</em>)</li>
<li>Running Status Table(<em>RST</em></li>
<li>Section Description Table (<em>SDT</em>)</li> <li>Section Description Table (<em>SDT</em>)</li>
<li>Splice Information Section Table (<em>SIS</em>)</li> <li>Splice Information Section Table (<em>SIS</em>)</li>
<li>TOT/TDT Table (<em>TOT</em>)</li> <li>TOT/TDT Table (<em>TOT</em>)</li>
<li>PSIP Event Information Table(<em>ATSC EIT</em>)</li>
<li>PSIP Extended Text Table(<em>ATSC ETT</em>)</li>
<li>PSIP Master Guide Table(<em>ATSC MGT</em>)</li>
<li>PSIP System Time Table(<em>ATSC STT</em>)</li>
<li>PSIP Virtual Channel Table(<em>ATSC VCT</em>)</li>
</ul> </ul>
<h2>Usage</h2> <h2>Usage</h2>
......
...@@ -20,6 +20,13 @@ dr_13.h ...@@ -20,6 +20,13 @@ dr_13.h
Decode Carousel id Descriptor. Decode Carousel id Descriptor.
*/ */
/*!
* \file dr_13.h
* \author Adam Charrett
* \brief Decode Carousel id Descriptor.
*/
#ifndef _DR_13_H #ifndef _DR_13_H
#define _DR_13_H #define _DR_13_H
......
...@@ -20,6 +20,13 @@ dr_14.h ...@@ -20,6 +20,13 @@ dr_14.h
Decode Association Tag Descriptor. Decode Association Tag Descriptor.
*/ */
/*!
* \file dr_14.h
* \author Adam Charrett
* \brief Decode Association Tag Descriptor.
*/
#ifndef _DR_14_H #ifndef _DR_14_H
#define _DR_14_H #define _DR_14_H
......
...@@ -21,6 +21,12 @@ Decode Frequency List Descriptor. ...@@ -21,6 +21,12 @@ Decode Frequency List Descriptor.
*/ */
/*!
* \file dr_62.h
* \author Adam Charrett
* \brief Decode Frequency List Descriptor.
*/
#ifndef _DR_62_H #ifndef _DR_62_H
#define _DR_62_H #define _DR_62_H
......
...@@ -20,6 +20,13 @@ dr_66.h ...@@ -20,6 +20,13 @@ dr_66.h
Decode Data Broadcast id Descriptor. Decode Data Broadcast id Descriptor.
*/ */
/*!
* \file dr_66.h
* \author Adam Charrett
* \brief Decode Data Broadcast id Descriptor.
*/
#ifndef _DR_66_H #ifndef _DR_66_H
#define _DR_66_H #define _DR_66_H
......
...@@ -21,6 +21,12 @@ Decode Default Authority Descriptor. ...@@ -21,6 +21,12 @@ Decode Default Authority Descriptor.
*/ */
/*!
* \file dr_73.h
* \author Adam Charrett
* \brief Decode Default Authority Descriptor.
*/
#ifndef _DR_73_H #ifndef _DR_73_H
#define _DR_73_H #define _DR_73_H
......
...@@ -21,6 +21,12 @@ Decode Content Identifier Descriptor. ...@@ -21,6 +21,12 @@ Decode Content Identifier Descriptor.
*/ */
/*!
* \file dr_76.h
* \author Adam Charrett
* \brief Decode Content Identifier Descriptor
*/
#ifndef _DR_76_H #ifndef _DR_76_H
#define _DR_76_H #define _DR_76_H
......
This diff is collapsed.
...@@ -21,6 +21,12 @@ Decode Logical Channel Number Descriptor. ...@@ -21,6 +21,12 @@ Decode Logical Channel Number Descriptor.
*/ */
/*!
* \file dr_83.h
* \author Adam Charrett
* \brief Decode Logical Channel Number Descriptor.
*/
#ifndef _DR_83_H #ifndef _DR_83_H
#define _DR_83_H #define _DR_83_H
......
...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
eit.h eit.h
Decode PSIP Event Information Table.
*/ */
/*!
* \file atsc_eit.h
* \author Adam Charrett
* \brief Decode PSIP Event Information Table (ATSC EIT).
*/
#ifndef _ATSC_EIT_H #ifndef _ATSC_EIT_H
#define _ATSC_EIT_H #define _ATSC_EIT_H
...@@ -32,7 +37,7 @@ extern "C" { ...@@ -32,7 +37,7 @@ extern "C" {
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \struct dvbpsi_atsc_eit_event_s * \struct dvbpsi_atsc_eit_event_s
* \brief EIT Event structure. * \brief ATSC EIT Event structure.
* *
* This structure is used to store decoded event information. * This structure is used to store decoded event information.
*/ */
...@@ -60,7 +65,7 @@ typedef struct dvbpsi_atsc_eit_event_s ...@@ -60,7 +65,7 @@ typedef struct dvbpsi_atsc_eit_event_s
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \struct dvbpsi_atsc_eit_s * \struct dvbpsi_atsc_eit_s
* \brief EIT structure. * \brief ATSC EIT structure.
* *
* This structure is used to store a decoded EIT. * This structure is used to store a decoded EIT.
*/ */
......
...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
ett.h ett.h
Decode PSIP Extended Text Table.
*/ */
/*!
* \file atsc_ett.h
* \author Adam Charrett
* \brief Decode PSIP Extented Text Table (ATSC ETT).
*/
#ifndef _ATSC_ETT_H #ifndef _ATSC_ETT_H
#define _ATSC_ETT_H #define _ATSC_ETT_H
...@@ -32,7 +37,7 @@ extern "C" { ...@@ -32,7 +37,7 @@ extern "C" {
*****************************************************************************/ *****************************************************************************/
/*! /*!
* \struct dvbpsi_atsc_ett_s * \struct dvbpsi_atsc_ett_s
* \brief ETT structure. * \brief ATSC ETT structure.
* *
* The Extended Text Table (ETT) contains Extended Text Message (ETM) streams. They * The Extended Text Table (ETT) contains Extended Text Message (ETM) streams. They
* provide detailed descriptions of virtual channels (channel ETM) and (event ETM). * provide detailed descriptions of virtual channels (channel ETM) and (event ETM).
......
...@@ -21,6 +21,13 @@ mgt.h ...@@ -21,6 +21,13 @@ mgt.h
Decode PSIP Master Guide Table. Decode PSIP Master Guide Table.
*/ */
/*!
* \file atsc_mgt.h
* \author Adam Charrett and Michael Krufky
* \brief Decode PSIP Master Guide Table (ATSC MGT).
*/
#ifndef _ATSC_MGT_H #ifndef _ATSC_MGT_H
#define _ATSC_MGT_H #define _ATSC_MGT_H
......
...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -17,9 +17,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
stt.h stt.h
Decode PSIP System Time Table.
*/ */
/*!
* \file atsc_stt.h
* \author Adam Charrett
* \brief Decode PSIP System Time Table (ATSC STT).
*/
#ifndef _ATSC_STT_H #ifndef _ATSC_STT_H
#define _ATSC_STT_H #define _ATSC_STT_H
......
...@@ -20,6 +20,13 @@ vct.h ...@@ -20,6 +20,13 @@ vct.h
Decode PSIP Virtual Channel Table. Decode PSIP Virtual Channel Table.
*/ */
/*!
* \file atsc_vct.h
* \author Adam Charrett
* \brief Decode PSIP Virtual Channel Table. (ATSC VCT).
*/
#ifndef _ATSC_VCT_H #ifndef _ATSC_VCT_H
#define _ATSC_VCT_H #define _ATSC_VCT_H
......
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