From 097b2479d0393d8a8bada4a50708d7a2404045ca Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 12 Dec 2005 13:32:15 +0000 Subject: Added new docs for class SocketEngine git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2339 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 80 ++++++++++++++++++------------------ 1 file changed, 40 insertions(+), 40 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index afa717b3b..26db36d52 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -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 988 of file modules.cpp.

00989 {
-00990 }
+Definition at line 961 of file modules.cpp.
00962 {
+00963 }
 

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

-References fc.

00982 {
-00983         file_cache c;
-00984         readfile(c,filename.c_str());
-00985         this->fc = c;
-00986 }
+References fc.
00955 {
+00956         file_cache c;
+00957         readfile(c,filename.c_str());
+00958         this->fc = c;
+00959 }
 

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

This deletes the memory allocated to the file.

-Definition at line 1000 of file modules.cpp.

01001 {
-01002 }
+Definition at line 973 of file modules.cpp.
00974 {
+00975 }
 

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

-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 }
+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 }
 

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

-References fc.

01024 {
-01025         return fc.size();
-01026 }
+References fc.
00997 {
+00998         return fc.size();
+00999 }
 

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

-References fc.

01017 {
-01018         if ((x<0) || ((unsigned)x>fc.size()))
-01019                 return "";
-01020         return fc[x];
-01021 }
+References fc.
00990 {
+00991         if ((x<0) || ((unsigned)x>fc.size()))
+00992                 return "";
+00993         return fc[x];
+00994 }
 

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

-References fc.

00993 {
-00994         file_cache c;
-00995         readfile(c,filename.c_str());
-00996         this->fc = c;
-00997 }
+References fc.
00966 {
+00967         file_cache c;
+00968         readfile(c,filename.c_str());
+00969         this->fc = c;
+00970 }
 

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

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 Fri Dec 9 20:20:11 2005 for InspIRCd by  +
Generated on Mon Dec 12 13:31:12 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3