From 3741ee3cd2b940132c011ba37897b6fe516f7931 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 8 Apr 2004 18:14:00 +0000 Subject: New documentation for new ConfigReader methods git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@457 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 65 +++++++++++++++++++++++++++++----- 1 file changed, 57 insertions(+), 8 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 1e56ef39b..663a59fe3 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -34,6 +34,8 @@ Inheritance diagram for ConfigReader:



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

+int EnumerateValues (std::string tag, int index) + Returns the number of items within a tag.


Protected Attributes

std::stringstream * cache  The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).

@@ -82,7 +84,7 @@ Definition at line 319 References cache, and error. 

00320 {
-00321         this->cache = new std::stringstream(stringstream::in | stringstream::out);
+00321         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
 00322         this->error = LoadConf(CONFIG_FILE,this->cache);
 00323 }
@@ -123,7 +125,7 @@ Definition at line 333 References cache, and error. 

00334 {
-00335         this->cache = new std::stringstream(stringstream::in | stringstream::out);
+00335         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
 00336         this->error = LoadConf(filename.c_str(),this->cache);
 00337 };
@@ -208,6 +210,53 @@ Definition at line 347 +

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
int ConfigReader::EnumerateValues ( std::string   tag,
int   index
) 
+
+ + + + + +
+   + + +

+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. +

+

00353 {
+00354         return EnumValues(cache, tag.c_str(), index);
+00355 }
+

@@ -292,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 353 of file modules.cpp. +Definition at line 357 of file modules.cpp.

References error.

-

00354 {
-00355         return this->error;
-00356 }
+
00358 {
+00359         return this->error;
+00360 }
@@ -356,12 +405,12 @@ Used to store errors.

Definition at line 480 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 Wed Apr 7 19:20:37 2004 for InspIRCd by +
Generated on Thu Apr 8 19:12:55 2004 for InspIRCd by doxygen1.3-rc3
-- cgit v1.3.1-10-gc9f91