From a753fb1bc711e10794e939e424f3cdd703116d82 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 2 Apr 2004 12:38:41 +0000 Subject: Added support for modules to create commands - this needs a proof-of-concept module yet, do not use unless you like to live dangerously. git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@351 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 81 +++++++++++++++++----------------- 1 file changed, 40 insertions(+), 41 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 7858c077e..5fb1368d4 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -24,18 +24,18 @@ Inheritance diagram for ConfigReader:

ConfigReader ()  Default constructor.

- ConfigReader (string filename) + ConfigReader (std::string filename)  Overloaded constructor.

 ~ConfigReader ()  Default destructor.

-string ReadValue (string tag, string name, int index) +std::string ReadValue (std::string tag, std::string name, int index)  Retrieves a value from the config file.

-int Enumerate (string tag) +int Enumerate (std::string tag)  Counts the number of times a given tag appears in the config file.

bool Verify ()  Returns true if a config file is valid.


Protected Attributes

-string fname +std::string fname  The filename of the configuration file, as set by the constructor.

Detailed Description

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

-Definition at line 252 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 302 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 152 of file modules.cpp. +Definition at line 225 of file modules.cpp.

-References fname. +References fname.

-

00153 {
-00154         fname = CONFIG_FILE;
-00155 }
+
00226 {
+00227         fname = CONFIG_FILE;
+00228 }
@@ -93,7 +93,7 @@ References fname. ConfigReader::ConfigReader (  - string  + std::string    filename )  @@ -115,9 +115,9 @@ Overloaded constructor.

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

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

-

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

 This method destroys the ConfigReader class.
 

-Definition at line 158 of file modules.cpp.
+Definition at line 231 of file modules.cpp.
 

-
00159 {
-00160 }
+
00232 {
+00233 }
 
    
   
 
@@ -166,7 +166,7 @@ Definition at line 158
         
            int ConfigReader::Enumerate 
           ( 
-          string 
+          std::string 
             tag          
           ) 
           
@@ -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 174 of file modules.cpp.
+Definition at line 246 of file modules.cpp.
 

-References fname.
+References fname.
 

-
00175 {
-00176         return EnumConf(fname.c_str(),tag.c_str());
-00177 }
+
00247 {
+00248         return EnumConf(fname.c_str(),tag.c_str());
+00249 }
 
    
   
 
@@ -204,15 +204,15 @@ References fname.
     
       
-          
+          
-          
+          
-          
+          
@@ -243,16 +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 165 of file modules.cpp.
+Definition at line 238 of file modules.cpp.
 

-References fname.
+References fname.
 

-
00166 {
-00167         char val[MAXBUF];
-00168         ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
-00169         string s = val;
-00170         return s;
-00171 }
+
00239 {
+00240         char val[MAXBUF];
+00241         ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
+00242         return val;
+00243 }
 
    
   

         
 string ConfigReader::ReadValue  std::string ConfigReader::ReadValue 
           ( string std::string 
             tag, 
         

         

           
           string std::string 
             name, 
         

         

 

@@ -285,11 +284,11 @@ Returns true if a config file is valid.
 

 This method is unimplemented and will always return true.
 

-Definition at line 180 of file modules.cpp.
+Definition at line 252 of file modules.cpp.
 

-
00181 {
-00182         return true;
-00183 }
+
00253 {
+00254         return true;
+00255 }
 
    
   
 
@@ -300,7 +299,7 @@ Definition at line 180
     
       
-          

         
 string ConfigReader::fname [protected]
+           std::string ConfigReader::fname [protected]
       

     
   
@@ -317,14 +316,14 @@ The filename of the configuration file, as set by the constructor.
 

 
 

-Definition at line 257 of file modules.h.
+Definition at line 307 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 Sun Mar 30 19:35:47 2003 for InspIRCd by
+
Generated on Fri Apr 2 13:37:37 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.3.1-10-gc9f91