doc/reference/libpurple/signals_protocol.xml

Tue, 04 Feb 2014 01:36:57 +0530

author
Ankit Vani <a@nevitus.org>
date
Tue, 04 Feb 2014 01:36:57 +0530
branch
soc.2013.gobjectification.plugins
changeset 37059
18f5830bd82c
parent 36919
ca118d6cc20f
permissions
-rw-r--r--

Merge gtkdoc-conversion

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>
36919
ca118d6cc20f Fix <programlisting> and Use <note> for signal docs
Ankit Vani <a@nevitus.org>
parents: 36915
diff changeset
21 <programlisting>
36915
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,
36919
ca118d6cc20f Fix <programlisting> and Use <note> for signal docs
Ankit Vani <a@nevitus.org>
parents: 36915
diff changeset
23 gpointer user_data)
ca118d6cc20f Fix <programlisting> and Use <note> for signal docs
Ankit Vani <a@nevitus.org>
parents: 36915
diff changeset
24 </programlisting>
36915
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
25 <para>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
26 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
27 </para>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
28 <variablelist role="params">
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
29 <varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
30 <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
31 <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
32 </varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
33 <varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
34 <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
35 <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
36 </varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
37 </variablelist>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
38 </refsect2>
36786
b0bfb3c86942 Added protocol signals docs
Ankit Vani <a@nevitus.org>
parents:
diff changeset
39
36915
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
40 <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
41 <title>The <literal>&quot;protocol-removed&quot;</literal> signal</title>
36919
ca118d6cc20f Fix <programlisting> and Use <note> for signal docs
Ankit Vani <a@nevitus.org>
parents: 36915
diff changeset
42 <programlisting>
36915
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
43 void user_function (PurpleProtocol *protocol,
36919
ca118d6cc20f Fix <programlisting> and Use <note> for signal docs
Ankit Vani <a@nevitus.org>
parents: 36915
diff changeset
44 gpointer user_data)
ca118d6cc20f Fix <programlisting> and Use <note> for signal docs
Ankit Vani <a@nevitus.org>
parents: 36915
diff changeset
45 </programlisting>
36915
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 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
48 </para>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
49 <variablelist role="params">
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
50 <varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
51 <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
52 <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
53 </varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
54 <varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
55 <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
56 <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
57 </varlistentry>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
58 </variablelist>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
59 </refsect2>
36786
b0bfb3c86942 Added protocol signals docs
Ankit Vani <a@nevitus.org>
parents:
diff changeset
60
36915
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
61 </refsect1>
13cf9f35c2aa Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents: 36905
diff changeset
62
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
63 </chapter>

mercurial