[media] DocBook: improve documentation of the properties structs
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Fri, 29 May 2015 10:34:50 +0000 (07:34 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Sat, 30 May 2015 14:13:02 +0000 (11:13 -0300)
Rename the tytle of the struct documentation to reflect
the name of the structures, and use links to do cross-ref.

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

index ae9bc1e089cc6e6f3e37be94ac1b5056572ad785..b91210d646cf2ee8fd81b870104ea775223b7241 100644 (file)
@@ -36,7 +36,7 @@ API is to replace the ioctl's were the <link linkend="dvb-frontend-parameters">
 struct <constant>dvb_frontend_parameters</constant></link> were used.</para>
 
 <section id="dtv-stats">
-<title>DTV stats type</title>
+<title>struct <structname>dtv_stats</structname></title>
 <programlisting>
 struct dtv_stats {
        __u8 scale;     /* enum fecap_scale_params type */
@@ -48,19 +48,19 @@ struct dtv_stats {
 </programlisting>
 </section>
 <section id="dtv-fe-stats">
-<title>DTV stats type</title>
+<title>struct <structname>dtv_fe_stats</structname></title>
 <programlisting>
 #define MAX_DTV_STATS   4
 
 struct dtv_fe_stats {
        __u8 len;
-       struct dtv_stats stat[MAX_DTV_STATS];
+       &dtv-stats; stat[MAX_DTV_STATS];
 } __packed;
 </programlisting>
 </section>
 
 <section id="dtv-property">
-<title>DTV property type</title>
+<title>struct <structname>dtv_property</structname></title>
 <programlisting>
 /* Reserved fields should be set to 0 */
 
@@ -69,7 +69,7 @@ struct dtv_property {
        __u32 reserved[3];
        union {
                __u32 data;
-               struct dtv_fe_stats st;
+               &dtv-fe-stats; st;
                struct {
                        __u8 data[32];
                        __u32 len;
@@ -85,11 +85,11 @@ struct dtv_property {
 </programlisting>
 </section>
 <section id="dtv-properties">
-<title>DTV properties type</title>
+<title>struct <structname>dtv_properties</structname></title>
 <programlisting>
 struct dtv_properties {
        __u32 num;
-       struct dtv_property *props;
+       &dtv-property; *props;
 };
 </programlisting>
 </section>
index b121fe5380cad8adac5bd19dbe25b4cecc63064b..456ed92133f1675aed0f444575713b36d30d9e6e 100644 (file)
@@ -17,7 +17,7 @@
        <funcdef>int <function>ioctl</function></funcdef>
        <paramdef>int <parameter>fd</parameter></paramdef>
        <paramdef>int <parameter>request</parameter></paramdef>
-       <paramdef>&dtv-property; *<parameter>argp</parameter></paramdef>
+       <paramdef>&dtv-properties; *<parameter>argp</parameter></paramdef>
       </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
@@ -40,7 +40,7 @@
       <varlistentry>
        <term><parameter>argp</parameter></term>
        <listitem>
-           <para>pointer to &dtv-property;</para>
+           <para>pointer to &dtv-properties;</para>
        </listitem>
       </varlistentry>
     </variablelist>