doc/reference/libpurple/signals_protocol.xml

Tue, 22 Oct 2013 02:52:36 +0530

author
Ankit Vani <a@nevitus.org>
date
Tue, 22 Oct 2013 02:52:36 +0530
branch
soc.2013.gobjectification.plugins
changeset 36915
13cf9f35c2aa
parent 36905
d256e7a2ec4c
child 36919
ca118d6cc20f
permissions
-rw-r--r--

Updated all purple-signal docs to gtk-doc style

36905
d256e7a2ec4c Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents: 36900
diff changeset
1 <?xml version='1.0' encoding="ISO-8859-1"?>
d256e7a2ec4c Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents: 36900
diff changeset
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
d256e7a2ec4c Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents: 36900
diff changeset
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
d256e7a2ec4c Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents: 36900
diff changeset
4 ]>
d256e7a2ec4c Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents: 36900
diff changeset
5 <chapter id="chapter-signals-protocol">
36915
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
6 <title>Protocol signals</title>
36786
b0bfb3c86942 Added protocol signals docs
Ankit Vani <a@nevitus.org>
parents:
diff changeset
7
36915
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
8 <refsect1 id="protocols.signals" role="signal_proto">
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
9 <title role="signal_proto.title">List of signals</title>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
10 <synopsis>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
11 &quot;<link linkend="protocols-protocol-added">protocol-added</link>&quot;
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
12 &quot;<link linkend="protocols-protocol-removed">protocol-removed</link>&quot;
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
13 </synopsis>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
14 </refsect1>
36786
b0bfb3c86942 Added protocol signals docs
Ankit Vani <a@nevitus.org>
parents:
diff changeset
15
36915
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
16 <refsect1 id="protocols.signal-details" role="signals">
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
17 <title role="signals.title">Signal details</title>
36786
b0bfb3c86942 Added protocol signals docs
Ankit Vani <a@nevitus.org>
parents:
diff changeset
18
36915
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
19 <refsect2 id="protocols-protocol-added" role="signal">
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
20 <title>The <literal>&quot;protocol-added&quot;</literal> signal</title>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
21 <programlisting>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
22 void user_function (PurpleProtocol *protocol,
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
23 gpointer user_data)</programlisting>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
24 <para>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
25 Emitted when a protocol is added.
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
26 </para>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
27 <variablelist role="params">
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
28 <varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
29 <term><parameter>protocol</parameter>&#160;:</term>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
30 <listitem><simpara>The protocol that was added.</simpara></listitem>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
31 </varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
32 <varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
33 <term><parameter>user_data</parameter>&#160;:</term>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
34 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
35 </varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
36 </variablelist>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
37 </refsect2>
36786
b0bfb3c86942 Added protocol signals docs
Ankit Vani <a@nevitus.org>
parents:
diff changeset
38
36915
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
39 <refsect2 id="protocols-protocol-removed" role="signal">
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
40 <title>The <literal>&quot;protocol-removed&quot;</literal> signal</title>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
41 <programlisting>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
42 void user_function (PurpleProtocol *protocol,
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
43 gpointer user_data)</programlisting>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
44 <para>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
45 Emitted when a protocol is removed.
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
46 </para>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
47 <variablelist role="params">
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
48 <varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
49 <term><parameter>protocol</parameter>&#160;:</term>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
50 <listitem><simpara>The protocol that was removed.</simpara></listitem>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
51 </varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
52 <varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
53 <term><parameter>user_data</parameter>&#160;:</term>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
54 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
55 </varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
56 </variablelist>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
57 </refsect2>
36786
b0bfb3c86942 Added protocol signals docs
Ankit Vani <a@nevitus.org>
parents:
diff changeset
58
36915
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
59 </refsect1>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
60
36905
d256e7a2ec4c Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents: 36900
diff changeset
61 </chapter>

mercurial