[media] DocBook: Better document DTMB time interleaving
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Sun, 7 Jun 2015 09:35:20 +0000 (06:35 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Tue, 9 Jun 2015 20:47:31 +0000 (17:47 -0300)
The DTMB time interleaving was not properly documented. Add
a documentation for it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Documentation/DocBook/media/dvb/dvbproperty.xml

index 816d5ac561640657e4d7dfeae1f86bb6dfa60b8c..33f2313aca07df63c872e701dced27a578a2357b 100644 (file)
@@ -1068,15 +1068,37 @@ typedef enum atscmh_sccc_code_mode {
        </section>
        <section id="DTV-INTERLEAVING">
        <title><constant>DTV_INTERLEAVING</constant></title>
-       <para id="fe-interleaving">Interleaving mode</para>
-       <programlisting>
-enum fe_interleaving {
-       INTERLEAVING_NONE,
-       INTERLEAVING_AUTO,
-       INTERLEAVING_240,
-       INTERLEAVING_720,
-};
-       </programlisting>
+
+<para>Time interleaving to be used. Currently, used only on DTMB.</para>
+
+<table pgwide="1" frame="none" id="fe-interleaving">
+    <title>enum fe_interleaving</title>
+    <tgroup cols="2">
+       &cs-def;
+       <thead>
+       <row>
+           <entry>ID</entry>
+           <entry>Description</entry>
+       </row>
+       </thead>
+       <tbody valign="top">
+       <row>
+           <entry id="INTERLEAVING-NONE"><constant>INTERLEAVING_NONE</constant></entry>
+           <entry>No interleaving.</entry>
+       </row><row>
+           <entry id="INTERLEAVING-AUTO"><constant>INTERLEAVING_AUTO</constant></entry>
+           <entry>Auto-detect interleaving.</entry>
+       </row><row>
+           <entry id="INTERLEAVING-240"><constant>INTERLEAVING_240</constant></entry>
+           <entry>Interleaving of 240 symbols.</entry>
+       </row><row>
+           <entry id="INTERLEAVING-720"><constant>INTERLEAVING_720</constant></entry>
+           <entry>Interleaving of 720 symbols.</entry>
+       </row>
+        </tbody>
+    </tgroup>
+</table>
+
        </section>
        <section id="DTV-LNA">
        <title><constant>DTV_LNA</constant></title>