Comments describing classes, for the url http://svn.inspircd.org/docs/annotated.html

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

8 files changed, 60 insertions, 4 deletions

diff --git a/src/modules/extra/m_sqlutils.h b/src/modules/extra/m_sqlutils.h
index 23cb41a1e..255e92122 100644
--- a/src/modules/extra/m_sqlutils.h
+++ b/src/modules/extra/m_sqlutils.h
@@ -10,10 +10,16 @@
 #define SQLUTILGC "SQLutil GetAssocChan"
 #define SQLUTILSUCCESS "You shouldn't be reading this (success)"
 
+/** Used to associate an SQL query with a user
+ */
 class AssociateUser : public Request
 {
 public:
+	/** Query ID
+	 */
 	unsigned long id;
+	/** User
+	 */
 	userrec* user;
 	
 	AssociateUser(Module* s, Module* d, unsigned long i, userrec* u)
@@ -28,10 +34,16 @@ public:
 	}
 };
 
+/** Used to associate an SQL query with a channel
+ */
 class AssociateChan : public Request
 {
 public:
+	/** Query ID
+	 */
 	unsigned long id;
+	/** Channel
+	 */
 	chanrec* chan;
 	
 	AssociateChan(Module* s, Module* d, unsigned long i, chanrec* u)
@@ -46,9 +58,13 @@ public:
 	}
 };
 
+/** Unassociate a user or  class from an SQL query
+ */
 class UnAssociate : public Request
 {
 public:
+	/** The query ID
+	 */
 	unsigned long id;
 
 	UnAssociate(Module* s, Module* d, unsigned long i)
@@ -63,10 +79,16 @@ public:
 	}
 };
 
+/** Get the user associated with an SQL query ID
+ */
 class GetAssocUser : public Request
 {
 public:
+	/** The query id
+	 */
 	unsigned long id;
+	/** The user
+	 */
 	userrec* user;
 
 	GetAssocUser(Module* s, Module* d, unsigned long i)
@@ -81,10 +103,16 @@ public:
 	}
 };
 
+/** Get the channel associated with an SQL query ID
+ */
 class GetAssocChan : public Request
 {
 public:
+	/** The query id
+	 */
 	unsigned long id;
+	/** The channel
+	 */
 	chanrec* chan;
 
 	GetAssocChan(Module* s, Module* d, unsigned long i)
diff --git a/src/modules/m_alias.cpp b/src/modules/m_alias.cpp
index d7ac3d04a..fd3dedff2 100644
--- a/src/modules/m_alias.cpp
+++ b/src/modules/m_alias.cpp
@@ -24,12 +24,18 @@ using namespace std;
 
 /* $ModDesc: Provides aliases of commands. */
 
+/** An alias definition
+ */
 class Alias : public classbase
 {
  public:
+	/** The text of the alias command */
 	irc::string text;
+	/** Text to replace with */
 	std::string replace_with;
+	/** Nickname required to perform alias */
 	std::string requires;
+	/** Alias requires ulined server */
 	bool uline;
 };
 
diff --git a/src/modules/m_banexception.cpp b/src/modules/m_banexception.cpp
index 9ac3d0dc7..e704b0223 100644
--- a/src/modules/m_banexception.cpp
+++ b/src/modules/m_banexception.cpp
@@ -19,7 +19,8 @@
 // and if a user matches an entry on the +e list then they can join the channel, overriding any (+b) bans set on them
 
 
-
+/** Handles +e channel mode
+ */
 class BanException : public ListModeBase
 {
  public:
diff --git a/src/modules/m_blockamsg.cpp b/src/modules/m_blockamsg.cpp
index 7dc2f2f2f..c0fb7651e 100644
--- a/src/modules/m_blockamsg.cpp
+++ b/src/modules/m_blockamsg.cpp
@@ -31,6 +31,8 @@
 
 enum BlockAction { IBLOCK_KILL, IBLOCK_KILLOPERS, IBLOCK_NOTICE, IBLOCK_NOTICEOPERS, IBLOCK_SILENT };
 
+/** Holds a blocked message's details
+ */
 class BlockedMessage : public classbase
 {
 public:
diff --git a/src/modules/m_blockcaps.cpp b/src/modules/m_blockcaps.cpp
index 1d67522b9..7c98fc771 100644
--- a/src/modules/m_blockcaps.cpp
+++ b/src/modules/m_blockcaps.cpp
@@ -24,7 +24,8 @@
 /* $ModDesc: Provides support for channel mode +P to block all-CAPS channel messages and notices */
 
 
-
+/** Handles the +P channel mode
+ */
 class BlockCaps : public ModeHandler
 {
  public:
diff --git a/src/modules/m_blockcolor.cpp b/src/modules/m_blockcolor.cpp
index 9ce42816c..e8a05bed3 100644
--- a/src/modules/m_blockcolor.cpp
+++ b/src/modules/m_blockcolor.cpp
@@ -25,8 +25,8 @@ using namespace std;
 
 /* $ModDesc: Provides support for unreal-style channel mode +c */
 
-
-
+/** Handles the +c channel mode
+ */
 class BlockColor : public ModeHandler
 {
  public:
diff --git a/src/modules/m_services.cpp b/src/modules/m_services.cpp
index 63f04287a..7e3a8d89b 100644
--- a/src/modules/m_services.cpp
+++ b/src/modules/m_services.cpp
@@ -25,6 +25,8 @@ static bool kludgeme = false;
 
 /* $ModDesc: Povides support for services +r user/chan modes and more */
 
+/** Channel mode +r - mark a channel as identified
+ */
 class Channel_r : public ModeHandler
 {
 	
@@ -49,6 +51,8 @@ class Channel_r : public ModeHandler
 	}
 };
 
+/** User mode +r - mark a user as identified
+ */
 class User_r : public ModeHandler
 {
 	
@@ -72,6 +76,8 @@ class User_r : public ModeHandler
 	}
 };
 
+/** Channel mode +R - registered users only
+ */
 class Channel_R : public ModeHandler
 {
  public:
@@ -100,6 +106,8 @@ class Channel_R : public ModeHandler
 	}
 };
 
+/** User mode +R - only allow PRIVMSG and NOTICE from registered users
+ */
 class User_R : public ModeHandler
 {
  public:
@@ -128,6 +136,8 @@ class User_R : public ModeHandler
 	}
 };
 
+/** Channel mode +M - only allow privmsg and notice to channel from registered users
+ */
 class Channel_M : public ModeHandler
 {
  public:
@@ -156,6 +166,8 @@ class Channel_M : public ModeHandler
 	}
 };
 
+/** Dreamnforge-like services support
+ */
 class ModuleServices : public Module
 {
 	
diff --git a/src/modules/m_services_account.cpp b/src/modules/m_services_account.cpp
index 4b5ec5c86..739ad6119 100644
--- a/src/modules/m_services_account.cpp
+++ b/src/modules/m_services_account.cpp
@@ -24,6 +24,8 @@ using namespace std;
 
 /* $ModDesc: Povides support for ircu-style services accounts, including chmode +R, etc. */
 
+/** Channel mode +R - unidentified users cannot join
+ */
 class AChannel_R : public ModeHandler
 {
  public:
@@ -52,6 +54,8 @@ class AChannel_R : public ModeHandler
 	}
 };
 
+/** User mode +R - unidentified users cannot message
+ */
 class AUser_R : public ModeHandler
 {
  public:
@@ -80,6 +84,8 @@ class AUser_R : public ModeHandler
 	}
 };
 
+/** Channel mode +M - unidentified users cannot message channel
+ */
 class AChannel_M : public ModeHandler
 {
  public: