UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

[media] DocBook: improve documentation of the properties structs 

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>
This commit is contained in:
Mauro Carvalho Chehab 2015-05-29 07:34:50 -03:00
parent 9df4fc5b8f
commit 38fbb98668
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Documentation/DocBook/media/dvb/dvbproperty.xml
View 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> struct <constant>dvb_frontend_parameters</constant></link> were used.</para>
<section id="dtv-stats"> <section id="dtv-stats">
<title>DTV stats type</title> <title>struct <structname>dtv_stats</structname></title>
<programlisting> <programlisting>
struct dtv_stats { struct dtv_stats {
__u8 scale; /* enum fecap_scale_params type */ __u8 scale; /* enum fecap_scale_params type */
@ -48,19 +48,19 @@ struct dtv_stats {
</programlisting> </programlisting>
</section> </section>
<section id="dtv-fe-stats"> <section id="dtv-fe-stats">
<title>DTV stats type</title> <title>struct <structname>dtv_fe_stats</structname></title>
<programlisting> <programlisting>
#define MAX_DTV_STATS 4 #define MAX_DTV_STATS 4
struct dtv_fe_stats { struct dtv_fe_stats {
__u8 len; __u8 len;
struct dtv_stats stat[MAX_DTV_STATS]; &dtv-stats; stat[MAX_DTV_STATS];
} __packed; } __packed;
</programlisting> </programlisting>
</section> </section>
<section id="dtv-property"> <section id="dtv-property">
<title>DTV property type</title> <title>struct <structname>dtv_property</structname></title>
<programlisting> <programlisting>
/* Reserved fields should be set to 0 */ /* Reserved fields should be set to 0 */
@ -69,7 +69,7 @@ struct dtv_property {
__u32 reserved[3]; __u32 reserved[3];
union { union {
__u32 data; __u32 data;
struct dtv_fe_stats st; &dtv-fe-stats; st;
struct { struct {
__u8 data[32]; __u8 data[32];
__u32 len; __u32 len;
@ -85,11 +85,11 @@ struct dtv_property {
</programlisting> </programlisting>
</section> </section>
<section id="dtv-properties"> <section id="dtv-properties">
<title>DTV properties type</title> <title>struct <structname>dtv_properties</structname></title>
<programlisting> <programlisting>
struct dtv_properties { struct dtv_properties {
__u32 num; __u32 num;
struct dtv_property *props; &dtv-property; *props;
}; };
</programlisting> </programlisting>
</section> </section>

4
Documentation/DocBook/media/dvb/fe-get-property.xml
View File

@ -17,7 +17,7 @@
<funcdef>int <function>ioctl</function></funcdef> <funcdef>int <function>ioctl</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef> <paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>request</parameter></paramdef> <paramdef>int <parameter>request</parameter></paramdef>
<paramdef>&dtv-property; *<parameter>argp</parameter></paramdef> <paramdef>&dtv-properties; *<parameter>argp</parameter></paramdef>
</funcprototype> </funcprototype>
</funcsynopsis> </funcsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -40,7 +40,7 @@
<varlistentry> <varlistentry>
<term><parameter>argp</parameter></term> <term><parameter>argp</parameter></term>
<listitem> <listitem>
<para>pointer to &dtv-property;</para> <para>pointer to &dtv-properties;</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>