diff options
author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2007-06-17 18:26:13 +0000 |
---|---|---|
committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2007-06-17 18:26:13 +0000 |
commit | ba98faf0d8d95b7490e5508e123a06ba6c7489be (patch) | |
tree | 113a7f2208eae24e1dfd711e7e1e37b06d271cad /include/commands/cmd_who.h | |
parent | 814047662b5cd1a3fa48ba3e08b76cbaf3f1deba (diff) |
Doxygen comments for command handlers
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7376 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'include/commands/cmd_who.h')
-rw-r--r-- | include/commands/cmd_who.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/include/commands/cmd_who.h b/include/commands/cmd_who.h index 625fdd199..6ccfa3b5d 100644 --- a/include/commands/cmd_who.h +++ b/include/commands/cmd_who.h @@ -46,6 +46,12 @@ class cmd_who : public command_t */ cmd_who (InspIRCd* Instance) : command_t(Instance,"WHO",0,1) { syntax = "<server>|<nickname>|<channel>|<realname>|<host>|0 [ohurmMiaplf]"; } void SendWhoLine(userrec* user, const std::string &initial, chanrec* ch, userrec* u, std::vector<std::string> &whoresults); + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); bool whomatch(userrec* user, const char* matchtext); }; |