diff options
author | William Jon McCann <mccann@jhu.edu> | 2007-03-09 11:40:59 -0500 |
---|---|---|
committer | William Jon McCann <mccann@jhu.edu> | 2007-03-09 11:40:59 -0500 |
commit | 1d72374535de222cb816c74506555c71af10d429 (patch) | |
tree | 95426aec469fd9d37308d59f743c440af1069ecf /doc/ref-ck-seat.xml | |
parent | 15ad40c8d8abd86a4b83e445031fd467406b45d8 (diff) |
add a tool to autogenerate dbus object ref docs
I hope I didn't reinvent a wheel but it seems to
work much better than hand coding these refentries.
Still need to add support for comments and actual
descriptions ala gtk-doc.
Diffstat (limited to 'doc/ref-ck-seat.xml')
-rw-r--r-- | doc/ref-ck-seat.xml | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/doc/ref-ck-seat.xml b/doc/ref-ck-seat.xml new file mode 100644 index 0000000..a679d8e --- /dev/null +++ b/doc/ref-ck-seat.xml @@ -0,0 +1,111 @@ +<refentry id="Seat"> + <refmeta> + <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Seat</refentrytitle> + </refmeta> + <refnamediv> + <refname>org.freedesktop.ConsoleKit.Seat</refname> + <refpurpose>Seat interface</refpurpose> + </refnamediv> + <refsynopsisdiv role="synopsis"> + <title role="synopsis.title">Methods</title> + <synopsis><link linkend="Seat-GetId">GetId</link> (out 'o' sid) +<link linkend="Seat-GetSessions">GetSessions</link> (out 'ao' sessions) +<link linkend="Seat-GetActiveSession">GetActiveSession</link> (out 'o' ssid) +<link linkend="Seat-ActivateSession">ActivateSession</link> (in 'o' ssid) +</synopsis> + </refsynopsisdiv> + <refsect1 role="signal_proto"> + <title role="signal_proto.title">Signals</title> + <synopsis><link linkend="Seat-signal-ActiveSessionChanged">ActiveSessionChanged</link> ('o' sid) +<link linkend="Seat-signal-SessionAdded">SessionAdded</link> ('o' sid) +<link linkend="Seat-signal-SessionRemoved">SessionRemoved</link> ('o' sid) +</synopsis> + </refsect1> + <refsect1 role="impl_interfaces"> + <title role="impl_interfaces.title">Implemented Interfaces</title> + <para>org.freedesktop.ConsoleKit.Seat implements + org.freedesktop.DBus.Introspectable, + org.freedesktop.DBus.Properties + </para> + </refsect1> + <refsect1 role="properties"> + <title role="properties.title">Properties</title> + <synopsis/> + </refsect1> + <refsect1 role="desc"> + <title role="desc.title">Description</title> + <para/> + </refsect1> + <refsect1 role="details"> + <title role="details.title">Details</title> + <refsect2> + <title><anchor role="function" id="Seat-GetId"/>GetId ()</title> + <indexterm> + <primary>GetId</primary> + <secondary>Seat</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetId (out 'o' sid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Seat-GetSessions"/>GetSessions ()</title> + <indexterm> + <primary>GetSessions</primary> + <secondary>Seat</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetSessions (out 'ao' sessions)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Seat-GetActiveSession"/>GetActiveSession ()</title> + <indexterm> + <primary>GetActiveSession</primary> + <secondary>Seat</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetActiveSession (out 'o' ssid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Seat-ActivateSession"/>ActivateSession ()</title> + <indexterm> + <primary>ActivateSession</primary> + <secondary>Seat</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>ActivateSession (in 'o' ssid)</programlisting> + </refsect2> + </refsect1> + <refsect1 role="signals"> + <title role="signals.title">Signal Details</title> + <refsect2> + <title><anchor role="function" id="Seat-signal-ActiveSessionChanged"/>ActiveSessionChanged ()</title> + <indexterm> + <primary>ActiveSessionChanged</primary> + <secondary>Seat</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>ActiveSessionChanged ('o' sid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Seat-signal-SessionAdded"/>SessionAdded ()</title> + <indexterm> + <primary>SessionAdded</primary> + <secondary>Seat</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>SessionAdded ('o' sid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Seat-signal-SessionRemoved"/>SessionRemoved ()</title> + <indexterm> + <primary>SessionRemoved</primary> + <secondary>Seat</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>SessionRemoved ('o' sid)</programlisting> + </refsect2> + </refsect1> + <refsect1 role="property_details"> + <title role="property_details.title">Property Details</title> + </refsect1> +</refentry> |