summaryrefslogtreecommitdiff
path: root/include/commands/cmd_whowas.h
diff options
context:
space:
mode:
authorpeavey <peavey@e03df62e-2008-0410-955e-edbf42e46eb7>2007-07-24 16:56:23 +0000
committerpeavey <peavey@e03df62e-2008-0410-955e-edbf42e46eb7>2007-07-24 16:56:23 +0000
commitee47b42586e1c8fdf17c196ed92ac78ed6502599 (patch)
tree6275538476f6a5558b2f2633a0fad3e10f5201da /include/commands/cmd_whowas.h
parent62e03b9d83caca311166b0a1134fcc43bac7ae76 (diff)
Fix comment so it makes sense.
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7552 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'include/commands/cmd_whowas.h')
-rw-r--r--include/commands/cmd_whowas.h13
1 files changed, 7 insertions, 6 deletions
diff --git a/include/commands/cmd_whowas.h b/include/commands/cmd_whowas.h
index 22555d5a0..28ded7ca2 100644
--- a/include/commands/cmd_whowas.h
+++ b/include/commands/cmd_whowas.h
@@ -80,12 +80,13 @@ class cmd_whowas : public command_t
* @return A value from CmdResult to indicate command success or failure.
*/
CmdResult Handle(const char** parameters, int pcnt, userrec *user);
- /** 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.
- */
+ /** Handle an internal request from another command, the core, or a module
+ * @param Command ID
+ * @param Zero or more parameters, whos form is specified by the command ID.
+ * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
+ * If the command succeeds but should remain local to this server,
+ * return CMD_LOCALONLY.
+ */
CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> &parameters);
void AddToWhoWas(userrec* user);
void GetStats(Extensible* ext);