Commit 7f31344a authored by Jean-Paul Saman's avatar Jean-Paul Saman

Update doxygen documentation

parent 9d4bf9c5
## Process this file with automake to produce Makefile.in ## Process this file with automake to produce Makefile.in
EXTRA_DIST=index.doxygen structure.doxygen usage.doxygen newdec.doxygen \ EXTRA_DIST=index.doxygen structure.doxygen usage.doxygen newdec.doxygen \
howto-new-api.doxygen \ howto-new-api.doxygen migrate-v1-to-v2.doxygen \
decoder.dot doxygen.cfg decoder.dot doxygen.cfg
MOSTLYCLEANFILES=decoder.png MOSTLYCLEANFILES=decoder.png
......
...@@ -763,6 +763,7 @@ INPUT = index.doxygen \ ...@@ -763,6 +763,7 @@ INPUT = index.doxygen \
usage.doxygen \ usage.doxygen \
newdec.doxygen \ newdec.doxygen \
howto-new-api.doxygen \ howto-new-api.doxygen \
migrate-v1-to-v2.doxygen \
../src \ ../src \
../src/tables \ ../src/tables \
../src/descriptors ../src/descriptors
......
...@@ -46,9 +46,6 @@ error: <br /> ...@@ -46,9 +46,6 @@ error: <br />
<p>The same snippit of code using the dvbpsi_decoder_chain_XX() functions looks like this:</p> <p>The same snippit of code using the dvbpsi_decoder_chain_XX() functions looks like this:</p>
<code> <code>
/***************************************************************************** <br />
&nbsp; * AttachPAT <br />
&nbsp; *****************************************************************************/ <br />
static void AttachPAT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension, <br /> static void AttachPAT(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension, <br />
&nbsp; void *p_zero) <br /> &nbsp; void *p_zero) <br />
{ <br /> { <br />
...@@ -88,9 +85,6 @@ new API (version 2 and up), the code looks the same as with the example above. T ...@@ -88,9 +85,6 @@ new API (version 2 and up), the code looks the same as with the example above. T
old way of doing things. The second shows you how to write it with dvbpsi_decoder_chain_XXX() functions.</p> old way of doing things. The second shows you how to write it with dvbpsi_decoder_chain_XXX() functions.</p>
<code> <code>
/***************************************************************************** <br />
&nbsp; * NewSubtable <br />
&nbsp; *****************************************************************************/ <br />
static void NewSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension, <br /> static void NewSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension, <br />
&nbsp; void * p_zero) <br /> &nbsp; void * p_zero) <br />
{ <br /> { <br />
...@@ -101,9 +95,6 @@ static void NewSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_exten ...@@ -101,9 +95,6 @@ static void NewSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_exten
&nbsp; } <br /> &nbsp; } <br />
} <br /> } <br />
<br /> <br />
/***************************************************************************** <br />
&nbsp; * main <br />
&nbsp; *****************************************************************************/ <br />
int main(int i_argc, char* pa_argv[]) <br /> int main(int i_argc, char* pa_argv[]) <br />
{ <br /> { <br />
&nbsp; int i_fd; <br /> &nbsp; int i_fd; <br />
...@@ -147,12 +138,11 @@ out: <br /> ...@@ -147,12 +138,11 @@ out: <br />
&nbsp; close(i_fd); <br /> &nbsp; close(i_fd); <br />
&nbsp; return ret; <br /> &nbsp; return ret; <br />
} <br /> } <br />
<code> </code>
<p>Using v2 libdvbpsi demuxing API the above code translates in:</p>
<code> <code>
/***************************************************************************** <br />
&nbsp; * NewSubtable <br />
&nbsp; *****************************************************************************/ <br />
static void NewSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension, <br /> static void NewSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension, <br />
&nbsp; void * p_zero) <br /> &nbsp; void * p_zero) <br />
{ <br /> { <br />
...@@ -163,9 +153,6 @@ static void NewSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_exten ...@@ -163,9 +153,6 @@ static void NewSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_exten
&nbsp; } <br /> &nbsp; } <br />
} <br /> } <br />
<br /> <br />
/***************************************************************************** <br />
&nbsp; * DelSubtable <br />
&nbsp; *****************************************************************************/ <br />
static void DelSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension) <br /> static void DelSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension) <br />
{ <br /> { <br />
&nbsp; if(i_table_id == 0x42) <br /> &nbsp; if(i_table_id == 0x42) <br />
...@@ -174,9 +161,6 @@ static void DelSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_exten ...@@ -174,9 +161,6 @@ static void DelSubtable(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_exten
&nbsp; } <br /> &nbsp; } <br />
} <br /> } <br />
<br /> <br />
/***************************************************************************** <br />
&nbsp; * main <br />
&nbsp; *****************************************************************************/ <br />
int main(int i_argc, char* pa_argv[]) <br /> int main(int i_argc, char* pa_argv[]) <br />
{ <br /> { <br />
&nbsp; int i_fd; <br /> &nbsp; int i_fd; <br />
...@@ -223,3 +207,5 @@ out: <br /> ...@@ -223,3 +207,5 @@ out: <br />
} <br /> } <br />
</code> </code>
*/ */
<p>In the above example one could have used dvbpsi_sdt_attach() and dvbpsi_sdt_detach() functions directly.</p>
...@@ -43,5 +43,6 @@ have been detached.</p> ...@@ -43,5 +43,6 @@ have been detached.</p>
<ul> <ul>
<li>\ref structure</li> <li>\ref structure</li>
<li>\ref howto-new-api</li> <li>\ref howto-new-api</li>
<li>\ref migrate-v1-to-v2</li>
</ul> </ul>
*/ */
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