/soc/2013/ankitkv/gobjectification: 13cf9f35c2aa: Updated all pu...
Ankit Vani
a at nevitus.org
Mon Oct 21 17:22:59 EDT 2013
Changeset: 13cf9f35c2aabc88c8f9d0c7fb88f1b540931cdf
Author: Ankit Vani <a at nevitus.org>
Date: 2013-10-22 02:52 +0530
Branch: soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/13cf9f35c2aa
Description:
Updated all purple-signal docs to gtk-doc style
diffstat:
doc/reference/libpurple/signals_account.xml | 682 ++++++--
doc/reference/libpurple/signals_blist.xml | 345 +++-
doc/reference/libpurple/signals_certificate.xml | 78 +-
doc/reference/libpurple/signals_cmd.xml | 87 +-
doc/reference/libpurple/signals_connection.xml | 212 +-
doc/reference/libpurple/signals_conversation.xml | 1631 +++++++++++++++------
doc/reference/libpurple/signals_core.xml | 80 +-
doc/reference/libpurple/signals_dbus_server.xml | 86 +-
doc/reference/libpurple/signals_imgstore.xml | 53 +-
doc/reference/libpurple/signals_jabber.xml | 411 +++-
doc/reference/libpurple/signals_log.xml | 68 +-
doc/reference/libpurple/signals_notify.xml | 170 +-
doc/reference/libpurple/signals_plugin.xml | 16 +-
doc/reference/libpurple/signals_protocol.xml | 74 +-
doc/reference/libpurple/signals_savedstatus.xml | 35 +-
doc/reference/libpurple/signals_sound.xml | 56 +-
doc/reference/libpurple/signals_xfer.xml | 290 ++-
doc/reference/pidgin/signals_gtkaccount.xml | 45 +-
doc/reference/pidgin/signals_gtkblist.xml | 188 +-
doc/reference/pidgin/signals_gtkconv.xml | 433 ++++-
doc/reference/pidgin/signals_gtkimhtml.xml | 215 ++-
doc/reference/pidgin/signals_gtklog.xml | 51 +-
22 files changed, 3666 insertions(+), 1640 deletions(-)
diffs (truncated from 5699 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
@@ -3,234 +3,500 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<chapter id="chapter-signals-account">
- <title>Account signals</title>
+<title>Account signals</title>
+<refsect1 id="accounts.signals" role="signal_proto">
+<title role="signal_proto.title">List of signals</title>
+<synopsis>
+ "<link linkend="accounts-account-created">account-created</link>"
+ "<link linkend="accounts-account-destroying">account-destroying</link>"
+ "<link linkend="accounts-account-added">account-added</link>"
+ "<link linkend="accounts-account-connecting">account-connecting</link>"
+ "<link linkend="accounts-account-removed">account-removed</link>"
+ "<link linkend="accounts-account-disabled">account-disabled</link>"
+ "<link linkend="accounts-account-enabled">account-enabled</link>"
+ "<link linkend="accounts-account-setting-info">account-setting-info</link>"
+ "<link linkend="accounts-account-set-info">account-set-info</link>"
+ "<link linkend="accounts-account-status-changed">account-status-changed</link>"
+ "<link linkend="accounts-account-actions-changed">account-actions-changed</link>"
+ "<link linkend="accounts-account-alias-changed">account-alias-changed</link>"
+ "<link linkend="accounts-account-authorization-requested">account-authorization-requested</link>"
+ "<link linkend="accounts-account-authorization-denied">account-authorization-denied</link>"
+ "<link linkend="accounts-account-authorization-granted">account-authorization-granted</link>"
+ "<link linkend="accounts-account-error-changed">account-error-changed</link>"
+ "<link linkend="accounts-account-signed-on">account-signed-on</link>"
+ "<link linkend="accounts-account-signed-off">account-signed-off</link>"
+ "<link linkend="accounts-account-connection-error">account-connection-error</link>"
+</synopsis>
+</refsect1>
+
+<refsect1 id="accounts.signal-details" role="signals">
+<title role="signals.title">Signal details</title>
+
+<refsect2 id="accounts-account-created" role="signal">
+ <title>The <literal>"account-created"</literal> signal</title>
<programlisting>
- @signals
- @signal account-created
- @signal account-destroying
- @signal account-added
- @signal account-connecting
- @signal account-removed
- @signal account-disabled
- @signal account-enabled
- @signal account-setting-info
- @signal account-set-info
- @signal account-status-changed
- @signal account-actions-changed
- @signal account-alias-changed
- @signal account-authorization-requested
- @signal account-authorization-denied
- @signal account-authorization-granted
- @signal account-error-changed
- @signal account-signed-on
- @signal account-signed-off
- @signal account-connection-error
- @endsignals
+void user_function (PurpleAccount *account,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when an account is created by calling purple_account_new.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>account</parameter> :</term>
+ <listitem><simpara>The account.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @see account.h
+<refsect2 id="accounts-account-destroying" role="signal">
+ <title>The <literal>"account-destroying"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleAccount *account,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when an account is about to be destroyed.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>account</parameter> :</term>
+ <listitem><simpara>The account.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef account-created
- @signalproto
-void (*account_created)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is created by calling purple_account_new.
- @param account The account.
- @endsignaldef
+<refsect2 id="accounts-account-added" role="signal">
+ <title>The <literal>"account-added"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleAccount *account,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when an account is added.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>account</parameter> :</term>
+ <listitem><simpara>The account that was added. See <literal>purple_accounts_add</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef account-destroying
- @signalproto
-void (*account_destroying)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is about to be destroyed.
- @param account The account.
- @endsignaldef
+<refsect2 id="accounts-account-connecting" role="signal">
+ <title>The <literal>"account-connecting"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleAccount *account,
+ gpointer user_data)</programlisting>
+ <para>
+This is called when an account is in the process of connecting.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>account</parameter> :</term>
+ <listitem><simpara>The account in the process of connecting.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef account-added
- @signalproto
-void (*account_added)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is added.
- @param account The account that was added.
- @see purple_accounts_add
- @endsignaldef
+<refsect2 id="accounts-account-removed" role="signal">
+ <title>The <literal>"account-removed"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleAccount *account,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when an account is removed.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>account</parameter> :</term>
+ <listitem><simpara>The account that was removed. See <literal>purple_accounts_remove</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef account-connecting
- @signalproto
-void (*account_connecting)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- This is called when an account is in the process of connecting.
- @param account The account in the process of connecting.
- @endsignaldef
+<refsect2 id="accounts-account-disabled" role="signal">
+ <title>The <literal>"account-disabled"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleAccount *account,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when an account is disabled.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>account</parameter> :</term>
+ <listitem><simpara>The account that was disabled.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef account-removed
- @signalproto
-void (*account_removed)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is removed.
- @param account The account that was removed.
- @see purple_accounts_remove
- @endsignaldef
+<refsect2 id="accounts-account-enabled" role="signal">
+ <title>The <literal>"account-enabled"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleAccount *account,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when an account is enabled.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>account</parameter> :</term>
+ <listitem><simpara>The account that was enabled.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef account-disabled
- @signalproto
-void (*account_disabled)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is disabled.
- @param account The account that was disabled.
- @endsignaldef
+<refsect2 id="accounts-account-setting-info" role="signal">
+ <title>The <literal>"account-setting-info"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleAccount *account,
+ const char *new_info,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a user is about to send his new user info, or profile, to the server.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>account</parameter> :</term>
+ <listitem><simpara>The account that the info will be set on.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>new_info</parameter> :</term>
+ <listitem><simpara>The new information to set.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef account-enabled
- @signalproto
-void (*account_enabled)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is enabled.
- @param account The account that was enabled.
- @endsignaldef
+<refsect2 id="accounts-account-set-info" role="signal">
+ <title>The <literal>"account-set-info"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleAccount *account,
+ const char *new_info,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a user sent his new user info, or profile, to the server.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>account</parameter> :</term>
+ <listitem><simpara>The account that the info was set on.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>new_info</parameter> :</term>
+ <listitem><simpara>The new information set.</simpara></listitem>
More information about the Commits
mailing list