From 3f4b15c2cfe51a654b5167273f5a95b29e757cf1 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 14 Apr 2005 21:13:24 +0000 Subject: New documentation on today's new methods etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1096 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 d966d1e3a..355ce9f4e 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 879 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 924 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 828 of file modules.cpp. +Definition at line 861 of file modules.cpp.

-

00829 {
-00830 }
+
00862 {
+00863 }
@@ -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 821 of file modules.cpp. +Definition at line 854 of file modules.cpp.

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

-

00822 {
-00823         file_cache c;
-00824         readfile(c,filename.c_str());
-00825         this->fc = c;
-00826 }
+
00855 {
+00856         file_cache c;
+00857         readfile(c,filename.c_str());
+00858         this->fc = c;
+00859 }
 
    
   
 
@@ -155,10 +155,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 840 of file modules.cpp.
+Definition at line 873 of file modules.cpp.
 

-
00841 {
-00842 }
+
00874 {
+00875 }
 
    
   
 
@@ -192,20 +192,20 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 844 of file modules.cpp.
+Definition at line 877 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00845 {
-00846         if (fc.size() == 0)
-00847         {
-00848                 return(false);
-00849         }
-00850         else
-00851         {
-00852                 return(true);
-00853         }
-00854 }
+
00878 {
+00879         if (fc.size() == 0)
+00880         {
+00881                 return(false);
+00882         }
+00883         else
+00884         {
+00885                 return(true);
+00886         }
+00887 }
 
    
   
 
@@ -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 863 of file modules.cpp.
+Definition at line 896 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00864 {
-00865         return fc.size();
-00866 }
+
00897 {
+00898         return fc.size();
+00899 }
 
    
   
 
@@ -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 856 of file modules.cpp.
+Definition at line 889 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00857 {
-00858         if ((x<0) || (x>fc.size()))
-00859                 return "";
-00860         return fc[x];
-00861 }
+
00890 {
+00891         if ((x<0) || (x>fc.size()))
+00892                 return "";
+00893         return fc[x];
+00894 }
 
    
   
 
@@ -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 832 of file modules.cpp.
+Definition at line 865 of file modules.cpp.
 

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

-
00833 {
-00834         file_cache c;
-00835         readfile(c,filename.c_str());
-00836         this->fc = c;
-00837 }
+
00866 {
+00867         file_cache c;
+00868         readfile(c,filename.c_str());
+00869         this->fc = c;
+00870 }
 
    
   
 
@@ -354,14 +354,14 @@ References fc, and 
 
 

-Definition at line 881 of file modules.h.
+Definition at line 926 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 13 13:07:04 2005 for InspIRCd by
+
Generated on Thu Apr 14 21:12:09 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3