From 3741ee3cd2b940132c011ba37897b6fe516f7931 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 8 Apr 2004 18:14:00 +0000 Subject: New documentation for new ConfigReader methods git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@457 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classuserrec.html | 141 ++++++++++++++++++++++---------------- 1 file changed, 83 insertions(+), 58 deletions(-) (limited to 'docs/module-doc/classuserrec.html') diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 3d42a4d77..5270e6a4e 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -18,8 +18,8 @@ Inheritance diagram for userrec:

[legend]
Collaboration diagram for userrec:

Collaboration graph
- - + +
[legend]
List of all members. @@ -54,7 +54,8 @@ Inheritance diagram for userrec:



- + + @@ -96,13 +97,13 @@ Definition at line 66 of fi

Definition at line 11 of file users.cpp.

-References connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, connection::fd, connection::haspassed, connection::idle_lastmsg, invites, connection::ip, connection::lastping, connection::nping, connection::port, connection::registered, connection::signon, and timeout. +References connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, connection::fd, connection::haspassed, connection::idle_lastmsg, invites, connection::ip, connection::lastping, connection::nping, connection::port, connection::registered, connection::signon, and timeout. 

00012 {
 00013         // the PROPER way to do it, AVOID bzero at *ALL* costs
 00014         strcpy(nick,"");
 00015         ip = 0;
-00016         timeout = 0;
+00016         timeout = 0;
 00017         strcpy(ident,"");
 00018         strcpy(host,"");
 00019         strcpy(dhost,"");
@@ -151,9 +152,9 @@ References connection::byt
 

 
 

-Definition at line 120 of file users.h.
+Definition at line 122 of file users.h.
 

-
00120 {  }
+
00122 {  }
char result [256]
 Stores the result of the last GetFullHost or GetRealHost call.

unsigned long timeout
char carryover [MAXBUF]
unsigned long timeout

Private Attributes

InvitedList invites
 A list of channels the user has a pending invite to.

@@ -187,14 +188,14 @@ Returns the full displayed host of the user This member function returns the hos

-Definition at line 37 of file users.cpp. +Definition at line 38 of file users.cpp.

References result.

-

00038 {
-00039         sprintf(result,"%s!%s@%s",nick,ident,dhost);
-00040         return result;
-00041 }
+
00039 {
+00040         sprintf(result,"%s!%s@%s",nick,ident,dhost);
+00041         return result;
+00042 }
 
    
   
 
@@ -227,14 +228,14 @@ Returns the full real host of the user This member function returns the hostname
 

 If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.
 

-Definition at line 44 of file users.cpp.
+Definition at line 45 of file users.cpp.
 

 References result.
 

-
00045 {
-00046         sprintf(result,"%s!%s@%s",nick,ident,host);
-00047         return result;
-00048 }
+
00046 {
+00047         sprintf(result,"%s!%s@%s",nick,ident,host);
+00048         return result;
+00049 }
 
    
   
 
@@ -268,15 +269,15 @@ Adds a channel to a users invite list (invites them to a channel).
 

 
 

-Definition at line 64 of file users.cpp.
+Definition at line 65 of file users.cpp.
 

 References Invited::channel, and invites.
 

-
00065 {
-00066         Invited i;
-00067         strcpy(i.channel,channel);
-00068         invites.push_back(i);
-00069 }
+
00066 {
+00067         Invited i;
+00068         strcpy(i.channel,channel);
+00069         invites.push_back(i);
+00070 }
 
    
   
 
@@ -310,22 +311,22 @@ Returns true if a user is invited to a channel.
 

 
 

-Definition at line 50 of file users.cpp.
+Definition at line 51 of file users.cpp.
 

 References invites.
 

-
00051 {
-00052         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00053         {
-00054                 if (i->channel) {
-00055                         if (!strcasecmp(i->channel,channel))
-00056                         {
-00057                                 return true;
-00058                         }
-00059                 }
-00060         }
-00061         return false;
-00062 }
+
00052 {
+00053         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00054         {
+00055                 if (i->channel) {
+00056                         if (!strcasecmp(i->channel,channel))
+00057                         {
+00058                                 return true;
+00059                         }
+00060                 }
+00061         }
+00062         return false;
+00063 }
 
    
   
 
@@ -359,26 +360,26 @@ Removes a channel from a users invite list.
 

 This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.
 

-Definition at line 71 of file users.cpp.
+Definition at line 72 of file users.cpp.
 

 References invites.
 

-
00072 {
-00073         log(DEBUG,"Removing invites");
-00074         if (invites.size())
-00075         {
-00076                 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00077                 {
-00078                         if (i->channel) {
-00079                                 if (!strcasecmp(i->channel,channel))
-00080                                 {
-00081                                         invites.erase(i);
-00082                                         return;
-00083                                 }
-00084                         }
-00085                 }
-00086         }
-00087 }
+
00073 {
+00074         log(DEBUG,"Removing invites");
+00075         if (invites.size())
+00076         {
+00077                 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00078                 {
+00079                         if (i->channel) {
+00080                                 if (!strcasecmp(i->channel,channel))
+00081                                 {
+00082                                         invites.erase(i);
+00083                                         return;
+00084                                 }
+00085                         }
+00086                 }
+00087         }
+00088 }
 
    
   
 
@@ -409,6 +410,30 @@ If this string is empty, the user is not marked as away.
 Definition at line 109 of file users.h.    
   
 
+

+
+  
+    
+  
+

+      
+        
+          
 char userrec::carryover[MAXBUF]
+      

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+
+

+Definition at line 116 of file users.h.    

 

 
@@ -538,7 +563,7 @@ A list of channels the user has a pending invite to.
 

 Definition at line 72 of file users.h.
 

-Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec().    
+Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec().    
   

   

 

 

@@ -618,7 +643,7 @@ You may use this to increase the speed of use of this class.
 

 Definition at line 114 of file users.h.
 

-Referenced by GetFullHost(), and GetFullRealHost().    
+Referenced by GetFullHost(), and GetFullRealHost().    
   
 
 

@@ -647,7 +672,7 @@ The server the user is connected to.
 Definition at line 104 of file users.h.    
   
 
-

+

 

   

     
@@ -668,14 +693,14 @@ Definition at line 104 of f
 

 
 

-Definition at line 116 of file users.h.
+Definition at line 118 of file users.h.
 

 Referenced by userrec().    

   

 

 
The documentation for this class was generated from the following files:
-
Generated on Wed Apr 7 19:20:59 2004 for InspIRCd by
+
Generated on Thu Apr 8 19:13:23 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3