From e0db7b0d2f777361c8194c5820bb2f6e44c55204 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 15 Dec 2005 11:15:09 +0000 Subject: Added documentation for CullItem and CullList git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2466 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 a0eff7f08..e5a725a26 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 1618 of file modules.h.

Constructor & Destructor Documentation

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

00887 {
-00888 }
+Definition at line 891 of file modules.cpp.
00892 {
+00893 }
 

 

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

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

 

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

 This deletes the memory allocated to the file.
 

-Definition at line 898 of file modules.cpp.
00899 {
-00900 }
+Definition at line 903 of file modules.cpp.
00904 {
+00905 }
 

 

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

 
 

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

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

 

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

-References fc.
00922 {
-00923         return fc.size();
-00924 }
+References fc.
00927 {
+00928         return fc.size();
+00929 }
 

 

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

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

 

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

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

 

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

-Definition at line 1620 of file modules.h.
+Definition at line 1623 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 19:16:26 2005 for InspIRCd by  +
Generated on Thu Dec 15 11:14:18 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.3.1-10-gc9f91