From 755d67224f033aaa9b4ef3d2dd00f46bb8c19dc2 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 7 Apr 2005 20:15:05 +0000 Subject: New docs to match extra module Version class stuff, etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1008 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 3055133a9..486a4d4ab 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -37,7 +37,7 @@ Inherits classbase.  Returns the size of the file in lines.


Private Attributes

-file_cache fc +file_cache fc

Detailed Description

@@ -47,7 +47,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 764 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 774 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 730 of file modules.cpp. +Definition at line 732 of file modules.cpp.

-

00731 {
-00732 }
+
00733 {
+00734 }
@@ -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 723 of file modules.cpp. +Definition at line 725 of file modules.cpp.

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

-

00724 {
-00725         file_cache c;
-00726         readfile(c,filename.c_str());
-00727         this->fc = c;
-00728 }
+
00726 {
+00727         file_cache c;
+00728         readfile(c,filename.c_str());
+00729         this->fc = c;
+00730 }
 
    
   
 
@@ -155,10 +155,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 742 of file modules.cpp.
+Definition at line 744 of file modules.cpp.
 

-
00743 {
-00744 }
+
00745 {
+00746 }
 
    
   
 
@@ -192,20 +192,20 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 746 of file modules.cpp.
+Definition at line 748 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00747 {
-00748         if (fc.size() == 0)
-00749         {
-00750                 return(false);
-00751         }
-00752         else
-00753         {
-00754                 return(true);
-00755         }
-00756 }
+
00749 {
+00750         if (fc.size() == 0)
+00751         {
+00752                 return(false);
+00753         }
+00754         else
+00755         {
+00756                 return(true);
+00757         }
+00758 }
 
    
   
 
@@ -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 765 of file modules.cpp.
+Definition at line 767 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00766 {
-00767         return fc.size();
-00768 }
+
00768 {
+00769         return fc.size();
+00770 }
 
    
   
 
@@ -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 758 of file modules.cpp.
+Definition at line 760 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00759 {
-00760         if ((x<0) || (x>fc.size()))
-00761                 return "";
-00762         return fc[x];
-00763 }
+
00761 {
+00762         if ((x<0) || (x>fc.size()))
+00763                 return "";
+00764         return fc[x];
+00765 }
 
    
   
 
@@ -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 734 of file modules.cpp.
+Definition at line 736 of file modules.cpp.
 

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

-
00735 {
-00736         file_cache c;
-00737         readfile(c,filename.c_str());
-00738         this->fc = c;
-00739 }
+
00737 {
+00738         file_cache c;
+00739         readfile(c,filename.c_str());
+00740         this->fc = c;
+00741 }
 
    
   
 
@@ -339,7 +339,7 @@ References fc, and 
       
-          

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

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

-Definition at line 766 of file modules.h.
+Definition at line 776 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 Mon Apr 4 18:12:52 2005 for InspIRCd by
+
Generated on Thu Apr 7 20:14:24 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.3.1-10-gc9f91