From 08e384bb24398224856c44baa51b51977644de9d Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 9 Feb 2003 12:49:00 +0000 Subject: Documentation update, 09/02/03 git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@167 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 76 ++++++++++++++++++------------------ 1 file changed, 38 insertions(+), 38 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index ac40e03b9..64b7ecd9c 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -32,7 +32,7 @@ int 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. @@ -41,7 +41,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 282 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 263 of file modules.h.

Constructor & Destructor Documentation

@@ -71,10 +71,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 205 of file modules.cpp. +Definition at line 192 of file modules.cpp.

-

00206 {
-00207 }
+
00193 {
+00194 }
@@ -108,15 +108,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 198 of file modules.cpp. +Definition at line 185 of file modules.cpp.

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

-

00199 {
-00200         file_cache c;
-00201         readfile(c,filename.c_str());
-00202         this->fc = c;
-00203 }
+
00186 {
+00187         file_cache c;
+00188         readfile(c,filename.c_str());
+00189         this->fc = c;
+00190 }
 
    
   
 
@@ -149,10 +149,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 216 of file modules.cpp.
+Definition at line 203 of file modules.cpp.
 

-
00217 {
-00218 }
+
00204 {
+00205 }
 
    
   
 
@@ -186,13 +186,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 227 of file modules.cpp.
+Definition at line 214 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00228 {
-00229         return fc.size();
-00230 }
+
00215 {
+00216         return fc.size();
+00217 }
 
    
   
 
@@ -226,15 +226,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 220 of file modules.cpp.
+Definition at line 207 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00221 {
-00222         if ((x<0) || (x>fc.size()))
-00223                 return "";
-00224         return fc[x];
-00225 }
+
00208 {
+00209         if ((x<0) || (x>fc.size()))
+00210                 return "";
+00211         return fc[x];
+00212 }
 
    
   
 
@@ -268,15 +268,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 209 of file modules.cpp.
+Definition at line 196 of file modules.cpp.
 

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

-
00210 {
-00211         file_cache c;
-00212         readfile(c,filename.c_str());
-00213         this->fc = c;
-00214 }
+
00197 {
+00198         file_cache c;
+00199         readfile(c,filename.c_str());
+00200         this->fc = c;
+00201 }
 
    
   
 
@@ -287,7 +287,7 @@ References fc, and 
       
-          

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

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

-Definition at line 284 of file modules.h.
+Definition at line 265 of file modules.h.
 

-Referenced by FileReader(), FileSize(), GetLine(), and LoadFile().    
+Referenced by FileReader(), FileSize(), GetLine(), and LoadFile().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Mon Jan 27 00:23:13 2003 for InspIRCd by
+
Generated on Sun Feb 9 12:48:18 2003 for InspIRCd by
 
 doxygen1.3-rc2 

-- 
cgit v1.2.3