Document a ton of classes (e.g. give them a short description for http://svn.inspircd...

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@5434 e03df62e-2008-0410-955e-edbf42e46eb7

diff --git a/include/commands/cmd_unloadmodule.h b/include/commands/cmd_unloadmodule.h
index ba19bc5e14e2e6f17f432fcf2f17635f6fccb7bc..c2d2d473d3b248ef9d1fd8082617f28e3345649a 100644 (file)
--- a/include/commands/cmd_unloadmodule.h
+++ b/include/commands/cmd_unloadmodule.h
@@ -22,6 +22,8 @@
 #include "users.h"
 #include "channels.h"
 
+/** Handle /UNLOADMODULE
+ */
 class cmd_unloadmodule : public command_t
 {
  public:

diff --git a/include/commands/cmd_user.h b/include/commands/cmd_user.h
index f5d7cb242c0cfa4471c0a09408e400d0fba671bc..e7b9784bdfb08187b8ed49e72e4b54d0c7b1c034 100644 (file)
--- a/include/commands/cmd_user.h
+++ b/include/commands/cmd_user.h
@@ -22,6 +22,8 @@
 #include "users.h"
 #include "channels.h"
 
+/** Handle /USER
+ */
 class cmd_user : public command_t
 {
  public:

diff --git a/include/hashcomp.h b/include/hashcomp.h
index b22f65272a81cbe85da5772b6d9ecdb7ae240b61..b2756b340e02e1608b69b2eed288c53aea868c76 100644 (file)
--- a/include/hashcomp.h
+++ b/include/hashcomp.h
@@ -248,10 +248,8 @@ namespace irc
                const std::string GetToken();
        };
 
-       /** irc::commasepstream allows for splitting comma seperated lists.
-        * Lists passed to irc::commasepstream should not contain spaces
-        * after the commas, or this will be taken to be part of the item
-        * data. Each successive call to commasepstream::GetToken() returns
+       /** irc::sepstream allows for splitting token seperated lists.
+        * Each successive call to sepstream::GetToken() returns
         * the next token, until none remain, at which point the method returns
         * an empty string.
         */
@@ -263,7 +261,7 @@ namespace irc
                std::string::iterator n;
                char sep;
         public:
-               /** Create a commasepstream and fill it with the provided data
+               /** Create a sepstream and fill it with the provided data
                 */
                sepstream(const std::string &source, char seperator);
                virtual ~sepstream();
@@ -274,6 +272,8 @@ namespace irc
                virtual const std::string GetToken();
        };
 
+       /** A derived form of sepstream, which seperates on commas
+        */
        class commasepstream : public sepstream
        {
         public:
@@ -282,6 +282,8 @@ namespace irc
                }
        };
 
+       /** A derived form of sepstream, which seperates on spaces
+        */
        class spacesepstream : public sepstream
        {
         public:

diff --git a/include/u_listmode.h b/include/u_listmode.h
index 8315dbcd1e7e795bc38b5ade6544edc916aeca50..d5416988a553661916927b109c508e3dc3eb22f4 100644 (file)
--- a/include/u_listmode.h
+++ b/include/u_listmode.h
@@ -27,6 +27,8 @@ inline std::string stringtime()
        return TIME.str();
 }
 
+/** An item in a listmode's list
+ */
 class ListItem : public classbase
 {
 public:
@@ -35,6 +37,8 @@ public:
        std::string time;
 };
 
