Mercurial > pidgin
changeset 23414:1ca49b349037
Document the command signals.
| author | Sadrul Habib Chowdhury <imadil@gmail.com> |
|---|---|
| date | Thu, 03 Jul 2008 00:11:48 +0000 |
| parents | a2c625152c52 |
| children | ded0a9cf1785 |
| files | doc/cmd-signals.dox |
| diffstat | 1 files changed, 29 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/cmd-signals.dox Thu Jul 03 00:11:48 2008 +0000 @@ -0,0 +1,29 @@ +/** @page cmd-signals Command Signals + @signals + @signal cmd-added + @signal cmd-removed + @endsignals + + @see cmds.h + + @signaldef cmd-added + @signalproto +void (*cmd_added)(const char *command, PurpleCmdPriority priority, + PurpleCmdFlag flag); + @endsignalproto + @signaldesc + Emitted when a new command is added. + @param command The new command. + @param priority The priority of the new command. + @param flag The command flags. + @endsignaldef + + @signaldef cmd-removed + @signalproto +void (*cmd_removed)(const char *command); + @endsignalproto + @signaldesc + Emitted when a command is removed. + @param command The removed command. + @endsignaldef +*/