]> git.netwichtig.de Git - user/henk/code/inspircd.git/commitdiff
Annotations
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>
Fri, 15 Sep 2006 10:59:36 +0000 (10:59 +0000)
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>
Fri, 15 Sep 2006 10:59:36 +0000 (10:59 +0000)
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@5254 e03df62e-2008-0410-955e-edbf42e46eb7

22 files changed:
include/configreader.h
src/modules/extra/m_filter_pcre.cpp
src/modules/extra/m_ssl_gnutls.cpp
src/modules/extra/m_ssl_openssl.cpp
src/modules/m_botmode.cpp
src/modules/m_cban.cpp
src/modules/m_censor.cpp
src/modules/m_cgiirc.cpp
src/modules/m_chanfilter.cpp
src/modules/m_chanprotect.cpp
src/modules/m_cloaking.cpp
src/modules/m_filter.cpp
src/modules/m_helpop.cpp
src/modules/m_hostchange.cpp
src/modules/m_httpd.cpp
src/modules/m_inviteexception.cpp
src/modules/m_joinflood.cpp
src/modules/m_kicknorejoin.cpp
src/modules/m_knock.cpp
src/modules/m_messageflood.cpp
src/modules/m_safelist.cpp
src/modules/m_stripcolor.cpp

index 5c8a663070887c1ac3f0b204880d2e15fb625a14..44551b1329cbace399038e42a86e6fc3d64d92c9 100644 (file)
@@ -37,6 +37,8 @@ typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
 
 enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
 
+/** Holds a core configuration item and its callbacks
+ */
 struct InitialConfig
 {
        char* tag;
@@ -46,6 +48,9 @@ struct InitialConfig
        Validator validation_function;
 };
 
