doc/reference/libpurple/signals_cmd.xml

branch
soc.2013.gobjectification.plugins
changeset 36915
13cf9f35c2aa
parent 36905
d256e7a2ec4c
child 36919
ca118d6cc20f
--- a/doc/reference/libpurple/signals_cmd.xml	Tue Oct 22 02:51:40 2013 +0530
+++ b/doc/reference/libpurple/signals_cmd.xml	Tue Oct 22 02:52:36 2013 +0530
@@ -3,36 +3,69 @@
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 ]>
 <chapter id="chapter-signals-cmd">
-  <title>Command signals</title>
+<title>Command signals</title>
 
-  <programlisting>
-  @signals
-  	@signal cmd-added
-	@signal cmd-removed
-  @endsignals
+<refsect1 id="cmds.signals" role="signal_proto">
+<title role="signal_proto.title">List of signals</title>
+<synopsis>
+  &quot;<link linkend="cmds-cmd-added">cmd-added</link>&quot;
+  &quot;<link linkend="cmds-cmd-removed">cmd-removed</link>&quot;
+</synopsis>
+</refsect1>
 
-  @see cmds.h
+<refsect1 id="cmds.signal-details" role="signals">
+<title role="signals.title">Signal details</title>
 
-  @signaldef cmd-added
-  	@signalproto
-void (*cmd_added)(const char *command, PurpleCmdPriority priority,
-                  PurpleCmdFlag flag);
-	@endsignalproto
-	@signaldesc
-	 Emitted when a new command is added.
-	@param command   The new command.
-	@param priority  The priority of the new command.
-	@param flag      The command flags.
-  @endsignaldef
+<refsect2 id="cmds-cmd-added" role="signal">
+ <title>The <literal>&quot;cmd-added&quot;</literal> signal</title>
+  <programlisting>
+void                user_function                      (const char *command,
+                                                        PurpleCmdPriority priority,
+                                                        PurpleCmdFlag flag,
+                                                        gpointer user_data)</programlisting>
+  <para>
+Emitted when a new command is added.
+  </para>
+  <variablelist role="params">
+  <varlistentry>
+    <term><parameter>command</parameter>&#160;:</term>
+    <listitem><simpara>The new command.</simpara></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><parameter>priority</parameter>&#160;:</term>
+    <listitem><simpara>The priority of the new command.</simpara></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><parameter>flag</parameter>&#160;:</term>
+    <listitem><simpara>The command flags.</simpara></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><parameter>user_data</parameter>&#160;:</term>
+    <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+  </varlistentry>
+  </variablelist>
+</refsect2>
 
-  @signaldef cmd-removed
-  	@signalproto
-void (*cmd_removed)(const char *command);
-	@endsignalproto
-	@signaldesc
-	 Emitted when a command is removed.
-	@param command   The removed command.
-  @endsignaldef
+<refsect2 id="cmds-cmd-removed" role="signal">
+ <title>The <literal>&quot;cmd-removed&quot;</literal> signal</title>
+  <programlisting>
+void                user_function                      (const char *command,
+                                                        gpointer user_data)</programlisting>
+  <para>
+Emitted when a command is removed.
+  </para>
+  <variablelist role="params">
+  <varlistentry>
+    <term><parameter>command</parameter>&#160;:</term>
+    <listitem><simpara>The removed command.</simpara></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><parameter>user_data</parameter>&#160;:</term>
+    <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+  </varlistentry>
+  </variablelist>
+</refsect2>
 
-  </programlisting>
+</refsect1>
+
 </chapter>

mercurial