From 877a15fc3db18be9131c886720516eae6f582886 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 1 May 2004 16:54:50 +0000 Subject: Added extra docs to cover OnUserSync etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@769 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 96 +++++++++++++++++----------------- 1 file changed, 48 insertions(+), 48 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 34229d103..648d7fd88 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 588 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 612 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 385 of file modules.cpp. +Definition at line 553 of file modules.cpp.

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

-

00386 {
-00387         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00388         this->error = LoadConf(CONFIG_FILE,this->cache);
-00389 }
+
00554 {
+00555         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00556         this->error = LoadConf(CONFIG_FILE,this->cache);
+00557 }
@@ -120,14 +120,14 @@ Overloaded constructor.

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

-Definition at line 399 of file modules.cpp. +Definition at line 567 of file modules.cpp.

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

-

00400 {
-00401         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00402         this->error = LoadConf(filename.c_str(),this->cache);
-00403 };
+
00568 {
+00569         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00570         this->error = LoadConf(filename.c_str(),this->cache);
+00571 };
 
    
   
 
@@ -160,14 +160,14 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

-Definition at line 392 of file modules.cpp.
+Definition at line 560 of file modules.cpp.
 

-References cache.
+References cache.
 

-
00393 {
-00394         if (this->cache)
-00395                 delete this->cache;
-00396 }
+
00561 {
+00562         if (this->cache)
+00563                 delete this->cache;
+00564 }
 
    
   
 
@@ -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 417 of file modules.cpp.
+Definition at line 585 of file modules.cpp.
 

-
00418 {
-00419         return EnumConf(cache,tag.c_str());
-00420 }
+
00586 {
+00587         return EnumConf(cache,tag.c_str());
+00588 }
 
    
   
 
@@ -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 422 of file modules.cpp.
+Definition at line 590 of file modules.cpp.
 

-
00423 {
-00424         return EnumValues(cache, tag.c_str(), index);
-00425 }
+
00591 {
+00592         return EnumValues(cache, tag.c_str(), index);
+00593 }
 
    
   
 
@@ -302,17 +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 405 of file modules.cpp.
-

-
00406 {
-00407         char val[MAXBUF];
-00408         char t[MAXBUF];
-00409         char n[MAXBUF];
-00410         strncpy(t,tag.c_str(),MAXBUF);
-00411         strncpy(n,name.c_str(),MAXBUF);
-00412         ReadConf(cache,t,n,index,val);
-00413         return std::string(val);
-00414 }
+Definition at line 573 of file modules.cpp.
+

+
00574 {
+00575         char val[MAXBUF];
+00576         char t[MAXBUF];
+00577         char n[MAXBUF];
+00578         strncpy(t,tag.c_str(),MAXBUF);
+00579         strncpy(n,name.c_str(),MAXBUF);
+00580         ReadConf(cache,t,n,index,val);
+00581         return std::string(val);
+00582 }
 
    
   
 
@@ -345,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 427 of file modules.cpp.
+Definition at line 595 of file modules.cpp.
 

-References error.
+References error.
 

-
00428 {
-00429         return this->error;
-00430 }
+
00596 {
+00597         return this->error;
+00598 }
 
    
   
 
@@ -379,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 596 of file modules.h.
+Definition at line 620 of file modules.h.
 

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

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

 
 

-Definition at line 599 of file modules.h.
+Definition at line 623 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 Sat May 1 13:39:13 2004 for InspIRCd by
+
Generated on Sat May 1 17:50:22 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.3.1-10-gc9f91