Match on nick change option for RLine, document m_rline & this option.

[user/henk/code/inspircd.git] / src / modules / extra / m_sqlutils.h

diff --git a/src/modules/extra/m_sqlutils.h b/src/modules/extra/m_sqlutils.h
index 23cb41a1e3a7b1156a65689a441cbbb04fc3556d..485f0915847e4e0fc78629c729707610b1b71d37 100644 (file)
--- a/src/modules/extra/m_sqlutils.h
+++ b/src/modules/extra/m_sqlutils.h
@@ -1,3 +1,16 @@
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
+ * This program is free but copyrighted software; see
+ *            the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
 #ifndef INSPIRCD_SQLUTILS
 #define INSPIRCD_SQLUTILS
 
@@ -10,13 +23,19 @@
 #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;
-       userrec* user;
+       /** User
+        */
+       User* user;
        
-       AssociateUser(Module* s, Module* d, unsigned long i, userrec* u)
+       AssociateUser(Module* s, Module* d, unsigned long i, User* u)
        : Request(s, d, SQLUTILAU), id(i), user(u)
        {
        }
@@ -28,13 +47,19 @@ public:
        }
 };
 
+/** Used to associate an SQL query with a channel
+ */
 class AssociateChan : public Request
 {
 public:
+       /** Query ID
+        */
        unsigned long id;
-       chanrec* chan;
+       /** Channel
+        */
+       Channel* chan;
        
-       AssociateChan(Module* s, Module* d, unsigned long i, chanrec* u)
+       AssociateChan(Module* s, Module* d, unsigned long i, Channel* u)
        : Request(s, d, SQLUTILAC), id(i), chan(u)
        {
        }
@@ -46,9 +71,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,11 +92,17 @@ public:
        }
 };
 
+/** Get the user associated with an SQL query ID
+ */
 class GetAssocUser : public Request
 {
 public:
+       /** The query id
+        */
        unsigned long id;
-       userrec* user;
+       /** The user
+        */
+       User* user;
 
        GetAssocUser(Module* s, Module* d, unsigned long i)
        : Request(s, d, SQLUTILGU), id(i), user(NULL)
@@ -81,11 +116,17 @@ public:
        }
 };
 
+/** Get the channel associated with an SQL query ID
+ */
 class GetAssocChan : public Request
 {
 public:
+       /** The query id
+        */
        unsigned long id;
-       chanrec* chan;
+       /** The channel
+        */
+       Channel* chan;
 
        GetAssocChan(Module* s, Module* d, unsigned long i)
        : Request(s, d, SQLUTILGC), id(i), chan(NULL)