Doxygen comments for command handlers

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7376 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 6 insertions, 0 deletions

diff --git a/include/commands/cmd_kick.h b/include/commands/cmd_kick.h
index 1b760c85e..6a44d0c12 100644
--- a/include/commands/cmd_kick.h
+++ b/include/commands/cmd_kick.h
@@ -33,6 +33,12 @@ class cmd_kick : public command_t
 	/** Constructor for kick.
 	 */
 	cmd_kick (InspIRCd* Instance) : command_t(Instance,"KICK",0,2) { syntax = "<channel> <nick>{,<nick>} [<reason>]"; }
+	/** 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);
 };