Properly name the windows service error constants and put proper descriptions in...

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

diff --git a/include/commands/cmd_join.h b/include/commands/cmd_join.h
index fd3e948a99039df23fd81bd9cfd6f141db109a76..7b5fc76b9879ddb341cc2a032a0ed62277192645 100644 (file)
--- a/include/commands/cmd_join.h
+++ b/include/commands/cmd_join.h
@@ -2,14 +2,11 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *                <Craig@chatspike.net>
+ *  InspIRCd: (C) 2002-2008 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,11 +19,24 @@
 #include "users.h"
 #include "channels.h"
 
-class cmd_join : public command_t
+/** Handle /JOIN. 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 CommandJoin : public Command
 {
  public:
-        cmd_join (InspIRCd* Instance) : command_t(Instance,"JOIN",0,1) { syntax = "<channel>{,<channel>} {<key>{,<key>}}"; }
-        CmdResult Handle(const char** parameters, int pcnt, userrec *user);
+       /** Constructor for join.
+        */
+       CommandJoin (InspIRCd* Instance) : Command(Instance,"JOIN", 0, 1, false, 2) { syntax = "<channel>{,<channel>} {<key>{,<key>}}"; }
+       /** 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 std::vector<std::string>& parameters, User *user);
 };
 
 #endif