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

1 files changed, 28 insertions, 0 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)