From ba98faf0d8d95b7490e5508e123a06ba6c7489be Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 17 Jun 2007 18:26:13 +0000 Subject: Doxygen comments for command handlers git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7376 e03df62e-2008-0410-955e-edbf42e46eb7 --- include/commands/cmd_away.h | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'include/commands/cmd_away.h') diff --git a/include/commands/cmd_away.h b/include/commands/cmd_away.h index 3c138dd1d..88d111c78 100644 --- a/include/commands/cmd_away.h +++ b/include/commands/cmd_away.h @@ -33,6 +33,12 @@ class cmd_away : public command_t /** Constructor for away. */ cmd_away (InspIRCd* Instance) : command_t(Instance,"AWAY",0,0) { syntax = "[]"; } + /** 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); }; -- cgit v1.2.3