From 44b62866f83dea028500d81274eaaba8e886e1c3 Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 30 Mar 2003 12:32:32 +0000 Subject: Added DOT files to documentation for class diagrams (pretteh!) git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@169 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 81 ++++++++++++++++++---------------- 1 file changed, 42 insertions(+), 39 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 6ae16f47a..a83fd9e29 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -3,7 +3,7 @@ ConfigReader class Reference - +
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ConfigReader Class Reference

Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. @@ -11,14 +11,17 @@

#include <modules.h>

-

Inheritance diagram for ConfigReader: -

- -classbase +Inheritance diagram for ConfigReader:

Inheritance graph
+ + -List of all members. +
[legend]
Collaboration diagram for ConfigReader:

Collaboration graph
+ + + +
[legend]
List of all members.
- + @@ -42,7 +45,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 218 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 219 of file modules.h.

Constructor & Destructor Documentation


Public Methods


Public Member Functions

 ConfigReader ()
 Default constructor.

 ConfigReader (string filename)
@@ -72,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 151 of file modules.cpp. +Definition at line 152 of file modules.cpp.

-References fname. +References fname.

-

00152 {
-00153         fname = CONFIG_FILE;
-00154 }
+
00153 {
+00154         fname = CONFIG_FILE;
+00155 }
@@ -112,9 +115,9 @@ Overloaded constructor.

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

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

-

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

 This method destroys the ConfigReader class.
 

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

-
00158 {
-00159 }
+
00159 {
+00160 }
 
    
   
 
@@ -185,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 173 of file modules.cpp.
+Definition at line 174 of file modules.cpp.
 

-References fname.
+References fname.
 

-
00174 {
-00175         return EnumConf(fname.c_str(),tag.c_str());
-00176 }
+
00175 {
+00176         return EnumConf(fname.c_str(),tag.c_str());
+00177 }
 
    
   
 
@@ -240,16 +243,16 @@ 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 164 of file modules.cpp.
+Definition at line 165 of file modules.cpp.
 

-References fname.
+References fname.
 

-
00165 {
-00166         char val[MAXBUF];
-00167         ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
-00168         string s = val;
-00169         return s;
-00170 }
+
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 }
 
    
   
 
@@ -282,11 +285,11 @@ Returns true if a config file is valid.
 

 This method is unimplemented and will always return true.
 

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

-
00180 {
-00181         return true;
-00182 }
+
00181 {
+00182         return true;
+00183 }
 
    
   
 
@@ -314,16 +317,16 @@ The filename of the configuration file, as set by the constructor.
 

 
 

-Definition at line 223 of file modules.h.
+Definition at line 224 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 Feb 9 12:48:17 2003 for InspIRCd by
+
Generated on Sun Mar 30 13:28:46 2003 for InspIRCd by
 
 doxygen1.3-rc2 

+width=110 height=53>1.3-rc3 

 
 
-- 
cgit v1.3.1-10-gc9f91