/soc/2013/ankitkv/gobjectification: 68bb6c155722: Refactored sig...

[Ankit Vani]

Changeset: 68bb6c155722fca9ffaaeefb215de0ac0fa2b8de
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-10-21 17:54 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/68bb6c155722

Description:

Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.

diffstat:

 doc/reference/libpurple/libpurple-docs.xml |   2 +-
 doc/reference/libpurple/signals_plugin.xml |  70 +++++++++++++++++++----------
 doc/reference/pidgin/pidgin-docs.xml       |   2 +-
 3 files changed, 48 insertions(+), 26 deletions(-)

diffs (107 lines):

diff --git a/doc/reference/libpurple/libpurple-docs.xml b/doc/reference/libpurple/libpurple-docs.xml
--- a/doc/reference/libpurple/libpurple-docs.xml
+++ b/doc/reference/libpurple/libpurple-docs.xml
@@ -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" />
diff --git a/doc/reference/libpurple/signals_plugin.xml b/doc/reference/libpurple/signals_plugin.xml
--- a/doc/reference/libpurple/signals_plugin.xml
+++ b/doc/reference/libpurple/signals_plugin.xml
@@ -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>
 
+<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>
+
+<refsect1 id="plugins.signal-details" role="signals">
+<title role="signals.title">Signal details</title>
+
+<refsect2 id="plugins-plugin-load" role="signal">
+ <title>The <literal>"plugin-load"</literal> signal</title>
+  <para>
+Emitted when a plugin is loaded.
+  </para>
   <programlisting>
- @signals
-  @signal plugin-load
-  @signal plugin-unload
- @endsignals
+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>
 
- @see plugins.h
+<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>
 
- @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
+</refsect1>
 
- @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
-
-  </programlisting>
 </chapter>
diff --git a/doc/reference/pidgin/pidgin-docs.xml b/doc/reference/pidgin/pidgin-docs.xml
--- a/doc/reference/pidgin/pidgin-docs.xml
+++ b/doc/reference/pidgin/pidgin-docs.xml
@@ -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" />