/soc/2013/ankitkv/gobjectification: ca118d6cc20f: Fix <programli...

Ankit Vani a at nevitus.org
Tue Oct 22 13:18:21 EDT 2013


Changeset: ca118d6cc20f2ff45c7da6bced36ff520d120c7d
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-10-22 22:38 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/ca118d6cc20f

Description:

Fix <programlisting> and Use <note> for signal docs

diffstat:

 doc/reference/libpurple/signals_account.xml      |   95 ++++++----
 doc/reference/libpurple/signals_blist.xml        |   60 ++++--
 doc/reference/libpurple/signals_certificate.xml  |   10 +-
 doc/reference/libpurple/signals_cmd.xml          |   10 +-
 doc/reference/libpurple/signals_connection.xml   |   30 ++-
 doc/reference/libpurple/signals_conversation.xml |  203 +++++++++++++---------
 doc/reference/libpurple/signals_core.xml         |   10 +-
 doc/reference/libpurple/signals_dbus_server.xml  |   10 +-
 doc/reference/libpurple/signals_imgstore.xml     |    9 +-
 doc/reference/libpurple/signals_jabber.xml       |   40 ++-
 doc/reference/libpurple/signals_log.xml          |    9 +-
 doc/reference/libpurple/signals_notify.xml       |   19 +-
 doc/reference/libpurple/signals_plugin.xml       |   10 +-
 doc/reference/libpurple/signals_protocol.xml     |   10 +-
 doc/reference/libpurple/signals_savedstatus.xml  |    5 +-
 doc/reference/libpurple/signals_sound.xml        |    5 +-
 doc/reference/libpurple/signals_xfer.xml         |   45 +++--
 doc/reference/pidgin/signals_gtkaccount.xml      |    5 +-
 doc/reference/pidgin/signals_gtkblist.xml        |   29 +-
 doc/reference/pidgin/signals_gtkconv.xml         |   53 +++--
 doc/reference/pidgin/signals_gtkimhtml.xml       |   30 ++-
 doc/reference/pidgin/signals_gtklog.xml          |    5 +-
 22 files changed, 416 insertions(+), 286 deletions(-)

diffs (truncated from 2029 to 300 lines):

diff --git a/doc/reference/libpurple/signals_account.xml b/doc/reference/libpurple/signals_account.xml
--- a/doc/reference/libpurple/signals_account.xml
+++ b/doc/reference/libpurple/signals_account.xml
@@ -35,9 +35,10 @@
 
 <refsect2 id="accounts-account-created" role="signal">
  <title>The <literal>"account-created"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when an account is created by calling purple_account_new.
   </para>
@@ -55,9 +56,10 @@ Emitted when an account is created by ca
 
 <refsect2 id="accounts-account-destroying" role="signal">
  <title>The <literal>"account-destroying"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when an account is about to be destroyed.
   </para>
@@ -75,9 +77,10 @@ Emitted when an account is about to be d
 
 <refsect2 id="accounts-account-added" role="signal">
  <title>The <literal>"account-added"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when an account is added.
   </para>
@@ -95,9 +98,10 @@ Emitted when an account is added.
 
 <refsect2 id="accounts-account-connecting" role="signal">
  <title>The <literal>"account-connecting"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 This is called when an account is in the process of connecting.
   </para>
@@ -115,9 +119,10 @@ This is called when an account is in the
 
 <refsect2 id="accounts-account-removed" role="signal">
  <title>The <literal>"account-removed"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when an account is removed.
   </para>
@@ -135,9 +140,10 @@ Emitted when an account is removed.
 
 <refsect2 id="accounts-account-disabled" role="signal">
  <title>The <literal>"account-disabled"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when an account is disabled.
   </para>
@@ -155,9 +161,10 @@ Emitted when an account is disabled.
 
 <refsect2 id="accounts-account-enabled" role="signal">
  <title>The <literal>"account-enabled"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when an account is enabled.
   </para>
@@ -175,10 +182,11 @@ Emitted when an account is enabled.
 
 <refsect2 id="accounts-account-setting-info" role="signal">
  <title>The <literal>"account-setting-info"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
                                                         const char *new_info,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when a user is about to send his new user info, or profile, to the server.
   </para>
@@ -200,10 +208,11 @@ Emitted when a user is about to send his
 
 <refsect2 id="accounts-account-set-info" role="signal">
  <title>The <literal>"account-set-info"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
                                                         const char *new_info,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when a user sent his new user info, or profile, to the server.
   </para>
