doc/cmd-signals.dox

Mon, 22 Aug 2011 06:55:20 +0000

author
Andrew Victor <andrew.victor@mxit.com>
date
Mon, 22 Aug 2011 06:55:20 +0000
branch
mxit
changeset 32343
ba09dcec0814
parent 23557
73ca7c62ad11
permissions
-rw-r--r--

merge of '83a126c3d1bd6fceebe61dd4c350672e4173bb29'
and 'bdc6f42dba4a1865f225e53380a558ed8f066b4d'

23557
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
1 /** @page cmd-signals Command Signals
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
2 @signals
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
3 @signal cmd-added
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
4 @signal cmd-removed
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
5 @endsignals
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
6
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
7 @see cmds.h
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
8
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
9 @signaldef cmd-added
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
10 @signalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
11 void (*cmd_added)(const char *command, PurpleCmdPriority priority,
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
12 PurpleCmdFlag flag);
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
13 @endsignalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
14 @signaldesc
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
15 Emitted when a new command is added.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
16 @param command The new command.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
17 @param priority The priority of the new command.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
18 @param flag The command flags.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
19 @endsignaldef
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
20
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
21 @signaldef cmd-removed
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
22 @signalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
23 void (*cmd_removed)(const char *command);
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
24 @endsignalproto
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
25 @signaldesc
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
26 Emitted when a command is removed.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
27 @param command The removed command.
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
28 @endsignaldef
73ca7c62ad11 Document the command signals.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
29 */

mercurial