From cc61d20faae9a29422d34a367db9ac54d8de3d0e Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 23 Jan 2003 20:38:00 +0000 Subject: Updated documentation scripts git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@143 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 186 +++++++++++++++++++-------------------- 1 file changed, 93 insertions(+), 93 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index d7a809046..9e7a519d6 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -60,7 +60,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 121 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 127 of file modules.h.

Constructor & Destructor Documentation

@@ -90,10 +90,10 @@ Default constructor.

Creates a Server object.

-Definition at line 52 of file modules.cpp. +Definition at line 55 of file modules.cpp.

-

00053 {
-00054 }
+
00056 {
+00057 }
@@ -126,10 +126,10 @@ Default destructor.

Destroys a Server object.

-Definition at line 56 of file modules.cpp. +Definition at line 59 of file modules.cpp.

-

00057 {
-00058 }
+
00060 {
+00061 }
 
    
   
 
@@ -173,12 +173,12 @@ Attempts to look up a user's privilages on a channel.
 

 This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.
 

-Definition at line 139 of file modules.cpp.
+Definition at line 142 of file modules.cpp.
 

-
00140 {
-00141         string mode = cmode(User,Chan);
-00142         return mode;
-00143 }
+
00143 {
+00144         string mode = cmode(User,Chan);
+00145         return mode;
+00146 }
 
    
   
 
@@ -221,11 +221,11 @@ Returns true if two users share a common channel.
 

 This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method.
 

-Definition at line 102 of file modules.cpp.
+Definition at line 105 of file modules.cpp.
 

-
00103 {
-00104         return (common_channels(u1,u2) != 0);
-00105 }
+
00106 {
+00107         return (common_channels(u1,u2) != 0);
+00108 }
 
    
   
 
@@ -259,11 +259,11 @@ Sends a debug string.
 

 This method writes a line of text to the debug log. If debugging is disabled in the configuration, this command has no effect.
 

-Definition at line 65 of file modules.cpp.
+Definition at line 68 of file modules.cpp.
 

-
00066 {
-00067         debug("%s",s.c_str());
-00068 }
+
00069 {
+00070         debug("%s",s.c_str());
+00071 }
 
    
   
 
@@ -297,11 +297,11 @@ Attempts to look up a channel and return a pointer to it.
 

 This function will return NULL if the channel does not exist.
 

-Definition at line 134 of file modules.cpp.
+Definition at line 137 of file modules.cpp.
 

-
00135 {
-00136         return FindChan(channel.c_str());
-00137 }
+
00138 {
+00139         return FindChan(channel.c_str());
+00140 }
 
    
   
 
@@ -335,11 +335,11 @@ Attempts to look up a nick and return a pointer to it.
 

 This function will return NULL if the nick does not exist.
 

-Definition at line 129 of file modules.cpp.
+Definition at line 132 of file modules.cpp.
 

-
00130 {
-00131         return Find(nick);
-00132 }
+
00133 {
+00134         return Find(nick);
+00135 }
 
    
   
 
@@ -372,11 +372,11 @@ Returns the information of the server as returned by the /ADMIN command.
 

 See the Admin class for further information of the return value. The members Admin::Nick, Admin::Email and Admin::Name contain the information for the server where the module is loaded.
 

-Definition at line 155 of file modules.cpp.
+Definition at line 158 of file modules.cpp.
 

-
00156 {
-00157         return Admin(getadminname(),getadminemail(),getadminnick());
-00158 }
+
00159 {
+00160         return Admin(getadminname(),getadminemail(),getadminnick());
+00161 }
 
    
   
 
@@ -409,11 +409,11 @@ Returns the network name, global to all linked servers.
 

 
 

-Definition at line 150 of file modules.cpp.
+Definition at line 153 of file modules.cpp.
 

-
00151 {
-00152         return getnetworkname();
-00153 }
+
00154 {
+00155         return getnetworkname();
+00156 }
 
    
   
 
@@ -446,11 +446,11 @@ Returns the server name of the server where the module is loaded.
 

 
 

-Definition at line 145 of file modules.cpp.
+Definition at line 148 of file modules.cpp.
 

-
00146 {
-00147         return getservername();
-00148 }
+
00149 {
+00150         return getservername();
+00151 }
 
    
   
 
@@ -484,11 +484,11 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 124 of file modules.cpp.
+Definition at line 127 of file modules.cpp.
 

