From a96514c284514116300794696f062c7fa6b1f79f Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 19:17:41 +0000 Subject: Added new docs for class InspIRCd and globals.h etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2451 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 84 ++++++++++++++++++------------------ 1 file changed, 42 insertions(+), 42 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 68ee50110..a0eff7f08 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -43,7 +43,7 @@ Inheritance diagram for FileReader:

 Returns the size of the file in lines.

Private Attributes

-file_cache fc +file_cache fc

Detailed Description

@@ -82,8 +82,8 @@ 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 894 of file modules.cpp.

00895 {
-00896 }
+Definition at line 886 of file modules.cpp.
00887 {
+00888 }
 

 

     
@@ -118,13 +118,13 @@ 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 887 of file modules.cpp.
+Definition at line 879 of file modules.cpp.
 

-References fc.
00888 {
-00889         file_cache c;
-00890         readfile(c,filename.c_str());
-00891         this->fc = c;
-00892 }
+References fc, and readfile().
00880 {
+00881         file_cache c;
+00882         readfile(c,filename.c_str());
+00883         this->fc = c;
+00884 }
 

 

     
@@ -158,8 +158,8 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 906 of file modules.cpp.
00907 {
-00908 }
+Definition at line 898 of file modules.cpp.
00899 {
+00900 }
 

 

     
@@ -194,18 +194,18 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 910 of file modules.cpp.
-

-References fc.
00911 {
-00912         if (fc.size() == 0)
-00913         {
-00914                 return(false);
-00915         }
-00916         else
-00917         {
-00918                 return(true);
-00919         }
-00920 }
+Definition at line 902 of file modules.cpp.
+

+References fc.
00903 {
+00904         if (fc.size() == 0)
+00905         {
+00906                 return(false);
+00907         }
+00908         else
+00909         {
+00910                 return(true);
+00911         }
+00912 }
 

 

     
@@ -239,11 +239,11 @@ 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 929 of file modules.cpp.
+Definition at line 921 of file modules.cpp.
 

-References fc.
00930 {
-00931         return fc.size();
-00932 }
+References fc.
00922 {
+00923         return fc.size();
+00924 }
 

 

     
@@ -278,13 +278,13 @@ 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 922 of file modules.cpp.
+Definition at line 914 of file modules.cpp.
 

-References fc.
00923 {
-00924         if ((x<0) || ((unsigned)x>fc.size()))
-00925                 return "";
-00926         return fc[x];
-00927 }
+References fc.
00915 {
+00916         if ((x<0) || ((unsigned)x>fc.size()))
+00917                 return "";
+00918         return fc[x];
+00919 }
 

 

     
@@ -319,13 +319,13 @@ 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 898 of file modules.cpp.
+Definition at line 890 of file modules.cpp.
 

-References fc.
00899 {
-00900         file_cache c;
-00901         readfile(c,filename.c_str());
-00902         this->fc = c;
-00903 }
+References fc, and readfile().
00891 {
+00892         file_cache c;
+00893         readfile(c,filename.c_str());
+00894         this->fc = c;
+00895 }
 

 

     
@@ -338,7 +338,7 @@ References fc.

       
-          
+          

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

       

     
@@ -356,12 +356,12 @@ References fc.

 Definition at line 1620 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 Dec 14 15:55:48 2005 for InspIRCd by 
+
Generated on Wed Dec 14 19:16:26 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.2.3