From 88dd74fc84b574f17673338c6d42123570f464da Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 12 May 2005 23:06:51 +0000 Subject: Added docs for new smaller memory footprint classes git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1371 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 82 ++++++++++++++++++------------------ 1 file changed, 41 insertions(+), 41 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 1b1d55845..a10a40e3f 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -77,10 +77,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 1022 of file modules.cpp. +Definition at line 1023 of file modules.cpp.

-

01023 {
-01024 }
+
01024 {
+01025 }
 
    
   
 
@@ -114,15 +114,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 1015 of file modules.cpp.
+Definition at line 1016 of file modules.cpp.
 

 References fc, and file_cache.
 

-
01016 {
-01017         file_cache c;
-01018         readfile(c,filename.c_str());
-01019         this->fc = c;
-01020 }
+
01017 {
+01018         file_cache c;
+01019         readfile(c,filename.c_str());
+01020         this->fc = c;
+01021 }
 
    
   
 
@@ -155,10 +155,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 1034 of file modules.cpp.
+Definition at line 1035 of file modules.cpp.
 

-
01035 {
-01036 }
+
01036 {
+01037 }
 
    
   
 
@@ -192,20 +192,20 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 1038 of file modules.cpp.
+Definition at line 1039 of file modules.cpp.
 

 References fc.
 

-
01039 {
-01040         if (fc.size() == 0)
-01041         {
-01042                 return(false);
-01043         }
-01044         else
-01045         {
-01046                 return(true);
-01047         }
-01048 }
+
01040 {
+01041         if (fc.size() == 0)
+01042         {
+01043                 return(false);
+01044         }
+01045         else
+01046         {
+01047                 return(true);
+01048         }
+01049 }
 
    
   
 
@@ -238,13 +238,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 1057 of file modules.cpp.
+Definition at line 1058 of file modules.cpp.
 

 References fc.
 

-
01058 {
-01059         return fc.size();
-01060 }
+
01059 {
+01060         return fc.size();
+01061 }
 
    
   
 
@@ -278,15 +278,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 1050 of file modules.cpp.
+Definition at line 1051 of file modules.cpp.
 

 References fc.
 

-
01051 {
-01052         if ((x<0) || (x>fc.size()))
-01053                 return "";
-01054         return fc[x];
-01055 }
+
01052 {
+01053         if ((x<0) || (x>fc.size()))
+01054                 return "";
+01055         return fc[x];
+01056 }
 
    
   
 
@@ -320,15 +320,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 1026 of file modules.cpp.
+Definition at line 1027 of file modules.cpp.
 

 References fc, and file_cache.
 

-
01027 {
-01028         file_cache c;
-01029         readfile(c,filename.c_str());
-01030         this->fc = c;
-01031 }
+
01028 {
+01029         file_cache c;
+01030         readfile(c,filename.c_str());
+01031         this->fc = c;
+01032 }
 
    
   
 
@@ -356,12 +356,12 @@ References fc, and 
 Definition at line 1238 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 Thu May 12 02:25:21 2005 for InspIRCd by
+
Generated on Thu May 12 22:59:02 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3