From 755d67224f033aaa9b4ef3d2dd00f46bb8c19dc2 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 7 Apr 2005 20:15:05 +0000 Subject: New docs to match extra module Version class stuff, etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1008 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 320 ++++++++++++++++----------------- 1 file changed, 160 insertions(+), 160 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index f5785a066..7ece1927f 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -67,7 +67,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 675 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 685 of file modules.h.

Constructor & Destructor Documentation

@@ -97,17 +97,17 @@ Default constructor.

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

-Definition at line 577 of file modules.cpp. +Definition at line 579 of file modules.cpp.

-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.

-

00578 {
-00579         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00580         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00581         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00582         if (!this->readerror)
-00583                 this->error = CONF_FILE_NOT_FOUND;
-00584 }
+
00580 {
+00581         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00582         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00583         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00584         if (!this->readerror)
+00585                 this->error = CONF_FILE_NOT_FOUND;
+00586 }
@@ -141,17 +141,17 @@ Overloaded constructor.

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

-Definition at line 596 of file modules.cpp. +Definition at line 598 of file modules.cpp.

-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.

-

00597 {
-00598         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00599         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00600         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00601         if (!this->readerror)
-00602                 this->error = CONF_FILE_NOT_FOUND;
-00603 };
+
00599 {
+00600         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00601         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00602         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00603         if (!this->readerror)
+00604                 this->error = CONF_FILE_NOT_FOUND;
+00605 };
 
    
   
 
@@ -184,16 +184,16 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

-Definition at line 587 of file modules.cpp.
+Definition at line 589 of file modules.cpp.
 

-References cache, and errorlog.
+References cache, and errorlog.
 

-
00588 {
-00589         if (this->cache)
-00590                 delete this->cache;
-00591         if (this->errorlog)
-00592                 delete this->errorlog;
-00593 }
+
00590 {
+00591         if (this->cache)
+00592                 delete this->cache;
+00593         if (this->errorlog)
+00594                 delete this->errorlog;
+00595 }
 
    
   
 
@@ -237,40 +237,40 @@ Dumps the list of errors in a config file to an output location.
 

 If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.
 

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

-References errorlog, connection::fd, and userrec::nick.
-

-
00675 {
-00676         if (bail)
-00677         {
-00678                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00679                 exit(0);
-00680         }
-00681         else
-00682         {
-00683                 char dataline[1024];
-00684                 if (user)
-00685                 {
-00686                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00687                         while (!errorlog->eof())
-00688                         {
-00689                                 errorlog->getline(dataline,1024);
-00690                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00691                         }
-00692                 }
-00693                 else
-00694                 {
-00695                         WriteOpers("There were errors in the configuration file:",user->nick);
-00696                         while (!errorlog->eof())
-00697                         {
-00698                                 errorlog->getline(dataline,1024);
-00699                                 WriteOpers(dataline);
-00700                         }
-00701                 }
-00702                 return;
-00703         }
-00704 }
+Definition at line 676 of file modules.cpp.
+

+References errorlog, connection::fd, and userrec::nick.
+

+
00677 {
+00678         if (bail)
+00679         {
+00680                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00681                 exit(0);
+00682         }
+00683         else
+00684         {
+00685                 char dataline[1024];
+00686                 if (user)
+00687                 {
+00688                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00689                         while (!errorlog->eof())
+00690                         {
+00691                                 errorlog->getline(dataline,1024);
+00692                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00693                         }
+00694                 }
+00695                 else
+00696                 {
+00697                         WriteOpers("There were errors in the configuration file:",user->nick);
+00698                         while (!errorlog->eof())
+00699                         {
+00700                                 errorlog->getline(dataline,1024);
+00701                                 WriteOpers(dataline);
+00702                         }
+00703                 }
+00704                 return;
+00705         }
+00706 }
 
    
   
 
@@ -304,13 +304,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 707 of file modules.cpp.
+Definition at line 709 of file modules.cpp.
 

-References cache.
+References cache.
 

-
00708 {
-00709         return EnumConf(cache,tag.c_str());
-00710 }
+
00710 {
+00711         return EnumConf(cache,tag.c_str());
+00712 }
 
    
   
 
@@ -353,13 +353,13 @@ 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 712 of file modules.cpp.
+Definition at line 714 of file modules.cpp.
 

-References cache.
+References cache.
 

-
00713 {
-00714         return EnumValues(cache, tag.c_str(), index);
-00715 }
+
00715 {
+00716         return EnumValues(cache, tag.c_str(), index);
+00717 }
 
    
   
 
@@ -392,15 +392,15 @@ Returns the last error to occur.
 

 Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition. A call to GetError() resets the error flag back to 0.
 

-Definition at line 667 of file modules.cpp.
+Definition at line 669 of file modules.cpp.
 

-References error.
+References error.
 

-
00668 {
-00669         long olderr = this->error;
-00670         this->error = 0;
-00671         return olderr;
-00672 }
+
00670 {
+00671         long olderr = this->error;
+00672         this->error = 0;
+00673         return olderr;
+00674 }
 
    
   
 
@@ -449,25 +449,25 @@ Retrieves a boolean value from the config file.
 

 This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values "1", "yes" and "true" in the config file count as true to ReadFlag, and any other value counts as false.
 

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

-References cache, CONF_VALUE_NOT_FOUND, and error.
-

