diff options
| author | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2015-05-28 22:06:56 -0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2015-05-30 11:11:35 -0300 |
| commit | 9df4fc5b8f34383d116a160809e782b4ca50a808 (patch) | |
| tree | 00e2d22de7199a13cc4f5be1ce54d4ed03d2c022 /Documentation/DocBook | |
| parent | 903142e53c648ee61c00f5c3b420b16bc6336ad7 (diff) | |
[media] DocBook: improve documentation for hierarchy
Format it as a table and links it with the legacy API xml.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Diffstat (limited to 'Documentation/DocBook')
| -rw-r--r-- | Documentation/DocBook/media/dvb/dvbproperty.xml | 46 | ||||
| -rw-r--r-- | Documentation/DocBook/media/dvb/frontend.xml | 18 | ||||
| -rw-r--r-- | Documentation/DocBook/media/dvb/frontend_legacy_api.xml | 2 |
3 files changed, 38 insertions, 28 deletions
diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml index 5f30a28a15b0..ae9bc1e089cc 100644 --- a/Documentation/DocBook/media/dvb/dvbproperty.xml +++ b/Documentation/DocBook/media/dvb/dvbproperty.xml @@ -951,15 +951,43 @@ typedef enum atscmh_sccc_code_mode { <section id="DTV-HIERARCHY"> <title><constant>DTV_HIERARCHY</constant></title> <para>Frontend hierarchy</para> - <programlisting> -typedef enum fe_hierarchy { - HIERARCHY_NONE, - HIERARCHY_1, - HIERARCHY_2, - HIERARCHY_4, - HIERARCHY_AUTO - } fe_hierarchy_t; - </programlisting> + + +<section id="fe-hierarchy-t"> +<title>Frontend hierarchy</title> + +<table pgwide="1" frame="none" id="fe-hierarchy"> + <title>enum fe_hierarchy</title> + <tgroup cols="2"> + &cs-def; + <thead> + <row> + <entry>ID</entry> + <entry>Description</entry> + </row> + </thead> + <tbody valign="top"> + <row> + <entry>HIERARCHY_NONE</entry> + <entry>No hierarchy</entry> + </row><row> + <entry>HIERARCHY_AUTO</entry> + <entry>Autodetect hierarchy (if supported)</entry> + </row><row> + <entry>HIERARCHY_1</entry> + <entry>Hierarchy 1</entry> + </row><row> + <entry>HIERARCHY_2</entry> + <entry>Hierarchy 2</entry> + </row><row> + <entry>HIERARCHY_4</entry> + <entry>Hierarchy 4</entry> + </row> + </tbody> + </tgroup> +</table> +</section> + </section> <section id="DTV-STREAM-ID"> <title><constant>DTV_STREAM_ID</constant></title> diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml index a005c4b472f5..d81b3ff33295 100644 --- a/Documentation/DocBook/media/dvb/frontend.xml +++ b/Documentation/DocBook/media/dvb/frontend.xml @@ -56,24 +56,6 @@ specification is available at &sub-dvbproperty; -<section> -<title>More OFDM parameters</title> - -<section id="fe-hierarchy-t"> -<title>frontend hierarchy</title> -<programlisting> -typedef enum fe_hierarchy { - HIERARCHY_NONE, - HIERARCHY_1, - HIERARCHY_2, - HIERARCHY_4, - HIERARCHY_AUTO - } fe_hierarchy_t; -</programlisting> -</section> - -</section> - <section id="frontend_fcalls"> <title>Frontend Function Calls</title> diff --git a/Documentation/DocBook/media/dvb/frontend_legacy_api.xml b/Documentation/DocBook/media/dvb/frontend_legacy_api.xml index d20f1fd75fa9..cb2e18381305 100644 --- a/Documentation/DocBook/media/dvb/frontend_legacy_api.xml +++ b/Documentation/DocBook/media/dvb/frontend_legacy_api.xml @@ -183,7 +183,7 @@ struct dvb_vsb_parameters { &fe-modulation-t; constellation; /⋆ modulation type (see above) ⋆/ &fe-transmit-mode-t; transmission_mode; &fe-guard-interval-t; guard_interval; - fe_hierarchy_t hierarchy_information; + &fe-hierarchy-t; hierarchy_information; }; </programlisting> </section> |