+/** The number of items a listmode's list may contain
+ */
 class ListLimit : public classbase
 {
 public:
@@ -46,6 +50,8 @@ public:
 typedef std::vector<ListItem> modelist;
 typedef std::vector<ListLimit> limitlist;
 
+/** The base class for listmodes defined by u_listmode.h
+ */
 class ListModeBase : public ModeHandler
 {
  protected:

diff --git a/src/modules/extra/m_sslinfo.cpp b/src/modules/extra/m_sslinfo.cpp
index 1be1d8a5af10d0a81293b34c1d3bd25d0ac3b419..a29a616581f9f18daaa44a5bd57109cc738db980 100644 (file)
--- a/src/modules/extra/m_sslinfo.cpp
+++ b/src/modules/extra/m_sslinfo.cpp
@@ -26,7 +26,9 @@ using namespace std;
 #include "dns.h"
 
 /* $ModDesc: Provides /sslinfo command used to test who a mask matches */
-        
+
+/** Handle /SSLINFO
+ */
 class cmd_sslinfo : public command_t
 {
  public:

diff --git a/src/modules/m_nicklock.cpp b/src/modules/m_nicklock.cpp
index 304065007b0a9fa8b05b5363eeecc35488c007e9..ca0c030accd3e0d0978afcb89703cc86e0b88e98 100644 (file)
--- a/src/modules/m_nicklock.cpp
+++ b/src/modules/m_nicklock.cpp
@@ -28,7 +28,8 @@ using namespace std;
 /* $ModDesc: Provides the NICKLOCK command, allows an oper to chage a users nick and lock them to it until they quit */
 
 
-
+/** Handle /NICKLOCK
+ */
 class cmd_nicklock : public command_t
 {
        char* dummy;
@@ -73,6 +74,8 @@ class cmd_nicklock : public command_t
        }
 };
 
+/** Handle /NICKUNLOCK
+ */
 class cmd_nickunlock : public command_t
 {
  public:

diff --git a/src/modules/m_opermotd.cpp b/src/modules/m_opermotd.cpp
index aa22a77a585b164709b06a3ee0797dae45e7f4d1..62c59aa9b522d64108e883a07cd2a0c95ce03023 100644 (file)
--- a/src/modules/m_opermotd.cpp
+++ b/src/modules/m_opermotd.cpp
@@ -30,6 +30,8 @@ CmdResult ShowOperMOTD(userrec* user)
        return CMD_SUCCESS;
 }
 
+/** Handle /OPERMOTD
+ */
 class cmd_opermotd : public command_t
 {
  public:

diff --git a/src/modules/m_randquote.cpp b/src/modules/m_randquote.cpp
index 3163d37a0faed9be7fbe1987c86acbd5483f1a0f..519fb5b93ae08b846b0e0aae408db85a220a2510 100644 (file)
--- a/src/modules/m_randquote.cpp
+++ b/src/modules/m_randquote.cpp
@@ -31,6 +31,8 @@ std::string suffix = "";
 
 /* $ModDesc: Provides random Quotes on Connect. */
 
+/** Handle /RANDQUOTE
+ */
 class cmd_randquote : public command_t
 {
  public:

diff --git a/src/modules/m_safelist.cpp b/src/modules/m_safelist.cpp
index 9008e485a1e4f947abc44279b1493257dcee7eae..32e68ff10590fe18fc44d0ae43d3888b41ab22ad 100644 (file)
--- a/src/modules/m_safelist.cpp
+++ b/src/modules/m_safelist.cpp
@@ -42,8 +42,7 @@ class ListData : public classbase
 typedef std::vector<userrec *> UserList;
 UserList listusers;    /* vector of people doing a /list */
 
-/*
- * To create a timer which recurs every second, we inherit from InspTimer.
+/** To create a timer which recurs every second, we inherit from InspTimer.
  * InspTimer is only one-shot however, so at the end of each Tick() we simply
  * insert another of ourselves into the pending queue :)
  */

diff --git a/src/modules/m_sajoin.cpp b/src/modules/m_sajoin.cpp
index e025b5e3eb09a893daa8973417f0a781a4f6e982..2baecfc2265157d7bed672cf6c13a34bf1fff80c 100644 (file)
--- a/src/modules/m_sajoin.cpp
+++ b/src/modules/m_sajoin.cpp
@@ -26,9 +26,8 @@ using namespace std;
 
 /* $ModDesc: Provides support for unreal-style SAJOIN command */
 
-
-
-
+/** Handle /SAJOIN
+ */
 class cmd_sajoin : public command_t
 {
  public:

diff --git a/src/modules/m_samode.cpp b/src/modules/m_samode.cpp
index 6491c9a3a59e36a150576017ee0e2fa84debedf7..51a862701839e32231f485b28e6c4e30f38a9cad 100644 (file)
--- a/src/modules/m_samode.cpp
+++ b/src/modules/m_samode.cpp
@@ -24,7 +24,7 @@ using namespace std;
  * 
  */
 
-/* $ModDesc: Povides more advanced UnrealIRCd SAMODE command */
+/* $ModDesc: Provides more advanced UnrealIRCd SAMODE command */
 
 /*
  * ToDo:
@@ -37,9 +37,8 @@ using namespace std;
 #include "modules.h"
 #include "inspircd.h"
 
-
-
-        
+/** Handle /SAMODE
+ */
 class cmd_samode : public command_t
 {
  public:

diff --git a/src/modules/m_sanick.cpp b/src/modules/m_sanick.cpp
index e974e3eb57920e42effee10d81704788eec6d357..3892efb36591fd8ea1189024d83c6cc37e0cc710 100644 (file)
--- a/src/modules/m_sanick.cpp
+++ b/src/modules/m_sanick.cpp
@@ -25,9 +25,8 @@ using namespace std;
 
 /* $ModDesc: Provides support for SANICK command */
 
-
-
-
+/** Handle /SANICK
+ */
 class cmd_sanick : public command_t
 {
  public:

diff --git a/src/modules/m_sapart.cpp b/src/modules/m_sapart.cpp
index 20201790b2545af08fcda8e89dd7e3df3fafc12e..6db3661b519a6eef03b3e4538442a1cd8ca34600 100644 (file)
--- a/src/modules/m_sapart.cpp
+++ b/src/modules/m_sapart.cpp
@@ -21,14 +21,12 @@ using namespace std;
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "inspircd.h"
 
 /* $ModDesc: Provides support for unreal-style SAPART command */
 
-
-
-
+/** Handle /SAPART
+ */
 class cmd_sapart : public command_t
 {
  public:

diff --git a/src/modules/m_saquit.cpp b/src/modules/m_saquit.cpp
index 20ffdd99eb0b5f8d7d738f7fa85e69a725b4e0b1..09cc45d4509d396f045e305cd608726aea7ae108 100644 (file)
--- a/src/modules/m_saquit.cpp
+++ b/src/modules/m_saquit.cpp
@@ -35,9 +35,8 @@ using namespace std;
 
 /* $ModDesc: Provides support for an SAQUIT command, exits user with a reason */
 
-
-
-
+/** Handle /SAQUIT
+ */
 class cmd_saquit : public command_t
 {
  public:

diff --git a/src/modules/m_sethost.cpp b/src/modules/m_sethost.cpp
index 6787867577d38ba997053e7d0f4d53bce81b480c..441d2f3965e35499df3783ab2b27d3a1fa2817dc 100644 (file)
--- a/src/modules/m_sethost.cpp
+++ b/src/modules/m_sethost.cpp
@@ -26,9 +26,8 @@ using namespace std;
 
 /* $ModDesc: Provides support for the SETHOST command */
 
-
-
-
+/** Handle /SETHOST
+ */
 class cmd_sethost : public command_t
 {
  public:

diff --git a/src/modules/m_setident.cpp b/src/modules/m_setident.cpp
index d1f67bb1400a07bc088c8395cbb1d620e363d55b..065c1d96dd65daca51ab82c56b14301cd12e8a52 100644 (file)
--- a/src/modules/m_setident.cpp
+++ b/src/modules/m_setident.cpp
@@ -4,6 +4,8 @@
 
 /* $ModDesc: Provides support for the SETIDENT command */
 
+/** Handle /SETIDENT
+ */
 class cmd_setident : public command_t
 {
  public:

diff --git a/src/modules/m_setidle.cpp b/src/modules/m_setidle.cpp
index 6b875431180924d94e1a266a361112b26364471a..b24ca96eed447a1e6005b085030a2bd74ce942e0 100644 (file)
--- a/src/modules/m_setidle.cpp
+++ b/src/modules/m_setidle.cpp
@@ -25,6 +25,8 @@ using namespace std;
 
 /* $ModDesc: Allows opers to set their idle time */
 
+/** Handle /SETIDLE
+ */
 class cmd_setidle : public command_t
 {
  public:

diff --git a/src/modules/m_spanningtree.cpp b/src/modules/m_spanningtree.cpp
index 07e2c897703da8f1af27f40b620269819e08f438..c02c31ac44585a6b42955f4486a0e68d9fe16f75 100644 (file)
--- a/src/modules/m_spanningtree.cpp
+++ b/src/modules/m_spanningtree.cpp
@@ -583,6 +583,8 @@ bool IsServer(std::string ServerName)
 }
 
 
+/** Handle /RCONNECT
+ */
 class cmd_rconnect : public command_t
 {
        Module* Creator;

diff --git a/src/modules/m_spy.cpp b/src/modules/m_spy.cpp
index 86e7128d65792f7cd0190161af2ee932903fe845..fe85ef5b2fa558b1673c3ddb1344e1a66324db61 100644 (file)
--- a/src/modules/m_spy.cpp
+++ b/src/modules/m_spy.cpp
@@ -75,7 +75,8 @@ void spy_userlist(userrec *user, chanrec *c)
 
 }
 
-
+/** Handle /SPYLIST
+ */
 class cmd_spylist : public command_t
 {
   public:
@@ -102,6 +103,8 @@ class cmd_spylist : public command_t
        }
 };
 
+/** Handle /SPYNAMES
+ */
 class cmd_spynames : public command_t
 {
   public:

diff --git a/src/modules/m_swhois.cpp b/src/modules/m_swhois.cpp
index 3b28716ff6b597a4825633b76076d20ba83627de..49984db140ebb66393621041f11026728bee8252 100644 (file)
--- a/src/modules/m_swhois.cpp
+++ b/src/modules/m_swhois.cpp
@@ -17,13 +17,12 @@
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "inspircd.h"
 
 /* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
 
-
-
+/** Handle /SWHOIS
+ */
 class cmd_swhois : public command_t
 {
        

diff --git a/src/modules/m_testcommand.cpp b/src/modules/m_testcommand.cpp
index 4f5d3a2440ccf1e839ac7a547897367207c22b36..5816b20a07f697d6a126b536946d38481f5ca997 100644 (file)
--- a/src/modules/m_testcommand.cpp
+++ b/src/modules/m_testcommand.cpp
@@ -20,14 +20,13 @@ using namespace std;
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "dns.h"
 #include "inspircd.h"
 
 /* $ModDesc: Povides a proof-of-concept test /WOOT command */
 
-
-
+/** A test resolver class for IPV6
+ */
 class MyV6Resolver : public Resolver
 {
        bool fw;
@@ -48,8 +47,8 @@ class MyV6Resolver : public Resolver
        }
 };
 
-
-        
+/** Handle /WOOT
+ */
 class cmd_woot : public command_t
 {
  public:

diff --git a/src/modules/m_timedbans.cpp b/src/modules/m_timedbans.cpp
index 4c58306f53bf8295d93dc287a0fb2ae5e00a7247..6bd6a39fd62d9311f23111893a631aa24764227b 100644 (file)
--- a/src/modules/m_timedbans.cpp
+++ b/src/modules/m_timedbans.cpp
@@ -23,14 +23,13 @@ using namespace std;
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "hashcomp.h"
 #include "configreader.h"
 #include "inspircd.h"
 
 
-
-
+/** Holds a timed ban
+ */
 class TimedBan : public classbase
 {
  public:
@@ -42,6 +41,8 @@ class TimedBan : public classbase
 typedef std::vector<TimedBan> timedbans;
 timedbans TimedBanList;
 
+/** Handle /TBAN
+ */
 class cmd_tban : public command_t
 {
  public:

diff --git a/src/modules/m_tline.cpp b/src/modules/m_tline.cpp
index 2635d2b1251ad281c35298bf109be400555f7903..0208222a4041deccdaa91aa4d9e5dce8fbac1c09 100644 (file)
--- a/src/modules/m_tline.cpp
+++ b/src/modules/m_tline.cpp
@@ -20,16 +20,14 @@ using namespace std;
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "wildcard.h"
 #include "inspircd.h"
 #include "dns.h"
 
 /* $ModDesc: Provides /tline command used to test who a mask matches */
 
-
-
-        
+/** Handle /TLINE
+ */ 
 class cmd_tline : public command_t
 {
  public:

diff --git a/src/modules/m_uninvite.cpp b/src/modules/m_uninvite.cpp
index 792429ce0569069007db4103c9b59579f737ea75..0d77ee7cdf5682fb1128ff57fb0d052ba34ac74f 100644 (file)
--- a/src/modules/m_uninvite.cpp
+++ b/src/modules/m_uninvite.cpp
@@ -22,13 +22,11 @@ using namespace std;
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "configreader.h"
 #include "inspircd.h"
 
-
-
-        
+/** Handle /UNINVITE
+ */     
 class cmd_uninvite : public command_t
 {
  public:

diff --git a/src/modules/m_userip.cpp b/src/modules/m_userip.cpp
index 6f7a50453c3714471cfc49c1f892b2f3f3ee483a..c7efaf090638dcc6375cd6ac0730737a30a5d877 100644 (file)
--- a/src/modules/m_userip.cpp
+++ b/src/modules/m_userip.cpp
@@ -21,14 +21,12 @@ using namespace std;
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "inspircd.h"
 
 /* $ModDesc: Provides support for USERIP command */
 
-
-
-
+/** Handle /USERIP
+ */
 class cmd_userip : public command_t
 {
  public:

diff --git a/src/modules/m_vhost.cpp b/src/modules/m_vhost.cpp
index 09a0455640a2d441ba083c70580f7c983bbb5ed5..233def0b6de359cacd298a6df9eebee0c946e1cb 100644 (file)
--- a/src/modules/m_vhost.cpp
+++ b/src/modules/m_vhost.cpp
@@ -24,13 +24,14 @@ using namespace std;
 
 /* $ModDesc: Provides masking of user hostnames via traditional /VHOST command */
 
-static ConfigReader *Conf;
-
+static ConfigReader* Conf;
 
+/** Handle /VHOST
+ */
 class cmd_vhost : public command_t
 {
  public:
- cmd_vhost (InspIRCd* Instance) : command_t(Instance,"VHOST", 0, 2)
+       cmd_vhost (InspIRCd* Instance) : command_t(Instance,"VHOST", 0, 2)
        {
                this->source = "m_vhost.so";
                syntax = "<username> <password>";