From b25c31de6b8dd839429cb168f5731a5605e17366 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 24 Apr 2004 23:26:47 +0000 Subject: Added new documentation for XLine etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@718 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 e54355d2e..26685712d 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 557 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 576 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 387 of file modules.cpp. +Definition at line 398 of file modules.cpp.

-

00388 {
-00389 }
+
00399 {
+00400 }
@@ -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 380 of file modules.cpp. +Definition at line 391 of file modules.cpp.

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

-

00381 {
-00382         file_cache c;
-00383         readfile(c,filename.c_str());
-00384         this->fc = c;
-00385 }
+
00392 {
+00393         file_cache c;
+00394         readfile(c,filename.c_str());
+00395         this->fc = c;
+00396 }
 
    
   
 
@@ -154,10 +154,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 399 of file modules.cpp.
+Definition at line 410 of file modules.cpp.
 

-
00400 {
-00401 }
+
00411 {
+00412 }
 
    
   
 
@@ -191,20 +191,20 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 403 of file modules.cpp.
+Definition at line 414 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00404 {
-00405         if (fc.size() == 0)
-00406         {
-00407                 return(false);
-00408         }
-00409         else
-00410         {
-00411                 return(true);
-00412         }
-00413 }
+
00415 {
+00416         if (fc.size() == 0)
+00417         {
+00418                 return(false);
+00419         }
+00420         else
+00421         {
+00422                 return(true);
+00423         }
+00424 }
 
    
   
 
@@ -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 422 of file modules.cpp.
+Definition at line 433 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00423 {
-00424         return fc.size();
-00425 }
+
00434 {
+00435         return fc.size();
+00436 }
 
    
   
 
@@ -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 415 of file modules.cpp.
+Definition at line 426 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00416 {
-00417         if ((x<0) || (x>fc.size()))
-00418                 return "";
-00419         return fc[x];
-00420 }
+
00427 {
+00428         if ((x<0) || (x>fc.size()))
+00429                 return "";
+00430         return fc[x];
+00431 }
 
    
   
 
@@ -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 391 of file modules.cpp.
+Definition at line 402 of file modules.cpp.
 

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

-
00392 {
-00393         file_cache c;
-00394         readfile(c,filename.c_str());
-00395         this->fc = c;
-00396 }
+
00403 {
+00404         file_cache c;
+00405         readfile(c,filename.c_str());
+00406         this->fc = c;
+00407 }
 
    
   
 
@@ -353,14 +353,14 @@ References fc, and 
 
 

-Definition at line 559 of file modules.h.
+Definition at line 578 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 Mon Apr 19 02:34:44 2004 for InspIRCd by
+
Generated on Sun Apr 25 00:24:21 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3