From 03be04a9a2d86a4568d09d5e1689dd7ef37c863a Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 14:52:12 +0000 Subject: Added extra docs for new config system git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2417 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 093fa1d67..04c1c960b 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -53,7 +53,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 1599 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 1614 of file modules.h.

Constructor & Destructor Documentation

@@ -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 961 of file modules.cpp.

00962 {
-00963 }
+Definition at line 889 of file modules.cpp.
00890 {
+00891 }
 

 

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

-References fc.
00955 {
-00956         file_cache c;
-00957         readfile(c,filename.c_str());
-00958         this->fc = c;
-00959 }
+References fc.
00883 {
+00884         file_cache c;
+00885         readfile(c,filename.c_str());
+00886         this->fc = c;
+00887 }
 

 

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

 This deletes the memory allocated to the file.
 

-Definition at line 973 of file modules.cpp.
00974 {
-00975 }
+Definition at line 901 of file modules.cpp.
00902 {
+00903 }
 

 

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

 
 

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

-References fc.
00978 {
-00979         if (fc.size() == 0)
-00980         {
-00981                 return(false);
-00982         }
-00983         else
-00984         {
-00985                 return(true);
-00986         }
-00987 }
+Definition at line 905 of file modules.cpp.
+

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

 

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

-References fc.
00997 {
-00998         return fc.size();
-00999 }
+References fc.
00925 {
+00926         return fc.size();
+00927 }
 

 

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

-References fc.
00990 {
-00991         if ((x<0) || ((unsigned)x>fc.size()))
-00992                 return "";
-00993         return fc[x];
-00994 }
+References fc.
00918 {
+00919         if ((x<0) || ((unsigned)x>fc.size()))
+00920                 return "";
+00921         return fc[x];
+00922 }
 

 

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

-References fc.
00966 {
-00967         file_cache c;
-00968         readfile(c,filename.c_str());
-00969         this->fc = c;
-00970 }
+References fc.
00894 {
+00895         file_cache c;
+00896         readfile(c,filename.c_str());
+00897         this->fc = c;
+00898 }
 

 

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

 
 

-Definition at line 1601 of file modules.h.
+Definition at line 1616 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 Dec 12 18:31:02 2005 for InspIRCd by  +
Generated on Wed Dec 14 14:49:31 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3