@@ -225,11 +234,12 @@ Emitted when a user sent his new user in
 
 <refsect2 id="accounts-account-status-changed" role="signal">
  <title>The <literal>"account-status-changed"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
                                                         PurpleStatus *old,
                                                         PurpleStatus *new,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when the status of an account changes (after the change).
   </para>
@@ -255,9 +265,10 @@ Emitted when the status of an account ch
 
 <refsect2 id="accounts-account-actions-changed" role="signal">
  <title>The <literal>"account-actions-changed"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when the account actions are changed after initial connection.
   </para>
@@ -275,10 +286,11 @@ Emitted when the account actions are cha
 
 <refsect2 id="accounts-account-alias-changed" role="signal">
  <title>The <literal>"account-alias-changed"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
                                                         const char *old,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when the alias of an account changes (after the change).
   </para>
@@ -300,12 +312,13 @@ Emitted when the alias of an account cha
 
 <refsect2 id="accounts-account-authorization-requested" role="signal">
  <title>The <literal>"account-authorization-requested"</literal> signal</title>
-  <programlisting>
+<programlisting>
 int                 user_function                      (PurpleAccount *account,
                                                         const char *user,
                                                         const char *message,
                                                         char **response,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when a user requests authorization.
   </para>
@@ -339,11 +352,12 @@ Emitted when a user requests authorizati
 
 <refsect2 id="accounts-account-authorization-denied" role="signal">
  <title>The <literal>"account-authorization-denied"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
                                                         const char *user,
                                                         const char *message,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when the authorization request for a buddy is denied.
   </para>
@@ -369,11 +383,12 @@ Emitted when the authorization request f
 
 <refsect2 id="accounts-account-authorization-granted" role="signal">
  <title>The <literal>"account-authorization-granted"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
                                                         const char *user,
                                                         const char *message,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when the authorization request for a buddy is granted.
   </para>
@@ -399,11 +414,12 @@ Emitted when the authorization request f
 
 <refsect2 id="accounts-account-error-changed" role="signal">
  <title>The <literal>"account-error-changed"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
                                                         const PurpleConnectionErrorInfo *old_error,
                                                         const PurpleConnectionErrorInfo *current_error,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when <literal>account</literal>'s error changes.  You should not call purple_account_clear_current_error() while this signal is being emitted.
   </para>
@@ -429,9 +445,10 @@ Emitted when <literal>account</literal>'
 
 <refsect2 id="accounts-account-signed-on" role="signal">
  <title>The <literal>"account-signed-on"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when an account has signed on.
   </para>
@@ -449,9 +466,10 @@ Emitted when an account has signed on.
 
 <refsect2 id="accounts-account-signed-off" role="signal">
  <title>The <literal>"account-signed-off"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *account,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when an account has signed off.
   </para>
@@ -469,11 +487,12 @@ Emitted when an account has signed off.
 
 <refsect2 id="accounts-account-connection-error" role="signal">
  <title>The <literal>"account-connection-error"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleAccount *gc,
                                                         PurpleConnectionError err,
                                                         const gchar *desc,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when a connection error occurs, before <literal>"signed"</literal>-off.
   </para>
diff --git a/doc/reference/libpurple/signals_blist.xml b/doc/reference/libpurple/signals_blist.xml
--- a/doc/reference/libpurple/signals_blist.xml
+++ b/doc/reference/libpurple/signals_blist.xml
@@ -26,11 +26,12 @@
 
 <refsect2 id="blist-buddy-status-changed" role="signal">
  <title>The <literal>"buddy-status-changed"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleBuddy *buddy,
                                                         PurpleStatus *old_status,
                                                         PurpleStatus *status,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when a buddy on your buddy list goes away.
   </para>
@@ -56,11 +57,12 @@ Emitted when a buddy on your buddy list 
 
 <refsect2 id="blist-buddy-idle-changed" role="signal">
  <title>The <literal>"buddy-idle-changed"</literal> signal</title>
-  <programlisting>
+<programlisting>
 void                user_function                      (PurpleBuddy *buddy,
                                                         gboolean old_idle,
                                                         gboolean idle,
-                                                        gpointer user_data)</programlisting>
+                                                        gpointer user_data)
+</programlisting>
   <para>
 Emitted when a buddy on your buddy list becomes idle.
   </para>
@@ -86,9 +88,10 @@ Emitted when a buddy on your buddy list 



More information about the Commits mailing list