Add a global fake client to class InspIRCd used instead of instantiating a fake clien...

[user/henk/code/inspircd.git] / include / commands / cmd_rehash.h

diff --git a/include/commands/cmd_rehash.h b/include/commands/cmd_rehash.h
index 9f85fe26b68f1b397191098f59120f1d72d1a55d..818a038c816aef3306db3a294a04fc4b47c5cea2 100644 (file)
--- a/include/commands/cmd_rehash.h
+++ b/include/commands/cmd_rehash.h
@@ -2,14 +2,11 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2007 ChatSpike-Dev.
- *                    E-mail:
- *             <brain@chatspike.net>
- *             <Craig@chatspike.net>
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
  *
- * Written by Craig Edwards, Craig McLure, and others.
  * This program is free but copyrighted software; see
- *         the file COPYING for details.
+ *      the file COPYING for details.
  *
  * ---------------------------------------------------
  */
@@ -22,12 +19,23 @@
 #include "users.h"
 #include "channels.h"
 
-/** Handle /REHASH
+/** Handle /REHASH. These command handlers can be reloaded by the core,
+ * and handle basic RFC1459 commands. Commands within modules work
+ * the same way, however, they can be fully unloaded, where these
+ * may not.
  */
 class cmd_rehash : public command_t
 {
  public:
+       /** Constructor for rehash.
+        */
        cmd_rehash (InspIRCd* Instance) : command_t(Instance,"REHASH",'o',0) { syntax = "[<servermask>]"; }
+       /** 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);
 };