summaryrefslogtreecommitdiff
path: root/docs/reference/xml/gypsy-time.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/xml/gypsy-time.xml')
-rw-r--r--docs/reference/xml/gypsy-time.xml67
1 files changed, 28 insertions, 39 deletions
diff --git a/docs/reference/xml/gypsy-time.xml b/docs/reference/xml/gypsy-time.xml
index 2a0e5fe..11d7715 100644
--- a/docs/reference/xml/gypsy-time.xml
+++ b/docs/reference/xml/gypsy-time.xml
@@ -4,7 +4,7 @@
<refentry id="gypsy-GypsyTime">
<refmeta>
-<refentrytitle role="top_of_page">GypsyTime</refentrytitle>
+<refentrytitle role="top_of_page" id="gypsy-GypsyTime.top_of_page">GypsyTime</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GYPSY Library</refmiscinfo>
</refmeta>
@@ -12,24 +12,19 @@
<refnamediv>
<refname>GypsyTime</refname>
<refpurpose>Object for obtaining GPS time from gypsy-daemon</refpurpose>
-<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
-<refsynopsisdiv role="synopsis">
+<refsynopsisdiv id="gypsy-GypsyTime.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
-
-
-
<link linkend="GypsyTime">GypsyTime</link>;
-#define <link linkend="GYPSY-TIME-DBUS-SERVICE:CAPS">GYPSY_TIME_DBUS_SERVICE</link>
-#define <link linkend="GYPSY-TIME-DBUS-INTERFACE:CAPS">GYPSY_TIME_DBUS_INTERFACE</link>
-<link linkend="GypsyTime">GypsyTime</link>* <link linkend="gypsy-time-new">gypsy_time_new</link> (const <link linkend="char">char</link> *object_path);
+#define <link linkend="GYPSY-TIME-DBUS-SERVICE--CAPS">GYPSY_TIME_DBUS_SERVICE</link>
+#define <link linkend="GYPSY-TIME-DBUS-INTERFACE--CAPS">GYPSY_TIME_DBUS_INTERFACE</link>
+<link linkend="GypsyTime">GypsyTime</link> * <link linkend="gypsy-time-new">gypsy_time_new</link> (const <link linkend="char">char</link> *object_path);
<link linkend="gboolean">gboolean</link> <link linkend="gypsy-time-get-time">gypsy_time_get_time</link> (<link linkend="GypsyTime">GypsyTime</link> *gps_time,
<link linkend="int">int</link> *timestamp,
<link linkend="GError">GError</link> **error);
-
</synopsis>
</refsynopsisdiv>
@@ -41,7 +36,7 @@
-<refsect1 role="desc">
+<refsect1 id="gypsy-GypsyTime.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="GypsyTime"><type>GypsyTime</type></link> is used whenever the client program wishes to know about
@@ -82,76 +77,70 @@ gpointer userdata)
</programlisting>
</informalexample></para>
<para>
-
</para>
</refsect1>
-<refsect1 role="details">
+<refsect1 id="gypsy-GypsyTime.details" role="details">
<title role="details.title">Details</title>
-<refsect2>
-<title><anchor id="GypsyTime" role="struct"/>GypsyTime</title>
-<indexterm><primary>GypsyTime</primary></indexterm><programlisting>typedef struct {
+<refsect2 id="GypsyTime" role="struct">
+<title>GypsyTime</title>
+<indexterm zone="GypsyTime"><primary sortas="GypsyTime">GypsyTime</primary></indexterm><programlisting>typedef struct {
GObject parent_object;
} GypsyTime;
</programlisting>
<para>
There are no public fields in <link linkend="GypsyTime"><type>GypsyTime</type></link>.</para>
<para>
-
</para></refsect2>
-<refsect2>
-<title><anchor id="GYPSY-TIME-DBUS-SERVICE:CAPS" role="macro"/>GYPSY_TIME_DBUS_SERVICE</title>
-<indexterm><primary>GYPSY_TIME_DBUS_SERVICE</primary></indexterm><programlisting>#define GYPSY_TIME_DBUS_SERVICE "org.freedesktop.Gypsy"
+<refsect2 id="GYPSY-TIME-DBUS-SERVICE--CAPS" role="macro">
+<title>GYPSY_TIME_DBUS_SERVICE</title>
+<indexterm zone="GYPSY-TIME-DBUS-SERVICE--CAPS"><primary sortas="GYPSY_TIME_DBUS_SERVICE">GYPSY_TIME_DBUS_SERVICE</primary></indexterm><programlisting>#define GYPSY_TIME_DBUS_SERVICE "org.freedesktop.Gypsy"
</programlisting>
<para>
A define containing the address of the Time service</para>
<para>
-
</para></refsect2>
-<refsect2>
-<title><anchor id="GYPSY-TIME-DBUS-INTERFACE:CAPS" role="macro"/>GYPSY_TIME_DBUS_INTERFACE</title>
-<indexterm><primary>GYPSY_TIME_DBUS_INTERFACE</primary></indexterm><programlisting>#define GYPSY_TIME_DBUS_INTERFACE "org.freedesktop.Gypsy.Time"
+<refsect2 id="GYPSY-TIME-DBUS-INTERFACE--CAPS" role="macro">
+<title>GYPSY_TIME_DBUS_INTERFACE</title>
+<indexterm zone="GYPSY-TIME-DBUS-INTERFACE--CAPS"><primary sortas="GYPSY_TIME_DBUS_INTERFACE">GYPSY_TIME_DBUS_INTERFACE</primary></indexterm><programlisting>#define GYPSY_TIME_DBUS_INTERFACE "org.freedesktop.Gypsy.Time"
</programlisting>
<para>
A define containing the name of the Time interface</para>
<para>
-
</para></refsect2>
-<refsect2>
-<title><anchor id="gypsy-time-new" role="function"/>gypsy_time_new ()</title>
-<indexterm><primary>gypsy_time_new</primary></indexterm><programlisting><link linkend="GypsyTime">GypsyTime</link>* gypsy_time_new (const <link linkend="char">char</link> *object_path);</programlisting>
+<refsect2 id="gypsy-time-new" role="function">
+<title>gypsy_time_new ()</title>
+<indexterm zone="gypsy-time-new"><primary sortas="gypsy_time_new">gypsy_time_new</primary></indexterm><programlisting><link linkend="GypsyTime">GypsyTime</link> * gypsy_time_new (const <link linkend="char">char</link> *object_path);</programlisting>
<para>
Creates a new <link linkend="GypsyTime"><type>GypsyTime</type></link> object that listens for time changes
from the GPS found at <parameter>object_path</parameter>.</para>
<para>
-
</para><variablelist role="params">
-<varlistentry><term><parameter>object_path</parameter>&nbsp;:</term>
+<varlistentry><term><parameter>object_path</parameter>&#160;:</term>
<listitem><simpara> Object path to the GPS device
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GypsyTime"><type>GypsyTime</type></link> object
+<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GypsyTime"><type>GypsyTime</type></link> object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
-<refsect2>
-<title><anchor id="gypsy-time-get-time" role="function"/>gypsy_time_get_time ()</title>
-<indexterm><primary>gypsy_time_get_time</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gypsy_time_get_time (<link linkend="GypsyTime">GypsyTime</link> *gps_time,
+<refsect2 id="gypsy-time-get-time" role="function">
+<title>gypsy_time_get_time ()</title>
+<indexterm zone="gypsy-time-get-time"><primary sortas="gypsy_time_get_time">gypsy_time_get_time</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gypsy_time_get_time (<link linkend="GypsyTime">GypsyTime</link> *gps_time,
<link linkend="int">int</link> *timestamp,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Obtains the current time, if known, from the GPS device.</para>
<para>
-
</para><variablelist role="params">
-<varlistentry><term><parameter>gps_time</parameter>&nbsp;:</term>
+<varlistentry><term><parameter>gps_time</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GypsyTime"><type>GypsyTime</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><parameter>timestamp</parameter>&nbsp;:</term>
+<varlistentry><term><parameter>timestamp</parameter>&#160;:</term>
<listitem><simpara> Pointer to store the timestamp
</simpara></listitem></varlistentry>
-<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
+<varlistentry><term><parameter>error</parameter>&#160;:</term>
<listitem><simpara> Pointer to store a <link linkend="GError"><type>GError</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE on error.
+<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-23 20:14:25 +0000