From afb51347b493a6ab54fcc8595b4a3f46972ce18f Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 17 Apr 2004 12:33:39 +0000 Subject: Added new documentation to cover ircd_connector git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@629 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 86 +++++++++++++++++----------------- 1 file changed, 43 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 663a59fe3..91aa3ef65 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 469 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 497 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 319 of file modules.cpp. +Definition at line 334 of file modules.cpp.

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

-

00320 {
-00321         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00322         this->error = LoadConf(CONFIG_FILE,this->cache);
-00323 }
+
00335 {
+00336         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00337         this->error = LoadConf(CONFIG_FILE,this->cache);
+00338 }
@@ -120,14 +120,14 @@ Overloaded constructor.

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

-Definition at line 333 of file modules.cpp. +Definition at line 348 of file modules.cpp.

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

-

00334 {
-00335         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00336         this->error = LoadConf(filename.c_str(),this->cache);
-00337 };
+
00349 {
+00350         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00351         this->error = LoadConf(filename.c_str(),this->cache);
+00352 };
 
    
   
 
@@ -160,14 +160,14 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

-Definition at line 326 of file modules.cpp.
+Definition at line 341 of file modules.cpp.
 

-References cache.
+References cache.
 

-
00327 {
-00328         if (this->cache)
-00329                 delete this->cache;
-00330 }
+
00342 {
+00343         if (this->cache)
+00344                 delete this->cache;
+00345 }
 
    
   
 
@@ -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 347 of file modules.cpp.
+Definition at line 362 of file modules.cpp.
 

-
00348 {
-00349         return EnumConf(cache,tag.c_str());
-00350 }
+
00363 {
+00364         return EnumConf(cache,tag.c_str());
+00365 }
 
    
   
 
@@ -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 352 of file modules.cpp.
+Definition at line 367 of file modules.cpp.
 

-
00353 {
-00354         return EnumValues(cache, tag.c_str(), index);
-00355 }
+
00368 {
+00369         return EnumValues(cache, tag.c_str(), index);
+00370 }
 
    
   
 
@@ -302,13 +302,13 @@ 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 339 of file modules.cpp.
+Definition at line 354 of file modules.cpp.
 

-
00340 {
-00341         char val[MAXBUF];
-00342         ReadConf(cache,tag.c_str(),name.c_str(),index,val);
-00343         return val;
-00344 }
+
00355 {
+00356         char val[MAXBUF];
+00357         ReadConf(cache,tag.c_str(),name.c_str(),index,val);
+00358         return val;
+00359 }
 
    
   
 
@@ -341,13 +341,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 357 of file modules.cpp.
+Definition at line 372 of file modules.cpp.
 

-References error.
+References error.
 

-
00358 {
-00359         return this->error;
-00360 }
+
00373 {
+00374         return this->error;
+00375 }
 
    
   
 
@@ -375,9 +375,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 477 of file modules.h.
+Definition at line 505 of file modules.h.
 

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

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

 
 

-Definition at line 480 of file modules.h.
+Definition at line 508 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 Thu Apr 8 19:12:55 2004 for InspIRCd by
+
Generated on Sat Apr 17 13:31:47 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3