From bc0d192a35489b8f5c42aa381ab2b120957ef770 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 7 May 2005 15:35:21 +0000 Subject: Added final documentation for inspircd Beta 4 git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1322 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 96 ++++++++++++++++++------------------ 1 file changed, 48 insertions(+), 48 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 15bfc3626..1319a66e2 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -47,7 +47,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 1186 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 1236 of file modules.h.

Constructor & Destructor Documentation

@@ -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 988 of file modules.cpp. +Definition at line 1004 of file modules.cpp.

-

00989 {
-00990 }
+
01005 {
+01006 }
@@ -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 981 of file modules.cpp. +Definition at line 997 of file modules.cpp.

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

-

00982 {
-00983         file_cache c;
-00984         readfile(c,filename.c_str());
-00985         this->fc = c;
-00986 }
+
00998 {
+00999         file_cache c;
+01000         readfile(c,filename.c_str());
+01001         this->fc = c;
+01002 }
 
    
   
 
@@ -155,10 +155,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 1000 of file modules.cpp.
+Definition at line 1016 of file modules.cpp.
 

-
01001 {
-01002 }
+
01017 {
+01018 }
 
    
   
 
@@ -192,20 +192,20 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 1004 of file modules.cpp.
+Definition at line 1020 of file modules.cpp.
 

-References fc.
+References fc.
 

-
01005 {
-01006         if (fc.size() == 0)
-01007         {
-01008                 return(false);
-01009         }
-01010         else
-01011         {
-01012                 return(true);
-01013         }
-01014 }
+
01021 {
+01022         if (fc.size() == 0)
+01023         {
+01024                 return(false);
+01025         }
+01026         else
+01027         {
+01028                 return(true);
+01029         }
+01030 }
 
    
   
 
@@ -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 1023 of file modules.cpp.
+Definition at line 1039 of file modules.cpp.
 

-References fc.
+References fc.
 

-
01024 {
-01025         return fc.size();
-01026 }
+
01040 {
+01041         return fc.size();
+01042 }
 
    
   
 
@@ -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 1016 of file modules.cpp.
+Definition at line 1032 of file modules.cpp.
 

-References fc.
+References fc.
 

-
01017 {
-01018         if ((x<0) || (x>fc.size()))
-01019                 return "";
-01020         return fc[x];
-01021 }
+
01033 {
+01034         if ((x<0) || (x>fc.size()))
+01035                 return "";
+01036         return fc[x];
+01037 }
 
    
   
 
@@ -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 992 of file modules.cpp.
+Definition at line 1008 of file modules.cpp.
 

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

-
00993 {
-00994         file_cache c;
-00995         readfile(c,filename.c_str());
-00996         this->fc = c;
-00997 }
+
01009 {
+01010         file_cache c;
+01011         readfile(c,filename.c_str());
+01012         this->fc = c;
+01013 }
 
    
   
 
@@ -354,14 +354,14 @@ References fc, and 
 
 

-Definition at line 1188 of file modules.h.
+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 Tue Apr 26 17:11:48 2005 for InspIRCd by
+
Generated on Sat May 7 15:34:25 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.3.1-10-gc9f91