-
00125 {
-00126         return (isnick(nick.c_str()) != 0);
-00127 }
+
00128 {
+00129         return (isnick(nick.c_str()) != 0);
+00130 }
 
    
   
 
@@ -531,11 +531,11 @@ Sends a line of text down a TCP/IP socket.
 

 This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.
 

-Definition at line 70 of file modules.cpp.
+Definition at line 73 of file modules.cpp.
 

-
00071 {
-00072         Write(Socket,"%s",s.c_str());
-00073 }
+
00074 {
+00075         Write(Socket,"%s",s.c_str());
+00076 }
 
    
   
 
@@ -590,18 +590,18 @@ Sends text from a user to a channel (mulicast).
 

 This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).
 

-Definition at line 90 of file modules.cpp.
-

-
00091 {
-00092         if (IncludeSender)
-00093         {
-00094                 WriteChannel(Channel,User,"%s",s.c_str());
-00095         }
-00096         else
-00097         {
-00098                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00099         }
-00100 }
+Definition at line 93 of file modules.cpp.
+

+
00094 {
+00095         if (IncludeSender)
+00096         {
+00097                 WriteChannel(Channel,User,"%s",s.c_str());
+00098         }
+00099         else
+00100         {
+00101                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00102         }
+00103 }
 
    
   
 
@@ -650,18 +650,18 @@ Sends text from a user to one or more channels (mulicast).
 

 This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.
 

-Definition at line 107 of file modules.cpp.
-

-
00108 {
-00109         if (IncludeSender)
-00110         {
-00111                 WriteCommon(User,"%s",text.c_str());
-00112         }
-00113         else
-00114         {
-00115                 WriteCommonExcept(User,"%s",text.c_str());
-00116         }
-00117 }
+Definition at line 110 of file modules.cpp.
+

+
00111 {
+00112         if (IncludeSender)
+00113         {
+00114                 WriteCommon(User,"%s",text.c_str());
+00115         }
+00116         else
+00117         {
+00118                 WriteCommonExcept(User,"%s",text.c_str());
+00119         }
+00120 }
 
    
   
 
@@ -710,11 +710,11 @@ Sends text from a user to a socket.
 

 This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
 

-Definition at line 80 of file modules.cpp.
+Definition at line 83 of file modules.cpp.
 

-
00081 {
-00082         WriteFrom(Socket,User,"%s",s.c_str());
-00083 }
+
00084 {
+00085         WriteFrom(Socket,User,"%s",s.c_str());
+00086 }
 
    
   
 
@@ -748,11 +748,11 @@ Sends text to all opers.
 

 This method sends a server notice to all opers with the usermode +s.
 

-Definition at line 60 of file modules.cpp.
+Definition at line 63 of file modules.cpp.
 

-
00061 {
-00062         WriteOpers("%s",s.c_str());
-00063 }
+
00064 {
+00065         WriteOpers("%s",s.c_str());
+00066 }
 
    
   
 
@@ -795,11 +795,11 @@ Sends text from the server to a socket.
 

 This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
 

-Definition at line 75 of file modules.cpp.
+Definition at line 78 of file modules.cpp.
 

-
00076 {
-00077         WriteServ(Socket,"%s",s.c_str());
-00078 }
+
00079 {
+00080         WriteServ(Socket,"%s",s.c_str());
+00081 }
 
    
   
 
@@ -848,11 +848,11 @@ Sends text from a user to another user.
 

 This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
 

-Definition at line 85 of file modules.cpp.
+Definition at line 88 of file modules.cpp.
 

-
00086 {
-00087         WriteTo(Source,Dest,"%s",s.c_str());
-00088 }
+
00089 {
+00090         WriteTo(Source,Dest,"%s",s.c_str());
+00091 }
 
    
   
 
@@ -895,17 +895,17 @@ Sends a WALLOPS message.
 

 This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
 

-Definition at line 119 of file modules.cpp.
+Definition at line 122 of file modules.cpp.
 

-
00120 {
-00121         WriteWallOps(User,"%s",text.c_str());
-00122 }
+
00123 {
+00124         WriteWallOps(User,"%s",text.c_str());
+00125 }
 
    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Wed Jan 22 20:56:48 2003 for InspIRCd by
+
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by
 
 doxygen1.3-rc2 

-- 
cgit v1.2.3