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/classFileReader.html | 95 +++++++++++++++++++----------------- 1 file changed, 49 insertions(+), 46 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 000c829b8..3ca670a48 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -31,6 +31,7 @@ Inheritance diagram for FileReader:

LoadFile (std::string filename)  Used to load a file.

bool Exists () + Returns true if the file exists This function will return false if the file could not be opened.

std::string GetLine (int x)  Retrieve one line from the file.

int FileSize () @@ -45,7 +46,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 522 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 529 of file modules.h.

Constructor & Destructor Documentation

@@ -75,10 +76,10 @@ Default constructor.

This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.

-Definition at line 366 of file modules.cpp. +Definition at line 370 of file modules.cpp.

-

00367 {
-00368 }
+
00371 {
+00372 }
@@ -112,15 +113,15 @@ Secondary constructor.

This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.

-Definition at line 359 of file modules.cpp. +Definition at line 363 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00360 {
-00361         file_cache c;
-00362         readfile(c,filename.c_str());
-00363         this->fc = c;
-00364 }
+
00364 {
+00365         file_cache c;
+00366         readfile(c,filename.c_str());
+00367         this->fc = c;
+00368 }
 
    
   
 
@@ -153,10 +154,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 378 of file modules.cpp.
+Definition at line 382 of file modules.cpp.
 

-
00379 {
-00380 }
+
00383 {
+00384 }
 
    
   
 
@@ -186,22 +187,24 @@ Definition at line 378
     
 
 

+Returns true if the file exists This function will return false if the file could not be opened.
+

 
 

-Definition at line 382 of file modules.cpp.
+Definition at line 386 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00383 {
-00384         if (fc.size() == 0)
-00385         {
-00386                 return(false);
-00387         }
-00388         else
+
00387 {
+00388         if (fc.size() == 0)
 00389         {
-00390                 return(true);
+00390                 return(false);
 00391         }
-00392 }
+00392         else
+00393         {
+00394                 return(true);
+00395         }
+00396 }
 
    
   
 
@@ -234,13 +237,13 @@ Returns the size of the file in lines.
 

 This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.
 

-Definition at line 401 of file modules.cpp.
+Definition at line 405 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00402 {
-00403         return fc.size();
-00404 }
+
00406 {
+00407         return fc.size();
+00408 }
 
    
   
 
@@ -274,15 +277,15 @@ Retrieve one line from the file.
 

 This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.
 

-Definition at line 394 of file modules.cpp.
+Definition at line 398 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00395 {
-00396         if ((x<0) || (x>fc.size()))
-00397                 return "";
-00398         return fc[x];
-00399 }
+
00399 {
+00400         if ((x<0) || (x>fc.size()))
+00401                 return "";
+00402         return fc[x];
+00403 }
 
    
   
 
@@ -316,15 +319,15 @@ Used to load a file.
 

 This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.
 

-Definition at line 370 of file modules.cpp.
+Definition at line 374 of file modules.cpp.
 

-References fc, and file_cache.
+References fc, and file_cache.
 

-
00371 {
-00372         file_cache c;
-00373         readfile(c,filename.c_str());
-00374         this->fc = c;
-00375 }
+
00375 {
+00376         file_cache c;
+00377         readfile(c,filename.c_str());
+00378         this->fc = c;
+00379 }
 
    
   
 
@@ -350,14 +353,14 @@ References fc, and 
 
 

-Definition at line 524 of file modules.h.
+Definition at line 531 of file modules.h.
 

-Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().    
+Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Wed Apr 7 19:20:44 2004 for InspIRCd by
+
Generated on Thu Apr 8 19:13:03 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.3.1-10-gc9f91