OOPS! We try again, since I'm smoking craq. LF is 0x0a NOT CR.

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

diff --git a/include/commands/cmd_qline.h b/include/commands/cmd_qline.h
index 423b48b9b928921fecd6c4ff2ffa81a6fea852f7..5d69f9a9a0638133c17729e56b13c57489b58cf7 100644 (file)
--- a/include/commands/cmd_qline.h
+++ b/include/commands/cmd_qline.h
@@ -2,14 +2,14 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *                <Craig@chatspike.net>
+ *  InspIRCd is copyright (C) 2002-2007 ChatSpike-Dev.
+ *                    E-mail:
+ *             <brain@chatspike.net>
+ *             <Craig@chatspike.net>
  *
  * 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,13 +22,24 @@
 #include "users.h"
 #include "channels.h"
 
-/** Handle /QLINE
+/** Handle /QLINE. 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_qline : public command_t
 {
  public:
-        cmd_qline (InspIRCd* Instance) : command_t(Instance,"QLINE",'o',1) { syntax = "<nick> [<duration> :<reason>]"; }
-        CmdResult Handle(const char** parameters, int pcnt, userrec *user);
+       /** Constructor for qline.
+        */
+       cmd_qline (InspIRCd* Instance) : command_t(Instance,"QLINE",'o',1) { syntax = "<nick> [<duration> :<reason>]"; }
+       /** 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