-
00622 {
-00623         char val[MAXBUF];
-00624         char t[MAXBUF];
-00625         char n[MAXBUF];
-00626         strlcpy(t,tag.c_str(),MAXBUF);
-00627         strlcpy(n,name.c_str(),MAXBUF);
-00628         int res = ReadConf(cache,t,n,index,val);
-00629         if (!res)
-00630         {
-00631                 this->error = CONF_VALUE_NOT_FOUND;
-00632                 return false;
-00633         }
-00634         std::string s = val;
-00635         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00636 }
+Definition at line 623 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
+

+
00624 {
+00625         char val[MAXBUF];
+00626         char t[MAXBUF];
+00627         char n[MAXBUF];
+00628         strlcpy(t,tag.c_str(),MAXBUF);
+00629         strlcpy(n,name.c_str(),MAXBUF);
+00630         int res = ReadConf(cache,t,n,index,val);
+00631         if (!res)
+00632         {
+00633                 this->error = CONF_VALUE_NOT_FOUND;
+00634                 return false;
+00635         }
+00636         std::string s = val;
+00637         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00638 }
 
    
   
 
@@ -522,37 +522,37 @@ Retrieves an integer value from the config file.
 

 This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to GetError() will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError() will return CONF_NOT_UNSIGNED
 

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

-References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
-

-
00639 {
-00640         char val[MAXBUF];
-00641         char t[MAXBUF];
-00642         char n[MAXBUF];
-00643         strlcpy(t,tag.c_str(),MAXBUF);
-00644         strlcpy(n,name.c_str(),MAXBUF);
-00645         int res = ReadConf(cache,t,n,index,val);
-00646         if (!res)
-00647         {
-00648                 this->error = CONF_VALUE_NOT_FOUND;
-00649                 return 0;
-00650         }
-00651         for (int i = 0; i < strlen(val); i++)
-00652         {
-00653                 if (!isdigit(val[i]))
-00654                 {
-00655                         this->error = CONF_NOT_A_NUMBER;
-00656                         return 0;
-00657                 }
-00658         }
-00659         if ((needs_unsigned) && (atoi(val)<0))
-00660         {
-00661                 this->error = CONF_NOT_UNSIGNED;
-00662                 return 0;
-00663         }
-00664         return atoi(val);
-00665 }
+Definition at line 640 of file modules.cpp.
+

+References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
+

+
00641 {
+00642         char val[MAXBUF];
+00643         char t[MAXBUF];
+00644         char n[MAXBUF];
+00645         strlcpy(t,tag.c_str(),MAXBUF);
+00646         strlcpy(n,name.c_str(),MAXBUF);
+00647         int res = ReadConf(cache,t,n,index,val);
+00648         if (!res)
+00649         {
+00650                 this->error = CONF_VALUE_NOT_FOUND;
+00651                 return 0;
+00652         }
+00653         for (int i = 0; i < strlen(val); i++)
+00654         {
+00655                 if (!isdigit(val[i]))
+00656                 {
+00657                         this->error = CONF_NOT_A_NUMBER;
+00658                         return 0;
+00659                 }
+00660         }
+00661         if ((needs_unsigned) && (atoi(val)<0))
+00662         {
+00663                 this->error = CONF_NOT_UNSIGNED;
+00664                 return 0;
+00665         }
+00666         return atoi(val);
+00667 }
 
    
   
 
@@ -601,24 +601,24 @@ 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 605 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, and error.
-

-
00606 {
-00607         char val[MAXBUF];
-00608         char t[MAXBUF];
-00609         char n[MAXBUF];
-00610         strlcpy(t,tag.c_str(),MAXBUF);
-00611         strlcpy(n,name.c_str(),MAXBUF);
-00612         int res = ReadConf(cache,t,n,index,val);
-00613         if (!res)
-00614         {
-00615                 this->error = CONF_VALUE_NOT_FOUND;
-00616                 return "";
-00617         }
-00618         return std::string(val);
-00619 }
+Definition at line 607 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
+

+
00608 {
+00609         char val[MAXBUF];
+00610         char t[MAXBUF];
+00611         char n[MAXBUF];
+00612         strlcpy(t,tag.c_str(),MAXBUF);
+00613         strlcpy(n,name.c_str(),MAXBUF);
+00614         int res = ReadConf(cache,t,n,index,val);
+00615         if (!res)
+00616         {
+00617                 this->error = CONF_VALUE_NOT_FOUND;
+00618                 return "";
+00619         }
+00620         return std::string(val);
+00621 }
 
    
   
 
@@ -651,13 +651,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 717 of file modules.cpp.
+Definition at line 719 of file modules.cpp.
 

-References readerror.
+References readerror.
 

-
00718 {
-00719         return this->readerror;
-00720 }
+
00720 {
+00721         return this->readerror;
+00722 }
 
    
   
 
@@ -685,9 +685,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 683 of file modules.h.
+Definition at line 693 of file modules.h.
 

-Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().    
+Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().    
   
 
 

@@ -711,9 +711,9 @@ Referenced by ConfigReader(
 

 
 

-Definition at line 688 of file modules.h.
+Definition at line 698 of file modules.h.
 

-Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().    
+Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().    
   
 
 

@@ -737,9 +737,9 @@ Referenced by ConfigReader(
 

 
 

-Definition at line 684 of file modules.h.
+Definition at line 694 of file modules.h.
 

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

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

 
 

-Definition at line 687 of file modules.h.
+Definition at line 697 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 4 18:12:51 2005 for InspIRCd by
+
Generated on Thu Apr 7 20:14:24 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3