From 78a96055c428d1970ece93dfb01902ac0d1699bd Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 4 Apr 2004 22:03:32 +0000 Subject: New documentation to document user/channel mode handling git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@380 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 98 ++++++++++++++++++------------------ 1 file changed, 49 insertions(+), 49 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index b44d63b9b..efd44913b 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -5,7 +5,7 @@
-Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

FileReader Class Reference

Caches a text file into memory and can be used to retrieve lines from it. More...

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

-Definition at line 402 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 403 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 276 of file modules.cpp. +Definition at line 305 of file modules.cpp.

-

00277 {
-00278 }
+
00306 {
+00307 }
@@ -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 269 of file modules.cpp. +Definition at line 298 of file modules.cpp.

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

-

00270 {
-00271         file_cache c;
-00272         readfile(c,filename.c_str());
-00273         this->fc = c;
-00274 }
+
00299 {
+00300         file_cache c;
+00301         readfile(c,filename.c_str());
+00302         this->fc = c;
+00303 }
 
    
   
 
@@ -153,10 +153,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 288 of file modules.cpp.
+Definition at line 317 of file modules.cpp.
 

-
00289 {
-00290 }
+
00318 {
+00319 }
 
    
   
 
@@ -190,20 +190,20 @@ 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 292 of file modules.cpp.
+Definition at line 321 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00293 {
-00294         if (fc.size() == 0)
-00295         {
-00296                 return(false);
-00297         }
-00298         else
-00299         {
-00300                 return(true);
-00301         }
-00302 }
+
00322 {
+00323         if (fc.size() == 0)
+00324         {
+00325                 return(false);
+00326         }
+00327         else
+00328         {
+00329                 return(true);
+00330         }
+00331 }
 
    
   
 
@@ -236,13 +236,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 311 of file modules.cpp.
+Definition at line 340 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00312 {
-00313         return fc.size();
-00314 }
+
00341 {
+00342         return fc.size();
+00343 }
 
    
   
 
@@ -274,15 +274,15 @@ References fc.
 

 
 

-Definition at line 304 of file modules.cpp.
+Definition at line 333 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00305 {
-00306         if ((x<0) || (x>fc.size()))
-00307                 return "";
-00308         return fc[x];
-00309 }
+
00334 {
+00335         if ((x<0) || (x>fc.size()))
+00336                 return "";
+00337         return fc[x];
+00338 }
 
    
   
 
@@ -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 280 of file modules.cpp.
+Definition at line 309 of file modules.cpp.
 

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

-
00281 {
-00282         file_cache c;
-00283         readfile(c,filename.c_str());
-00284         this->fc = c;
-00285 }
+
00310 {
+00311         file_cache c;
+00312         readfile(c,filename.c_str());
+00313         this->fc = c;
+00314 }
 
    
   
 
@@ -350,14 +350,14 @@ References fc, and 
 
 

-Definition at line 404 of file modules.h.
+Definition at line 405 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 3 16:36:14 2004 for InspIRCd by
+
Generated on Sun Apr 4 23:02:27 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.3.1-10-gc9f91