Mon, 21 Oct 2013 17:54:13 +0530
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
--- a/doc/reference/libpurple/libpurple-docs.xml Sun Oct 20 20:05:26 2013 +0530 +++ b/doc/reference/libpurple/libpurple-docs.xml Mon Oct 21 17:54:13 2013 +0530 @@ -117,7 +117,7 @@ </reference> <reference label="III"> - <title>Signals Reference</title> + <title>Purple-signals Reference</title> <xi:include href="signals_account.xml" /> <xi:include href="signals_blist.xml" />
--- a/doc/reference/libpurple/signals_plugin.xml Sun Oct 20 20:05:26 2013 +0530 +++ b/doc/reference/libpurple/signals_plugin.xml Mon Oct 21 17:54:13 2013 +0530 @@ -3,33 +3,55 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ ]> <chapter id="chapter-signals-plugin"> - <title>Plugin signals</title> +<title>Plugin signals</title> - <programlisting> - @signals - @signal plugin-load - @signal plugin-unload - @endsignals +<refsect1 id="plugins.signals" role="signal_proto"> +<title role="signal_proto.title">List of signals</title> +<synopsis> + "<link linkend="plugins-plugin-load">plugin-load</link>" + "<link linkend="plugins-plugin-unload">plugin-unload</link>" +</synopsis> +</refsect1> - @see plugins.h +<refsect1 id="plugins.signal-details" role="signals"> +<title role="signals.title">Signal details</title> - @signaldef plugin-load - @signalproto -void (*plugin_load)(PurplePlugin *plugin); - @endsignalproto - @signaldesc - Emitted when a plugin is loaded. - @param plugin The plugin that was loaded. - @endsignaldef +<refsect2 id="plugins-plugin-load" role="signal"> + <title>The <literal>"plugin-load"</literal> signal</title> + <para> +Emitted when a plugin is loaded. + </para> + <programlisting> +void user_function (PurplePlugin *plugin, + gpointer user_data)</programlisting> + <varlistentry> + <term><parameter>plugin</parameter> :</term> + <listitem><simpara>The plugin that was loaded.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>user_data</parameter> :</term> + <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> + </varlistentry> +</refsect2> - @signaldef plugin-unload - @signalproto -void (*plugin_unload)(PurplePlugin *plugin); - @endsignalproto - @signaldesc - Emitted when a plugin is unloaded. - @param plugin The plugin that was unloaded. - @endsignaldef +<refsect2 id="plugins-plugin-unload" role="signal"> + <title>The <literal>"plugin-unload"</literal> signal</title> + <para> +Emitted when a plugin is unloaded. + </para> + <programlisting> +void user_function (PurplePlugin *plugin, + gpointer user_data)</programlisting> + <varlistentry> + <term><parameter>plugin</parameter> :</term> + <listitem><simpara>The plugin that was unloaded.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>user_data</parameter> :</term> + <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> + </varlistentry> +</refsect2> - </programlisting> +</refsect1> + </chapter>
--- a/doc/reference/pidgin/pidgin-docs.xml Sun Oct 20 20:05:26 2013 +0530 +++ b/doc/reference/pidgin/pidgin-docs.xml Mon Oct 21 17:54:13 2013 +0530 @@ -75,7 +75,7 @@ </reference> <reference label="II"> - <title>Signals Reference</title> + <title>Purple-signals Reference</title> <xi:include href="signals_gtkaccount.xml" /> <xi:include href="signals_gtkblist.xml" />