From 60a9969b9471dec190d5526b79cb731ea2e1b751 Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 7 Apr 2004 18:21:29 +0000 Subject: Added new documentation git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@424 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 106 +++++++++++++++++------------------ 1 file changed, 53 insertions(+), 53 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 54dfd90e2..000c829b8 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -31,8 +31,8 @@ Inheritance diagram for FileReader:

LoadFile (std::string filename)  Used to load a file.

bool Exists () - Retrieve one line from the file.

std::string GetLine (int x) + Retrieve one line from the file.

int FileSize ()  Returns the size of the file in lines.


Private Attributes

@@ -45,7 +45,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 493 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 522 of file modules.h.

Constructor & Destructor Documentation

@@ -75,10 +75,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 336 of file modules.cpp. +Definition at line 366 of file modules.cpp.

-

00337 {
-00338 }
+
00367 {
+00368 }
@@ -112,15 +112,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 329 of file modules.cpp. +Definition at line 359 of file modules.cpp.

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

-

00330 {
-00331         file_cache c;
-00332         readfile(c,filename.c_str());
-00333         this->fc = c;
-00334 }
+
00360 {
+00361         file_cache c;
+00362         readfile(c,filename.c_str());
+00363         this->fc = c;
+00364 }
 
    
   
 
@@ -153,10 +153,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 348 of file modules.cpp.
+Definition at line 378 of file modules.cpp.
 

-
00349 {
-00350 }
+
00379 {
+00380 }
 
    
   
 
@@ -186,24 +186,22 @@ Definition at line 348
     
 
 

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

-References fc.
+References fc.
 

-
00353 {
-00354         if (fc.size() == 0)
-00355         {
-00356                 return(false);
-00357         }
-00358         else
-00359         {
-00360                 return(true);
-00361         }
-00362 }
+
00383 {
+00384         if (fc.size() == 0)
+00385         {
+00386                 return(false);
+00387         }
+00388         else
+00389         {
+00390                 return(true);
+00391         }
+00392 }
 
    
   
 
@@ -236,13 +234,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 371 of file modules.cpp.
+Definition at line 401 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00372 {
-00373         return fc.size();
-00374 }
+
00402 {
+00403         return fc.size();
+00404 }
 
    
   
 
@@ -272,17 +270,19 @@ References fc.
     
 
 

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

-References fc.
+References fc.
 

-
00365 {
-00366         if ((x<0) || (x>fc.size()))
-00367                 return "";
-00368         return fc[x];
-00369 }
+
00395 {
+00396         if ((x<0) || (x>fc.size()))
+00397                 return "";
+00398         return fc[x];
+00399 }
 
    
   
 
@@ -316,15 +316,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 340 of file modules.cpp.
+Definition at line 370 of file modules.cpp.
 

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

-
00341 {
-00342         file_cache c;
-00343         readfile(c,filename.c_str());
-00344         this->fc = c;
-00345 }
+
00371 {
+00372         file_cache c;
+00373         readfile(c,filename.c_str());
+00374         this->fc = c;
+00375 }
 
    
   
 
@@ -350,14 +350,14 @@ References fc, and 
 
 

-Definition at line 495 of file modules.h.
+Definition at line 524 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 Tue Apr 6 21:13:59 2004 for InspIRCd by
+
Generated on Wed Apr 7 19:20:44 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.3.1-10-gc9f91