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_oper.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_oper.h')
-rw-r--r-- | include/commands/cmd_oper.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/include/commands/cmd_oper.h b/include/commands/cmd_oper.h index 2856ea98f..77c4b0125 100644 --- a/include/commands/cmd_oper.h +++ b/include/commands/cmd_oper.h @@ -35,6 +35,12 @@ class cmd_oper : public command_t /** Constructor for oper. */ cmd_oper (InspIRCd* Instance) : command_t(Instance,"OPER",0,2) { syntax = "<username> <password>"; } + /** 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); }; |