From 0f2cf28d39404881b9719330ca86757c51b87bad Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 1 May 2004 19:58:59 +0000 Subject: Added documentation of new ConfigReader methods suggested by Azhrarn for sanity git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@772 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 100 +++++++++++++++++------------------ 1 file changed, 50 insertions(+), 50 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index fc98c5761..6c35863a4 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -37,7 +37,7 @@ Inheritance diagram for FileReader:

FileSize ()  Returns the size of the file in lines.


Private Attributes

-file_cache fc +file_cache fc

Detailed Description

Caches a text file into memory and can be used to retrieve lines from it. @@ -46,7 +46,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 672 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 698 of file modules.h.

Constructor & Destructor Documentation

@@ -76,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 608 of file modules.cpp. +Definition at line 670 of file modules.cpp.

-

00609 {
-00610 }
+
00671 {
+00672 }
@@ -113,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 601 of file modules.cpp. +Definition at line 663 of file modules.cpp.

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

-

00602 {
-00603         file_cache c;
-00604         readfile(c,filename.c_str());
-00605         this->fc = c;
-00606 }
+
00664 {
+00665         file_cache c;
+00666         readfile(c,filename.c_str());
+00667         this->fc = c;
+00668 }
 
    
   
 
@@ -154,10 +154,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 620 of file modules.cpp.
+Definition at line 682 of file modules.cpp.
 

-
00621 {
-00622 }
+
00683 {
+00684 }
 
    
   
 
@@ -191,20 +191,20 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 624 of file modules.cpp.
+Definition at line 686 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00625 {
-00626         if (fc.size() == 0)
-00627         {
-00628                 return(false);
-00629         }
-00630         else
-00631         {
-00632                 return(true);
-00633         }
-00634 }
+
00687 {
+00688         if (fc.size() == 0)
+00689         {
+00690                 return(false);
+00691         }
+00692         else
+00693         {
+00694                 return(true);
+00695         }
+00696 }
 
    
   
 
@@ -237,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 643 of file modules.cpp.
+Definition at line 705 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00644 {
-00645         return fc.size();
-00646 }
+
00706 {
+00707         return fc.size();
+00708 }
 
    
   
 
@@ -277,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 636 of file modules.cpp.
+Definition at line 698 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00637 {
-00638         if ((x<0) || (x>fc.size()))
-00639                 return "";
-00640         return fc[x];
-00641 }
+
00699 {
+00700         if ((x<0) || (x>fc.size()))
+00701                 return "";
+00702         return fc[x];
+00703 }
 
    
   
 
@@ -319,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 612 of file modules.cpp.
+Definition at line 674 of file modules.cpp.
 

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

-
00613 {
-00614         file_cache c;
-00615         readfile(c,filename.c_str());
-00616         this->fc = c;
-00617 }
+
00675 {
+00676         file_cache c;
+00677         readfile(c,filename.c_str());
+00678         this->fc = c;
+00679 }
 
    
   
 
@@ -338,7 +338,7 @@ References fc, and 
       
-          

         
 file_cache FileReader::fc [private]
+           file_cache FileReader::fc [private]
       

     
   
@@ -353,14 +353,14 @@ References fc, and 
 
 

-Definition at line 674 of file modules.h.
+Definition at line 700 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 Sat May 1 17:50:26 2004 for InspIRCd by
+
Generated on Sat May 1 20:58:06 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.3.1-10-gc9f91