From b25c31de6b8dd839429cb168f5731a5605e17366 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 24 Apr 2004 23:26:47 +0000 Subject: Added new documentation for XLine etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@718 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 90 ++++++++++++++++++---------------- 1 file changed, 47 insertions(+), 43 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 957309bf3..7ce292506 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -49,7 +49,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 497 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 516 of file modules.h.

Constructor & Destructor Documentation

@@ -79,14 +79,14 @@ Default constructor.

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

-Definition at line 336 of file modules.cpp. +Definition at line 343 of file modules.cpp.

-References cache, and error. +References cache, and error.

-

00337 {
-00338         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00339         this->error = LoadConf(CONFIG_FILE,this->cache);
-00340 }
+
00344 {
+00345         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00346         this->error = LoadConf(CONFIG_FILE,this->cache);
+00347 }
@@ -120,14 +120,14 @@ Overloaded constructor.

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

-Definition at line 350 of file modules.cpp. +Definition at line 357 of file modules.cpp.

-References cache, and error. +References cache, and error.

-

00351 {
-00352         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00353         this->error = LoadConf(filename.c_str(),this->cache);
-00354 };
+
00358 {
+00359         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00360         this->error = LoadConf(filename.c_str(),this->cache);
+00361 };
 
    
   
 
@@ -160,14 +160,14 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

-Definition at line 343 of file modules.cpp.
+Definition at line 350 of file modules.cpp.
 

-References cache.
+References cache.
 

-
00344 {
-00345         if (this->cache)
-00346                 delete this->cache;
-00347 }
+
00351 {
+00352         if (this->cache)
+00353                 delete this->cache;
+00354 }
 
    
   
 
@@ -202,11 +202,11 @@ 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 364 of file modules.cpp.
+Definition at line 375 of file modules.cpp.
 

-
00365 {
-00366         return EnumConf(cache,tag.c_str());
-00367 }
+
00376 {
+00377         return EnumConf(cache,tag.c_str());
+00378 }
 
    
   
 
@@ -249,11 +249,11 @@ Returns the number of items within a tag.
 

 For example if the tag was <test tag="blah" data="foo"> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.
 

-Definition at line 369 of file modules.cpp.
+Definition at line 380 of file modules.cpp.
 

-
00370 {
-00371         return EnumValues(cache, tag.c_str(), index);
-00372 }
+
00381 {
+00382         return EnumValues(cache, tag.c_str(), index);
+00383 }
 
    
   
 
@@ -302,13 +302,17 @@ 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 356 of file modules.cpp.
+Definition at line 363 of file modules.cpp.
 

-
00357 {
-00358         char val[MAXBUF];
-00359         ReadConf(cache,tag.c_str(),name.c_str(),index,val);
-00360         return val;
-00361 }
+
00364 {
+00365         char val[MAXBUF];
+00366         char t[MAXBUF];
+00367         char n[MAXBUF];
+00368         strncpy(t,tag.c_str(),MAXBUF);
+00369         strncpy(n,name.c_str(),MAXBUF);
+00370         ReadConf(cache,t,n,index,val);
+00371         return std::string(val);
+00372 }
 
    
   
 
@@ -341,13 +345,13 @@ Returns true if a config file is valid.
 

 This method is partially implemented and will only return false if the config file does not exist or could not be opened.
 

-Definition at line 374 of file modules.cpp.
+Definition at line 385 of file modules.cpp.
 

-References error.
+References error.
 

-
00375 {
-00376         return this->error;
-00377 }
+
00386 {
+00387         return this->error;
+00388 }
 
    
   
 
@@ -375,9 +379,9 @@ The contents of the configuration file This protected member should never be acc
 

 It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.
 

-Definition at line 505 of file modules.h.
+Definition at line 524 of file modules.h.
 

-Referenced by ConfigReader(), and ~ConfigReader().    
+Referenced by ConfigReader(), and ~ConfigReader().    
   
 
 

@@ -403,14 +407,14 @@ Used to store errors.
 

 
 

-Definition at line 508 of file modules.h.
+Definition at line 527 of file modules.h.
 

-Referenced by ConfigReader(), and Verify().    
+Referenced by ConfigReader(), and Verify().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Mon Apr 19 02:34:42 2004 for InspIRCd by
+
Generated on Sun Apr 25 00:24:18 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3