Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 38fbb986 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[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: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 9df4fc5b

Documentation/DocBook/media/dvb/dvbproperty.xml

+7 −7
Original line number Diff line number Diff line
@@ -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>

Documentation/DocBook/media/dvb/fe-get-property.xml

+2 −2
Original line number Diff line number Diff line
@@ -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>