From 9c8b44176b47d2186c88743dc1f68023c26d780b Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 4 Apr 2005 18:13:55 +0000 Subject: Added new documentation for ELine class and OnUserPostNick method git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@977 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 96 ++++++++++++++++++------------------ 1 file changed, 48 insertions(+), 48 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 460fb43cf..3055133a9 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -47,7 +47,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 758 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 764 of file modules.h.

Constructor & Destructor Documentation

@@ -77,10 +77,10 @@ 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 729 of file modules.cpp. +Definition at line 730 of file modules.cpp.

-

00730 {
-00731 }
+
00731 {
+00732 }
@@ -114,15 +114,15 @@ 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 722 of file modules.cpp. +Definition at line 723 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00723 {
-00724         file_cache c;
-00725         readfile(c,filename.c_str());
-00726         this->fc = c;
-00727 }
+
00724 {
+00725         file_cache c;
+00726         readfile(c,filename.c_str());
+00727         this->fc = c;
+00728 }
 
    
   
 
@@ -155,10 +155,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 741 of file modules.cpp.
+Definition at line 742 of file modules.cpp.
 

-
00742 {
-00743 }
+
00743 {
+00744 }
 
    
   
 
@@ -192,20 +192,20 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 745 of file modules.cpp.
+Definition at line 746 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00746 {
-00747         if (fc.size() == 0)
-00748         {
-00749                 return(false);
-00750         }
-00751         else
-00752         {
-00753                 return(true);
-00754         }
-00755 }
+
00747 {
+00748         if (fc.size() == 0)
+00749         {
+00750                 return(false);
+00751         }
+00752         else
+00753         {
+00754                 return(true);
+00755         }
+00756 }
 
    
   
 
@@ -238,13 +238,13 @@ 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 764 of file modules.cpp.
+Definition at line 765 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00765 {
-00766         return fc.size();
-00767 }
+
00766 {
+00767         return fc.size();
+00768 }
 
    
   
 
@@ -278,15 +278,15 @@ 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 757 of file modules.cpp.
+Definition at line 758 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00758 {
-00759         if ((x<0) || (x>fc.size()))
-00760                 return "";
-00761         return fc[x];
-00762 }
+
00759 {
+00760         if ((x<0) || (x>fc.size()))
+00761                 return "";
+00762         return fc[x];
+00763 }
 
    
   
 
@@ -320,15 +320,15 @@ 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 733 of file modules.cpp.
+Definition at line 734 of file modules.cpp.
 

-References fc, and file_cache.
+References fc, and file_cache.
 

-
00734 {
-00735         file_cache c;
-00736         readfile(c,filename.c_str());
-00737         this->fc = c;
-00738 }
+
00735 {
+00736         file_cache c;
+00737         readfile(c,filename.c_str());
+00738         this->fc = c;
+00739 }
 
    
   
 
@@ -354,14 +354,14 @@ References fc, and 
 
 

-Definition at line 760 of file modules.h.
+Definition at line 766 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 Sat Apr 2 19:27:05 2005 for InspIRCd by
+
Generated on Mon Apr 4 18:12:52 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.3.1-10-gc9f91