From bab9f4b4bc0f6aa0e1377745fd216ef9874b3f27 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 9 Dec 2005 20:21:39 +0000 Subject: Added new module docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2301 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 6141b3c73..afa717b3b 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 1210 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 1599 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 950 of file modules.cpp.

00951 {
-00952 }
+Definition at line 988 of file modules.cpp.
00989 {
+00990 }
 

 

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

-References fc.
00944 {
-00945         file_cache c;
-00946         readfile(c,filename.c_str());
-00947         this->fc = c;
-00948 }
+References fc.
00982 {
+00983         file_cache c;
+00984         readfile(c,filename.c_str());
+00985         this->fc = c;
+00986 }
 

 

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

 This deletes the memory allocated to the file.
 

-Definition at line 962 of file modules.cpp.
00963 {
-00964 }
+Definition at line 1000 of file modules.cpp.
01001 {
+01002 }
 

 

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

 
 

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

-References fc.
00967 {
-00968         if (fc.size() == 0)
-00969         {
-00970                 return(false);
-00971         }
-00972         else
-00973         {
-00974                 return(true);
-00975         }
-00976 }
+Definition at line 1004 of file modules.cpp.
+

+References fc.
01005 {
+01006         if (fc.size() == 0)
+01007         {
+01008                 return(false);
+01009         }
+01010         else
+01011         {
+01012                 return(true);
+01013         }
+01014 }
 

 

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

-References fc.
00986 {
-00987         return fc.size();
-00988 }
+References fc.
01024 {
+01025         return fc.size();
+01026 }
 

 

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

-References fc.
00979 {
-00980         if ((x<0) || ((unsigned)x>fc.size()))
-00981                 return "";
-00982         return fc[x];
-00983 }
+References fc.
01017 {
+01018         if ((x<0) || ((unsigned)x>fc.size()))
+01019                 return "";
+01020         return fc[x];
+01021 }
 

 

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

-References fc.
00955 {
-00956         file_cache c;
-00957         readfile(c,filename.c_str());
-00958         this->fc = c;
-00959 }
+References fc.
00993 {
+00994         file_cache c;
+00995         readfile(c,filename.c_str());
+00996         this->fc = c;
+00997 }
 

 

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

 
 

-Definition at line 1212 of file modules.h.
+Definition at line 1601 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 Sun Nov 27 01:43:25 2005 for InspIRCd by  +
Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3