From afb51347b493a6ab54fcc8595b4a3f46972ce18f Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 17 Apr 2004 12:33:39 +0000 Subject: Added new documentation to cover ircd_connector git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@629 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 3ca670a48..ed114b8d9 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 529 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 557 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 370 of file modules.cpp. +Definition at line 385 of file modules.cpp.

-

00371 {
-00372 }
+
00386 {
+00387 }
@@ -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 363 of file modules.cpp. +Definition at line 378 of file modules.cpp.

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

-

00364 {
-00365         file_cache c;
-00366         readfile(c,filename.c_str());
-00367         this->fc = c;
-00368 }
+
00379 {
+00380         file_cache c;
+00381         readfile(c,filename.c_str());
+00382         this->fc = c;
+00383 }
 
    
   
 
@@ -154,10 +154,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 382 of file modules.cpp.
+Definition at line 397 of file modules.cpp.
 

-
00383 {
-00384 }
+
00398 {
+00399 }
 
    
   
 
@@ -191,20 +191,20 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 386 of file modules.cpp.
+Definition at line 401 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00387 {
-00388         if (fc.size() == 0)
-00389         {
-00390                 return(false);
-00391         }
-00392         else
-00393         {
-00394                 return(true);
-00395         }
-00396 }
+
00402 {
+00403         if (fc.size() == 0)
+00404         {
+00405                 return(false);
+00406         }
+00407         else
+00408         {
+00409                 return(true);
+00410         }
+00411 }
 
    
   
 
@@ -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 405 of file modules.cpp.
+Definition at line 420 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00406 {
-00407         return fc.size();
-00408 }
+
00421 {
+00422         return fc.size();
+00423 }
 
    
   
 
@@ -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 398 of file modules.cpp.
+Definition at line 413 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00399 {
-00400         if ((x<0) || (x>fc.size()))
-00401                 return "";
-00402         return fc[x];
-00403 }
+
00414 {
+00415         if ((x<0) || (x>fc.size()))
+00416                 return "";
+00417         return fc[x];
+00418 }
 
    
   
 
@@ -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 374 of file modules.cpp.
+Definition at line 389 of file modules.cpp.
 

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

-
00375 {
-00376         file_cache c;
-00377         readfile(c,filename.c_str());
-00378         this->fc = c;
-00379 }
+
00390 {
+00391         file_cache c;
+00392         readfile(c,filename.c_str());
+00393         this->fc = c;
+00394 }
 
    
   
 
@@ -353,14 +353,14 @@ References fc, and 
 
 

-Definition at line 531 of file modules.h.
+Definition at line 559 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 Thu Apr 8 19:13:03 2004 for InspIRCd by
+
Generated on Sat Apr 17 13:31:50 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3