From 78a96055c428d1970ece93dfb01902ac0d1699bd Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 4 Apr 2004 22:03:32 +0000 Subject: New documentation to document user/channel mode handling git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@380 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 62 +++++++++++++++++----------------- 1 file changed, 31 insertions(+), 31 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 5d18c102f..35e957755 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -5,7 +5,7 @@
-Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ConfigReader Class Reference

Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. More...

@@ -45,7 +45,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 357 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 358 of file modules.h.

Constructor & Destructor Documentation

@@ -75,13 +75,13 @@ Default constructor.

This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.

-Definition at line 236 of file modules.cpp. +Definition at line 265 of file modules.cpp.

-References fname. +References fname.

-

00237 {
-00238         fname = CONFIG_FILE;
-00239 }
+
00266 {
+00267         fname = CONFIG_FILE;
+00268 }
@@ -115,9 +115,9 @@ Overloaded constructor.

This constructor initialises the ConfigReader class to read a user-specified config file

-Definition at line 247 of file modules.cpp. +Definition at line 276 of file modules.cpp.

-

00247 : fname(filename) { };
+
00276 : fname(filename) { };
 
    
   
 
@@ -150,10 +150,10 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

-Definition at line 242 of file modules.cpp.
+Definition at line 271 of file modules.cpp.
 

-
00243 {
-00244 }
+
00272 {
+00273 }
 
    
   
 
@@ -188,13 +188,13 @@ Counts the number of times a given tag appears in the config file.
 

 This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of ConfigReader::ReadValue to loop through all copies of a multiple instance tag.
 

-Definition at line 257 of file modules.cpp.
+Definition at line 286 of file modules.cpp.
 

-References fname.
+References fname.
 

-
00258 {
-00259         return EnumConf(fname.c_str(),tag.c_str());
-00260 }
+
00287 {
+00288         return EnumConf(fname.c_str(),tag.c_str());
+00289 }
 
    
   
 
@@ -243,15 +243,15 @@ Retrieves a value from the config file.
 

 This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.
 

-Definition at line 249 of file modules.cpp.
+Definition at line 278 of file modules.cpp.
 

-References fname.
+References fname.
 

-
00250 {
-00251         char val[MAXBUF];
-00252         ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
-00253         return val;
-00254 }
+
00279 {
+00280         char val[MAXBUF];
+00281         ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
+00282         return val;
+00283 }
 
    
   
 
@@ -284,11 +284,11 @@ Returns true if a config file is valid.
 

 This method is unimplemented and will always return true.
 

-Definition at line 263 of file modules.cpp.
+Definition at line 292 of file modules.cpp.
 

-
00264 {
-00265         return true;
-00266 }
+
00293 {
+00294         return true;
+00295 }
 
    
   
 
@@ -316,14 +316,14 @@ The filename of the configuration file, as set by the constructor.
 

 
 

-Definition at line 362 of file modules.h.
+Definition at line 363 of file modules.h.
 

-Referenced by ConfigReader(), Enumerate(), and ReadValue().    
+Referenced by ConfigReader(), Enumerate(), and ReadValue().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Sat Apr 3 16:36:11 2004 for InspIRCd by
+
Generated on Sun Apr 4 23:02:24 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.3.1-10-gc9f91