diff options
Diffstat (limited to 'docs/reference/xml/gypsy-satellite.xml')
| -rw-r--r-- | docs/reference/xml/gypsy-satellite.xml | 124 |
1 files changed, 52 insertions, 72 deletions
diff --git a/docs/reference/xml/gypsy-satellite.xml b/docs/reference/xml/gypsy-satellite.xml index 517b325..a58af36 100644 --- a/docs/reference/xml/gypsy-satellite.xml +++ b/docs/reference/xml/gypsy-satellite.xml @@ -4,7 +4,7 @@ <refentry id="GypsySatellite"> <refmeta> -<refentrytitle role="top_of_page">GypsySatellite</refentrytitle> +<refentrytitle role="top_of_page" id="GypsySatellite.top_of_page">GypsySatellite</refentrytitle> <manvolnum>3</manvolnum> <refmiscinfo>GYPSY Library</refmiscinfo> </refmeta> @@ -12,62 +12,52 @@ <refnamediv> <refname>GypsySatellite</refname> <refpurpose>Object for obtaining satellite information</refpurpose> -<!--[<xref linkend="desc" endterm="desc.title"/>]--> </refnamediv> -<refsynopsisdiv role="synopsis"> +<refsynopsisdiv id="GypsySatellite.synopsis" role="synopsis"> <title role="synopsis.title">Synopsis</title> <synopsis> - - - <link linkend="GypsySatellite-struct">GypsySatellite</link>; -#define <link linkend="GYPSY-SATELLITE-DBUS-INTERFACE:CAPS">GYPSY_SATELLITE_DBUS_INTERFACE</link> -#define <link linkend="GYPSY-SATELLITE-DBUS-SERVICE:CAPS">GYPSY_SATELLITE_DBUS_SERVICE</link> +#define <link linkend="GYPSY-SATELLITE-DBUS-INTERFACE--CAPS">GYPSY_SATELLITE_DBUS_INTERFACE</link> +#define <link linkend="GYPSY-SATELLITE-DBUS-SERVICE--CAPS">GYPSY_SATELLITE_DBUS_SERVICE</link> <link linkend="GypsySatelliteDetails">GypsySatelliteDetails</link>; -<link linkend="GypsySatellite">GypsySatellite</link>* <link linkend="gypsy-satellite-new">gypsy_satellite_new</link> (const <link linkend="char">char</link> *object_path); -<link linkend="GPtrArray">GPtrArray</link>* <link linkend="gypsy-satellite-get-satellites">gypsy_satellite_get_satellites</link> (<link linkend="GypsySatellite">GypsySatellite</link> *satellite, +<link linkend="GypsySatellite">GypsySatellite</link> * <link linkend="gypsy-satellite-new">gypsy_satellite_new</link> (const <link linkend="char">char</link> *object_path); +<link linkend="GPtrArray">GPtrArray</link> * <link linkend="gypsy-satellite-get-satellites">gypsy_satellite_get_satellites</link> (<link linkend="GypsySatellite">GypsySatellite</link> *satellite, <link linkend="GError">GError</link> **error); <link linkend="void">void</link> <link linkend="gypsy-satellite-free-satellite-array">gypsy_satellite_free_satellite_array</link> (<link linkend="GPtrArray">GPtrArray</link> *satellites); - - </synopsis> </refsynopsisdiv> -<refsect1 role="object_hierarchy"> +<refsect1 id="GypsySatellite.object-hierarchy" role="object_hierarchy"> <title role="object_hierarchy.title">Object Hierarchy</title> <synopsis> - <link linkend="GObject">GObject</link> +----GypsySatellite </synopsis> - </refsect1> -<refsect1 role="properties"> +<refsect1 id="GypsySatellite.properties" role="properties"> <title role="properties.title">Properties</title> <synopsis> - - "<link linkend="GypsySatellite--object-path">object-path</link>" <link linkend="gchararray">gchararray</link> : Write / Construct Only + "<link linkend="GypsySatellite--object-path">object-path</link>" <link linkend="gchar">gchar</link>* : Write / Construct Only </synopsis> </refsect1> -<refsect1 role="signal_proto"> +<refsect1 id="GypsySatellite.signals" role="signal_proto"> <title role="signal_proto.title">Signals</title> <synopsis> - "<link linkend="GypsySatellite-satellites-changed">satellites-changed</link>" : Run Last </synopsis> </refsect1> -<refsect1 role="desc"> +<refsect1 id="GypsySatellite.description" role="desc"> <title role="desc.title">Description</title> <para> <link linkend="GypsySatellite"><type>GypsySatellite</type></link> is used whenever the client program wishes to know about @@ -123,41 +113,37 @@ gpointer userdata) </programlisting> </informalexample></para> <para> - </para> </refsect1> -<refsect1 role="details"> +<refsect1 id="GypsySatellite.details" role="details"> <title role="details.title">Details</title> -<refsect2> -<title><anchor id="GypsySatellite-struct" role="struct"/>GypsySatellite</title> -<indexterm><primary>GypsySatellite</primary></indexterm><programlisting>typedef struct _GypsySatellite GypsySatellite;</programlisting> +<refsect2 id="GypsySatellite-struct" role="struct"> +<title>GypsySatellite</title> +<indexterm zone="GypsySatellite-struct"><primary sortas="GypsySatellite">GypsySatellite</primary></indexterm><programlisting>typedef struct _GypsySatellite GypsySatellite;</programlisting> <para> There are no public fields in <link linkend="GypsySatellite"><type>GypsySatellite</type></link>.</para> <para> - </para></refsect2> -<refsect2> -<title><anchor id="GYPSY-SATELLITE-DBUS-INTERFACE:CAPS" role="macro"/>GYPSY_SATELLITE_DBUS_INTERFACE</title> -<indexterm><primary>GYPSY_SATELLITE_DBUS_INTERFACE</primary></indexterm><programlisting>#define GYPSY_SATELLITE_DBUS_INTERFACE "org.freedesktop.Gypsy.Satellite" +<refsect2 id="GYPSY-SATELLITE-DBUS-INTERFACE--CAPS" role="macro"> +<title>GYPSY_SATELLITE_DBUS_INTERFACE</title> +<indexterm zone="GYPSY-SATELLITE-DBUS-INTERFACE--CAPS"><primary sortas="GYPSY_SATELLITE_DBUS_INTERFACE">GYPSY_SATELLITE_DBUS_INTERFACE</primary></indexterm><programlisting>#define GYPSY_SATELLITE_DBUS_INTERFACE "org.freedesktop.Gypsy.Satellite" </programlisting> <para> A define containing the name of the Satellite interface</para> <para> - </para></refsect2> -<refsect2> -<title><anchor id="GYPSY-SATELLITE-DBUS-SERVICE:CAPS" role="macro"/>GYPSY_SATELLITE_DBUS_SERVICE</title> -<indexterm><primary>GYPSY_SATELLITE_DBUS_SERVICE</primary></indexterm><programlisting>#define GYPSY_SATELLITE_DBUS_SERVICE "org.freedesktop.Gypsy" +<refsect2 id="GYPSY-SATELLITE-DBUS-SERVICE--CAPS" role="macro"> +<title>GYPSY_SATELLITE_DBUS_SERVICE</title> +<indexterm zone="GYPSY-SATELLITE-DBUS-SERVICE--CAPS"><primary sortas="GYPSY_SATELLITE_DBUS_SERVICE">GYPSY_SATELLITE_DBUS_SERVICE</primary></indexterm><programlisting>#define GYPSY_SATELLITE_DBUS_SERVICE "org.freedesktop.Gypsy" </programlisting> <para> A define containing the address of the Satellite service.</para> <para> - </para></refsect2> -<refsect2> -<title><anchor id="GypsySatelliteDetails" role="struct"/>GypsySatelliteDetails</title> -<indexterm><primary>GypsySatelliteDetails</primary></indexterm><programlisting>typedef struct { +<refsect2 id="GypsySatelliteDetails" role="struct"> +<title>GypsySatelliteDetails</title> +<indexterm zone="GypsySatelliteDetails"><primary sortas="GypsySatelliteDetails">GypsySatelliteDetails</primary></indexterm><programlisting>typedef struct { int satellite_id; gboolean in_use; guint elevation; @@ -168,109 +154,103 @@ A define containing the address of the Satellite service.</para> <para> A structure defining a satellite</para> <para> - </para><variablelist role="struct"> <varlistentry> -<term><link linkend="int">int</link> <structfield>satellite_id</structfield>;</term> +<term><link linkend="int">int</link> <structfield>satellite_id</structfield>;</term> <listitem><simpara> The satellite PRN id </simpara></listitem> </varlistentry> <varlistentry> -<term><link linkend="gboolean">gboolean</link> <structfield>in_use</structfield>;</term> +<term><link linkend="gboolean">gboolean</link> <structfield>in_use</structfield>;</term> <listitem><simpara> Whether this satellite was used in calculating the fix </simpara></listitem> </varlistentry> <varlistentry> -<term><link linkend="guint">guint</link> <structfield>elevation</structfield>;</term> +<term><link linkend="guint">guint</link> <structfield>elevation</structfield>;</term> <listitem><simpara> The satellite elevation </simpara></listitem> </varlistentry> <varlistentry> -<term><link linkend="guint">guint</link> <structfield>azimuth</structfield>;</term> +<term><link linkend="guint">guint</link> <structfield>azimuth</structfield>;</term> <listitem><simpara> The satellite azimuth </simpara></listitem> </varlistentry> <varlistentry> -<term><link linkend="guint">guint</link> <structfield>snr</structfield>;</term> +<term><link linkend="guint">guint</link> <structfield>snr</structfield>;</term> <listitem><simpara> The signal to noise ratio </simpara></listitem> </varlistentry> </variablelist></refsect2> -<refsect2> -<title><anchor id="gypsy-satellite-new" role="function"/>gypsy_satellite_new ()</title> -<indexterm><primary>gypsy_satellite_new</primary></indexterm><programlisting><link linkend="GypsySatellite">GypsySatellite</link>* gypsy_satellite_new (const <link linkend="char">char</link> *object_path);</programlisting> +<refsect2 id="gypsy-satellite-new" role="function"> +<title>gypsy_satellite_new ()</title> +<indexterm zone="gypsy-satellite-new"><primary sortas="gypsy_satellite_new">gypsy_satellite_new</primary></indexterm><programlisting><link linkend="GypsySatellite">GypsySatellite</link> * gypsy_satellite_new (const <link linkend="char">char</link> *object_path);</programlisting> <para> Creates a new <link linkend="GypsySatellite"><type>GypsySatellite</type></link> object that listens for satellite changes from the GPS found at <parameter>object_path</parameter>.</para> <para> - </para><variablelist role="params"> -<varlistentry><term><parameter>object_path</parameter> :</term> +<varlistentry><term><parameter>object_path</parameter> :</term> <listitem><simpara> Object path to the GPS device </simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GypsySatellite"><type>GypsySatellite</type></link> object +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GypsySatellite"><type>GypsySatellite</type></link> object </simpara></listitem></varlistentry> </variablelist></refsect2> -<refsect2> -<title><anchor id="gypsy-satellite-get-satellites" role="function"/>gypsy_satellite_get_satellites ()</title> -<indexterm><primary>gypsy_satellite_get_satellites</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link>* gypsy_satellite_get_satellites (<link linkend="GypsySatellite">GypsySatellite</link> *satellite, +<refsect2 id="gypsy-satellite-get-satellites" role="function"> +<title>gypsy_satellite_get_satellites ()</title> +<indexterm zone="gypsy-satellite-get-satellites"><primary sortas="gypsy_satellite_get_satellites">gypsy_satellite_get_satellites</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link> * gypsy_satellite_get_satellites (<link linkend="GypsySatellite">GypsySatellite</link> *satellite, <link linkend="GError">GError</link> **error);</programlisting> <para> Retrieves the <link linkend="GypsySatelliteDetails"><type>GypsySatelliteDetails</type></link> about the satellites that the GPS is able to see.</para> <para> - </para><variablelist role="params"> -<varlistentry><term><parameter>satellite</parameter> :</term> +<varlistentry><term><parameter>satellite</parameter> :</term> <listitem><simpara> A <link linkend="GypsySatellite"><type>GypsySatellite</type></link> </simpara></listitem></varlistentry> -<varlistentry><term><parameter>error</parameter> :</term> +<varlistentry><term><parameter>error</parameter> :</term> <listitem><simpara> A <link linkend="GError"><type>GError</type></link> for error return </simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GPtrArray"><type>GPtrArray</type></link> of <link linkend="GypsySatelliteDetails"><type>GypsySatelliteDetails</type></link> or <link linkend="NULL:CAPS"><type>NULL</type></link> on error. +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GPtrArray"><type>GPtrArray</type></link> of <link linkend="GypsySatelliteDetails"><type>GypsySatelliteDetails</type></link> or <link linkend="NULL--CAPS"><type>NULL</type></link> on error. Should be freed using <link linkend="gypsy-satellite-free-satellite-array"><function>gypsy_satellite_free_satellite_array()</function></link>. </simpara></listitem></varlistentry> </variablelist></refsect2> -<refsect2> -<title><anchor id="gypsy-satellite-free-satellite-array" role="function"/>gypsy_satellite_free_satellite_array ()</title> -<indexterm><primary>gypsy_satellite_free_satellite_array</primary></indexterm><programlisting><link linkend="void">void</link> gypsy_satellite_free_satellite_array +<refsect2 id="gypsy-satellite-free-satellite-array" role="function"> +<title>gypsy_satellite_free_satellite_array ()</title> +<indexterm zone="gypsy-satellite-free-satellite-array"><primary sortas="gypsy_satellite_free_satellite_array">gypsy_satellite_free_satellite_array</primary></indexterm><programlisting><link linkend="void">void</link> gypsy_satellite_free_satellite_array (<link linkend="GPtrArray">GPtrArray</link> *satellites);</programlisting> <para> Frees all resources used in the array.</para> <para> - </para><variablelist role="params"> -<varlistentry><term><parameter>satellites</parameter> :</term> +<varlistentry><term><parameter>satellites</parameter> :</term> <listitem><simpara> <link linkend="GPtrArray"><type>GPtrArray</type></link> containing <link linkend="GypsySatelliteDetails"><type>GypsySatelliteDetails</type></link> </simpara></listitem></varlistentry> </variablelist></refsect2> </refsect1> -<refsect1 role="property_details"> +<refsect1 id="GypsySatellite.property-details" role="property_details"> <title role="property_details.title">Property Details</title> -<refsect2><title><anchor id="GypsySatellite--object-path"/>The "<literal>object-path</literal>" property</title> -<indexterm><primary>GypsySatellite:object-path</primary></indexterm><programlisting> "object-path" <link linkend="gchararray">gchararray</link> : Write / Construct Only</programlisting> +<refsect2 id="GypsySatellite--object-path" role="property"><title>The <literal>"object-path"</literal> property</title> +<indexterm zone="GypsySatellite--object-path"><primary sortas="GypsySatellite:object-path">GypsySatellite:object-path</primary></indexterm><programlisting> "object-path" <link linkend="gchar">gchar</link>* : Write / Construct Only</programlisting> <para>The DBus path to the object.</para><para>Default value: ""</para> </refsect2> - </refsect1> -<refsect1 role="signals"> +<refsect1 id="GypsySatellite.signal-details" role="signals"> <title role="signals.title">Signal Details</title> -<refsect2><title><anchor id="GypsySatellite-satellites-changed"/>The "satellites-changed" signal</title> -<indexterm><primary>GypsySatellite::satellites-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GypsySatellite">GypsySatellite</link> *satellites, +<refsect2 id="GypsySatellite-satellites-changed" role="signal"><title>The <literal>"satellites-changed"</literal> signal</title> +<indexterm zone="GypsySatellite-satellites-changed"><primary sortas="GypsySatellite::satellites-changed">GypsySatellite::satellites-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GypsySatellite">GypsySatellite</link> *satellites, <link linkend="gpointer">gpointer</link> arg1, <link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting> <para> The ::satellites-changed signal is emitted every time the GPS reports a change in the satellite data.</para> <para> - </para><variablelist role="params"> -<varlistentry><term><parameter>satellites</parameter> :</term> +<varlistentry><term><parameter>satellites</parameter> :</term> <listitem><simpara> A <link linkend="GPtrArray"><type>GPtrArray</type></link> containing <link linkend="GypsySatelliteDetails"><type>GypsySatelliteDetails</type></link> </simpara></listitem></varlistentry> -<varlistentry><term><parameter>user_data</parameter> :</term> +<varlistentry><term><parameter>user_data</parameter> :</term> <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> </variablelist></refsect2> </refsect1> |