annotate doc/cmd-signals.dox @ 29117:89a523641c64

This change is probably going to be unpopular, but I ask that people give it a chance before blindly reverting it. This shortens and changes a bunch of the text from the About box. I think it's better this way, as the text we had before was insanely long when this shorter text gets the same message across. This also reorganizes some of the help resources we listed (IRC channel, FAQ, etc). This should finish addressing the complaints that prompted me to start looking at this dialog and chopping stuff out of it.
author John Bailey <rekkanoryo@rekkanoryo.org>
date Sat, 03 Oct 2009 20:49:02 +0000
parents 1ca49b349037
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23414
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 */