Initialise cmd_nick::allowinvalid in constructor init-list, and document HandleIntern...

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

diff --git a/include/commands/cmd_admin.h b/include/commands/cmd_admin.h
index 0c2cfaa7bef5e603a958b807aa12f03c58acc3d8..c1f90312b40792bae36b610aa73db1c6a5d2fe1c 100644 (file)
--- a/include/commands/cmd_admin.h
+++ b/include/commands/cmd_admin.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.
  *
  * ---------------------------------------------------
  */
@@ -19,15 +16,25 @@
 
 #include "users.h"
 #include "channels.h"
-#include "ctables.h"
 
-/** Handle /ADMIN
+/** Handle /ADMIN. 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_admin : public command_t
 {
  public:
-        cmd_admin (InspIRCd* Instance) : command_t(Instance,"ADMIN",0,0) { syntax = "[<servername>]"; }
-        CmdResult Handle(const char** parameters, int pcnt, userrec *user);
+       /** Constructor for admin.
+        */
+       cmd_admin (InspIRCd* Instance) : command_t(Instance,"ADMIN",0,0) { syntax = "[<servername>]"; }
+       /** 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);
 };
 
 #endif