Remove an utterly insane comment .. based on changed by based on originally by change...

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

diff --git a/include/commands/cmd_whowas.h b/include/commands/cmd_whowas.h
index ccbe40493db43438aa52f2146c0b96d46150cbea..28ded7ca2bb038989d862595aa63bd6f463a3614 100644 (file)
--- a/include/commands/cmd_whowas.h
+++ b/include/commands/cmd_whowas.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.
  *
  * ---------------------------------------------------
  */
@@ -33,14 +30,14 @@ enum Internals
 };
 
 /* Forward ref for timer */
-class MaintainTimer;
+class WhoWasMaintainTimer;
 
 /* Forward ref for typedefs */
 class WhoWasGroup;
 
 /** InspTimer that is used to maintain the whowas list, called once an hour
  */
-MaintainTimer* timer;
+extern WhoWasMaintainTimer* timer;
 
 /** A group of users related by nickname
  */
@@ -54,7 +51,10 @@ typedef std::map<irc::string,whowas_set*> whowas_users;
  */
 typedef std::deque<std::pair<time_t,irc::string> > whowas_users_fifo;
 
-/** Handle /WHOWAS
+/** Handle /WHOWAS. 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_whowas : public command_t
 {
@@ -67,9 +67,26 @@ class cmd_whowas : public command_t
         */
        whowas_users_fifo whowas_fifo;
 
+       /* String holding stats so it can be collected
+        */
+       std::string stats;
+
   public:
        cmd_whowas(InspIRCd* Instance);
+       /** 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);
+    /** 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);
@@ -110,12 +127,12 @@ class WhoWasGroup : public classbase
        ~WhoWasGroup();
 };
 
-class MaintainTimer : public InspTimer
+class WhoWasMaintainTimer : public InspTimer
 {
   private:
        InspIRCd* ServerInstance;
   public:
-       MaintainTimer(InspIRCd* Instance, long interval)
+       WhoWasMaintainTimer(InspIRCd* Instance, long interval)
        : InspTimer(interval, Instance->Time(), true), ServerInstance(Instance)
        {
        }