annotate doc/cmd-signals.dox @ 31392:a328691c761a

* Don't include ourselves in the list of other endpoints that can be disconnected * Show a different message if there are no other endpoints. Unfortunately this message has a colon after it, because our request API adds a colon to all labels. There's a note in the code listing possible options for fixing that. For now, I think this is an improvement
author Mark Doliner <mark@kingant.net>
date Mon, 22 Nov 2010 07:32:57 +0000
parents 1ca49b349037
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23416
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
1 /** @page cmd-signals Command Signals
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
2 @signals
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
3 @signal cmd-added
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
4 @signal cmd-removed
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
5 @endsignals
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
6
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
7 @see cmds.h
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
8
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
9 @signaldef cmd-added
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
10 @signalproto
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
11 void (*cmd_added)(const char *command, PurpleCmdPriority priority,
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
12 PurpleCmdFlag flag);
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
13 @endsignalproto
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
14 @signaldesc
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
15 Emitted when a new command is added.
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
16 @param command The new command.
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
17 @param priority The priority of the new command.
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
18 @param flag The command flags.
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
19 @endsignaldef
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
20
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
21 @signaldef cmd-removed
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
22 @signalproto
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
23 void (*cmd_removed)(const char *command);
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
24 @endsignalproto
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
25 @signaldesc
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
26 Emitted when a command is removed.
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
27 @param command The removed command.
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
28 @endsignaldef
1ca49b349037 Document the command signals.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
diff changeset
29 */