From 877a15fc3db18be9131c886720516eae6f582886 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 1 May 2004 16:54:50 +0000 Subject: Added extra docs to cover OnUserSync etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@769 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 4d53881cf..fc98c5761 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -46,7 +46,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 648 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 672 of file modules.h.

Constructor & Destructor Documentation

@@ -76,10 +76,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 440 of file modules.cpp. +Definition at line 608 of file modules.cpp.

-

00441 {
-00442 }
+
00609 {
+00610 }
@@ -113,15 +113,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 433 of file modules.cpp. +Definition at line 601 of file modules.cpp.

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

-

00434 {
-00435         file_cache c;
-00436         readfile(c,filename.c_str());
-00437         this->fc = c;
-00438 }
+
00602 {
+00603         file_cache c;
+00604         readfile(c,filename.c_str());
+00605         this->fc = c;
+00606 }
 
    
   
 
@@ -154,10 +154,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 452 of file modules.cpp.
+Definition at line 620 of file modules.cpp.
 

-
00453 {
-00454 }
+
00621 {
+00622 }
 
    
   
 
@@ -191,20 +191,20 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 456 of file modules.cpp.
+Definition at line 624 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00457 {
-00458         if (fc.size() == 0)
-00459         {
-00460                 return(false);
-00461         }
-00462         else
-00463         {
-00464                 return(true);
-00465         }
-00466 }
+
00625 {
+00626         if (fc.size() == 0)
+00627         {
+00628                 return(false);
+00629         }
+00630         else
+00631         {
+00632                 return(true);
+00633         }
+00634 }
 
    
   
 
@@ -237,13 +237,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 475 of file modules.cpp.
+Definition at line 643 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00476 {
-00477         return fc.size();
-00478 }
+
00644 {
+00645         return fc.size();
+00646 }
 
    
   
 
@@ -277,15 +277,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 468 of file modules.cpp.
+Definition at line 636 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00469 {
-00470         if ((x<0) || (x>fc.size()))
-00471                 return "";
-00472         return fc[x];
-00473 }
+
00637 {
+00638         if ((x<0) || (x>fc.size()))
+00639                 return "";
+00640         return fc[x];
+00641 }
 
    
   
 
@@ -319,15 +319,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 444 of file modules.cpp.
+Definition at line 612 of file modules.cpp.
 

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

-
00445 {
-00446         file_cache c;
-00447         readfile(c,filename.c_str());
-00448         this->fc = c;
-00449 }
+
00613 {
+00614         file_cache c;
+00615         readfile(c,filename.c_str());
+00616         this->fc = c;
+00617 }
 
    
   
 
@@ -353,14 +353,14 @@ References fc, and 
 
 

-Definition at line 650 of file modules.h.
+Definition at line 674 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 May 1 13:39:17 2004 for InspIRCd by
+
Generated on Sat May 1 17:50:26 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3