summaryrefslogtreecommitdiff
path: root/include/commands/cmd_topic.h
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2007-06-17 18:26:13 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2007-06-17 18:26:13 +0000
commitba98faf0d8d95b7490e5508e123a06ba6c7489be (patch)
tree113a7f2208eae24e1dfd711e7e1e37b06d271cad /include/commands/cmd_topic.h
parent814047662b5cd1a3fa48ba3e08b76cbaf3f1deba (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_topic.h')
-rw-r--r--include/commands/cmd_topic.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/include/commands/cmd_topic.h b/include/commands/cmd_topic.h
index ee444f2a8..c3ac113ef 100644
--- a/include/commands/cmd_topic.h
+++ b/include/commands/cmd_topic.h
@@ -33,6 +33,12 @@ class cmd_topic : public command_t
/** Constructor for topic.
*/
cmd_topic (InspIRCd* Instance) : command_t(Instance,"TOPIC",0,1) { syntax = "<channel> [<topic>]"; }
+ /** 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);
};