Mercurial > pidgin3 / annotate

doc/reference/libpurple/signals_cmd.xml@68bb6c155722 (annotated)

doc/reference/libpurple/signals_cmd.xml

Mon, 21 Oct 2013 17:54:13 +0530

author
Ankit Vani <a@nevitus.org>
date
Mon, 21 Oct 2013 17:54:13 +0530
branch
soc.2013.gobjectification.plugins
changeset 36912
68bb6c155722
parent 36905
d256e7a2ec4c
child 36915
13cf9f35c2aa
permissions
-rw-r--r--

Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other 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-cmd">
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
6 <title>Command signals</title>
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
7
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
8 <programlisting>
23557
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
9 @signals
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
10 @signal cmd-added
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
11 @signal cmd-removed
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
12 @endsignals
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
13
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
14 @see cmds.h
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
15
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
16 @signaldef cmd-added
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
17 @signalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
18 void (*cmd_added)(const char *command, PurpleCmdPriority priority,
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
19 PurpleCmdFlag flag);
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
20 @endsignalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
21 @signaldesc
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
22 Emitted when a new command is added.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
23 @param command The new command.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
24 @param priority The priority of the new command.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
25 @param flag The command flags.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
26 @endsignaldef
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
27
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
28 @signaldef cmd-removed
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
29 @signalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
30 void (*cmd_removed)(const char *command);
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
31 @endsignalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
32 @signaldesc
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
33 Emitted when a command is removed.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
34 @param command The removed command.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
35 @endsignaldef
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
36
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
37 </programlisting>
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
38 </chapter>

Mercurial Repository: pidgin3

mercurial