+/** Holds a core configuration item and its callbacks
+ * where there may be more than one item
+ */
 struct MultiConfig
 {
        const char* tag;
index d435600b4d4edb9e4127bd87908f76cf4bd28034..faf1718e458421c96ee0be68d92e2026b4e1b6e7 100644 (file)
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "inspircd.h"
 
+/** Thrown by m_filter_pcre
+ */
 class FilterPCREException : public ModuleException
 {
  public:
index fc8429ee216a4935a0c1de29a1944b8edbfe96c2..53aad23791fa9b7b7eb4e59e58f92b6ecb04b894 100644 (file)
@@ -33,6 +33,8 @@ bool isin(int port, const std::vector<int> &portlist)
        return false;
 }
 
+/** Represents an SSL user's extra data
+ */
 class issl_session : public classbase
 {
 public:
index 1f5023b75c455922bd9f3a8f66e5f1758c0569a1..bb57a84673c5e7fad10473dca074e13d38584bfd 100644 (file)
@@ -41,6 +41,8 @@ char* get_error()
        return ERR_error_string(ERR_get_error(), NULL);
 }
 
+/** Represents an SSL user's extra data
+ */
 class issl_session : public classbase
 {
 public:
index 2aa5047bf63ab7ba47b63aaaa7e054c6848450a1..8d67c4a14bac3391e5944796fcd75b14d5856ad7 100644 (file)
@@ -21,14 +21,13 @@ using namespace std;
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "configreader.h"
 #include "inspircd.h"
 
 /* $ModDesc: Provides support for unreal-style umode +B */
 
-
-
+/** Handles user mode +B
+ */
 class BotMode : public ModeHandler
 {
  public:
index ff8e3af543ad4b50702d2f271d988bf2c46dd99d..a7af325b9c6c16f4e93d8ad3892932a304c3a0d6 100644 (file)
@@ -24,6 +24,8 @@
 
 /* $ModDesc: Gives /cban, aka C:lines. Think Q:lines, for channels. */
 
+/** Holds a CBAN item
+ */
 class CBan : public classbase
 {
 public:
index 50315997f629eb66de9c3cea7ecc7888adf3219e..e81ee17a49f21363ab9e71252b9ddba2f39d10e8 100644 (file)
@@ -27,8 +27,8 @@ typedef std::map<irc::string,irc::string> censor_t;
 
 /* $ModDesc: Provides user and channel +G mode */
 
-
-
+/** Thrown by m_censor
+ */
 class CensorException : public ModuleException
 {
  public:
@@ -38,6 +38,8 @@ class CensorException : public ModuleException
        }
 };
 
+/** Handles usermode +G
+ */
 class CensorUser : public ModeHandler
 {
  public:
@@ -70,6 +72,8 @@ class CensorUser : public ModeHandler
        }
 };
 
+/** Handles channel mode +G
+ */
 class CensorChannel : public ModeHandler
 {
  public:
index d70bd9561b3165b13fc95e9819caa083ad84a18f..9d4344629cc9653af567b9248440a360487af9b9 100644 (file)
 #include <arpa/inet.h>
 #include "users.h"
 #include "modules.h"
-
 #include "dns.h"
 #include "inspircd.h"
 
 /* $ModDesc: Change user's hosts connecting from known CGI:IRC hosts */
 
-
-
 enum CGItype { PASS, IDENT, PASSFIRST, IDENTFIRST };
 
+/** Holds a CGI site's details
+ */
 class CGIhost : public classbase
 {
 public:
@@ -47,6 +46,8 @@ public:
 
 typedef std::vector<CGIhost> CGIHostlist;
 
+/** Resolver for CGI:IRC hostnames encoded in ident/GECOS
+ */
 class CGIResolver : public Resolver
 {
        std::string typ;
index 458d1a29d42abf6214beb6bdaf48d5db749da6d8..f1ae55df8ed9124f4ec6b4ed2adbd5e4364029fa 100644 (file)
@@ -28,8 +28,8 @@ using namespace std;
 
 /* $ModDesc: Provides channel-specific censor lists (like mode +G but varies from channel to channel) */
 
-
-
+/** Handles channel mode +g
+ */
 class ChanFilter : public ListModeBase
 {
  public:
index e2b121965af80e59d10aaddf0874d839e4e21399..2f384f0012d8115ec92f228d66bd24b5b7d2c758 100644 (file)
@@ -32,6 +32,8 @@ const char* fakevalue = "on";
  */
 bool unload_kludge = false;
 
+/** Handles basic operation of +qa channel modes
+ */
 class FounderProtectBase
 {
  private:
@@ -143,6 +145,8 @@ class FounderProtectBase
        }
 };
 
+/** Abstraction of FounderProtectBase for channel mode +q
+ */
 class ChanFounder : public ModeHandler, public FounderProtectBase
 {
        char* dummyptr;
@@ -199,6 +203,8 @@ class ChanFounder : public ModeHandler, public FounderProtectBase
        }
 };
 
+/** Abstraction of FounderProtectBase for channel mode +a
+ */
 class ChanProtect : public ModeHandler, public FounderProtectBase
 {
        char* dummyptr;
index 60f62b0996f0371c3187c204f616c9f7e2bb8f53..29d26a9ec7ab297f90af2e54d0f4ae226d95d9bf 100644 (file)
@@ -60,6 +60,8 @@ typedef unsigned int uint32_t;
 typedef uint32_t word32; /* NOT unsigned long. We don't support 16 bit platforms, anyway. */
 typedef unsigned char byte;
 
+/** An MD5 context, used by m_cloaking
+ */
 class xMD5Context : public classbase
 {
  public:
@@ -68,6 +70,8 @@ class xMD5Context : public classbase
        word32 in[16];
 };
 
+/** Handles user mode +x
+ */
 class CloakUser : public ModeHandler
 {
        
index 775130f356e32eb4ea819ebe8e44ff1cece844de..46f5922f017cd1250cdfa96eb20c11f3ab2a9074 100644 (file)
@@ -25,13 +25,14 @@ using namespace std;
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "inspircd.h"
 
 /* $ModDesc: An enhanced version of the unreal m_filter.so used by chatspike.net */
 
 
 
+/** Holds a filter pattern and reason
+ */
 class Filter : public classbase
 {
  public:
@@ -41,6 +42,8 @@ class Filter : public classbase
 
 typedef std::map<std::string,Filter*> filter_t;
 
+/** Thrown by m_filter
+ */
 class FilterException : public ModuleException
 {
  public:
index dc124cd46dc6b22546af31051fc4d81871e33955..330a5d60ed55d566ab3f92e1c8914a0fbc2d4e3c 100644 (file)
@@ -19,19 +19,18 @@ using namespace std;
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
 #include "inspircd.h"
 
 // Global Vars
 static ConfigReader *helpop;
 
-
-
 bool do_helpop(const char**, int, userrec*);
 void sendtohelpop(userrec*, int, const char**);
 
 /* $ModDesc: /helpop Command, Works like Unreal helpop */
 
+/** Handles user mode +h
+ */
 class Helpop : public ModeHandler
 {
  public:
@@ -60,6 +59,8 @@ class Helpop : public ModeHandler
        }
 };
 
+/** Handles /HELPOP
+ */
 class cmd_helpop : public command_t
 {
  public:
@@ -182,6 +183,8 @@ class cmd_helpop : public command_t
        }
 };
 
+/** Thrown by m_helpop
+ */
 class HelpopException : public ModuleException
 {
  private:
index d270c74d456d021aa9c25f0207a3f08144c3d940..4de6a82029138b8c99b34b7cb9f8aeacca703238 100644 (file)
@@ -24,8 +24,8 @@ using namespace std;
 
 /* $ModDesc: Provides masking of user hostnames in a different way to m_cloaking */
 
-
-
+/** Holds information on a host set by m_hostchange
+ */
 class Host : public classbase
 {
  public:
index 9317f1992c6474a212e49dc6d63819edbf975707..96fdfc8f25e6a94975d83dfae280c806980f20f0 100644 (file)
@@ -1,4 +1,4 @@
-/*       +------------------------------------+
+/*       +------------------------------------+       
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
@@ -31,6 +31,8 @@ class ModuleHttp;
 static ModuleHttp* HttpModule;
 static bool claimed;
 
+/** HTTP socket states
+ */
 enum HttpState
 {
        HTTP_LISTEN = 0,
@@ -39,6 +41,8 @@ enum HttpState
        HTTP_SERVE_SEND_DATA = 3
 };
 
+/** A socket used for HTTP transport
+ */
 class HttpSocket : public InspSocket
 {
        FileReader* index;
index c7cfa739e74839d0bbd72f0b9f3755b7275983f4..bcb2d7d6d03e01d0c6b2f8055d2334c014b74925 100644 (file)
@@ -21,6 +21,8 @@
 
 class InspIRCd* ServerInstance;
 
+/** Handles channel mode +I
+ */
 class InviteException : public ListModeBase
 {
  public:
@@ -30,8 +32,6 @@ class InviteException : public ListModeBase
 class ModuleInviteException : public Module
 {
        InviteException* ie;
-       
-
 public:
        ModuleInviteException(InspIRCd* Me) : Module(Me)
        {
index 99a872457191d29ebebb8a8f26c8c137b0bd9026..8557ad11f808b016716e85c50c625fbef68b5103 100644 (file)
@@ -26,8 +26,8 @@ using namespace std;
 
 /* $ModDesc: Provides channel mode +j (join flood protection) */
 
-
-
+/** Holds settings and state associated with channel mode +j
+ */
 class joinfloodsettings : public classbase
 {
  public:
@@ -40,6 +40,7 @@ class joinfloodsettings : public classbase
        bool locked;
 
        joinfloodsettings() : secs(0), joins(0) {};
+
        joinfloodsettings(int b, int c) : secs(b), joins(c)
        {
                reset = time(NULL) + secs;
@@ -92,6 +93,8 @@ class joinfloodsettings : public classbase
 
 };
 
+/** Handles channel mode +j
+ */
 class JoinFlood : public ModeHandler
 {
  public:
index 4845e633e8a7ba0bc3567e1724cbc93d68941707..f0244388e95fa55563d1a56bba6a3fcfd4f993b0 100644 (file)
@@ -21,6 +21,8 @@ inline int strtoint(const std::string &str)
 
 typedef std::map<userrec*, time_t> delaylist;
 
+/** Handles channel mode +J
+ */
 class KickRejoin : public ModeHandler
 {
  public:
index 3a104bb67b7002e9380bee5d04ea64ca9079857d..1e490ad12a9bdedafd5390c6c689ab3630622674 100644 (file)
@@ -26,8 +26,8 @@ using namespace std;
 
 /* $ModDesc: Provides support for /KNOCK and mode +K */
 
-
-
+/** Handles the /KNOCK command
+ */
 class cmd_knock : public command_t
 {
  public:
@@ -77,6 +77,8 @@ class cmd_knock : public command_t
        }
 };
 
+/** Handles channel mode +K
+ */
 class Knock : public ModeHandler
 {
  public:
index fc19217e5d34d72887669d7b92d751feae8d5caa..52174792f53f45cc0ffb29e7f0e2a7c4a55780ee 100644 (file)
@@ -25,8 +25,8 @@ using namespace std;
 
 /* $ModDesc: Provides channel mode +f (message flood protection) */
 
-
-
+/** Holds flood settings and state for mode +f
+ */
 class floodsettings : public classbase
 {
  public:
@@ -80,6 +80,8 @@ class floodsettings : public classbase
        }
 };
 
+/** Handles channel mode +f
+ */
 class MsgFlood : public ModeHandler
 {
  public:
index 77cc0715bf55f0db667683572653efa181d03cf8..ac7225b5eba3f9fdea68cbc3ce26d6303eeaff51 100644 (file)
@@ -23,6 +23,8 @@ using namespace std;
 #include "inspircd.h"
 #include "wildcard.h"
 
+/** Holds a users m_safelist state
+ */
 class ListData : public classbase
 {
  public:
index 73abba72ce5089d0d11d0b8fc3c6521e82dc15e2..fd149e5f2a30eae8886678a354ff435185cd53c9 100644 (file)
@@ -23,6 +23,8 @@ using namespace std;
 
 /* $ModDesc: Provides channel +S mode (strip ansi colour) */
 
+/** Handles channel mode +S
+ */
 class ChannelStripColor : public ModeHandler
 {
  public: