doc/reference/libpurple/signals_plugin.xml@ca118d6cc20f (annotated)
doc/reference/libpurple/signals_plugin.xml
Tue, 22 Oct 2013 22:38:49 +0530
- author
- Ankit Vani <a@nevitus.org>
- date
- Tue, 22 Oct 2013 22:38:49 +0530
- branch
- soc.2013.gobjectification.plugins
- changeset 36919
- ca118d6cc20f
- parent 36915
- 13cf9f35c2aa
- child 37097
- aef5930bd889
- permissions
- -rw-r--r--
Fix <programlisting> and Use <note> for signal docs
|
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-plugin"> |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
6 | <title>Plugin signals</title> |
| 12053 | 7 | |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
8 | <refsect1 id="plugins.signals" role="signal_proto"> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
9 | <title role="signal_proto.title">List of signals</title> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
10 | <synopsis> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
11 | "<link linkend="plugins-plugin-load">plugin-load</link>" |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
12 | "<link linkend="plugins-plugin-unload">plugin-unload</link>" |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
13 | </synopsis> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
14 | </refsect1> |
| 12053 | 15 | |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
16 | <refsect1 id="plugins.signal-details" role="signals"> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
17 | <title role="signals.title">Signal details</title> |
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
18 | |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
19 | <refsect2 id="plugins-plugin-load" role="signal"> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
20 | <title>The <literal>"plugin-load"</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:
36912
diff
changeset
|
22 | void user_function (PurplePlugin *plugin, |
|
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> |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
25 | <para> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
26 | Emitted when a plugin is loaded. |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
27 | </para> |
|
36915
13cf9f35c2aa
Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents:
36912
diff
changeset
|
28 | <variablelist role="params"> |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
29 | <varlistentry> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
30 | <term><parameter>plugin</parameter> :</term> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
31 | <listitem><simpara>The plugin that was loaded.</simpara></listitem> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
32 | </varlistentry> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
33 | <varlistentry> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
34 | <term><parameter>user_data</parameter> :</term> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
35 | <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
36 | </varlistentry> |
|
36915
13cf9f35c2aa
Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents:
36912
diff
changeset
|
37 | </variablelist> |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
38 | </refsect2> |
| 12053 | 39 | |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
40 | <refsect2 id="plugins-plugin-unload" role="signal"> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
41 | <title>The <literal>"plugin-unload"</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:
36912
diff
changeset
|
43 | void user_function (PurplePlugin *plugin, |
|
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> |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
46 | <para> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
47 | Emitted when a plugin is unloaded. |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
48 | </para> |
|
36915
13cf9f35c2aa
Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents:
36912
diff
changeset
|
49 | <variablelist role="params"> |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
50 | <varlistentry> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
51 | <term><parameter>plugin</parameter> :</term> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
52 | <listitem><simpara>The plugin that was unloaded.</simpara></listitem> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
53 | </varlistentry> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
54 | <varlistentry> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
55 | <term><parameter>user_data</parameter> :</term> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
56 | <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
57 | </varlistentry> |
|
36915
13cf9f35c2aa
Updated all purple-signal docs to gtk-doc style
Ankit Vani <a@nevitus.org>
parents:
36912
diff
changeset
|
58 | </variablelist> |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
59 | </refsect2> |
| 12053 | 60 | |
|
36912
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
Ankit Vani <a@nevitus.org>
parents:
36905
diff
changeset
|
61 | </refsect1> |
|
68bb6c155722
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
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> |
