From 4d5a17380bc71cabe544b41c7c8a26a292384f3d Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 15 May 2005 17:05:15 +0000 Subject: Added docs for hashcomp git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1396 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 d9be72a02..646b92de9 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -4,7 +4,7 @@ -
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

FileReader Class Reference

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

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

-Definition at line 1236 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 1239 of file modules.h.

Constructor & Destructor Documentation

@@ -83,10 +83,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 1023 of file modules.cpp. +Definition at line 952 of file modules.cpp.

-

01024 {
-01025 }
+
00953 {
+00954 }
@@ -120,15 +120,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 1016 of file modules.cpp. +Definition at line 945 of file modules.cpp.

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

-

01017 {
-01018         file_cache c;
-01019         readfile(c,filename.c_str());
-01020         this->fc = c;
-01021 }
+
00946 {
+00947         file_cache c;
+00948         readfile(c,filename.c_str());
+00949         this->fc = c;
+00950 }
 
    
   
 
@@ -161,10 +161,10 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 1035 of file modules.cpp.
+Definition at line 964 of file modules.cpp.
 

-
01036 {
-01037 }
+
00965 {
+00966 }
 
    
   
 
@@ -198,20 +198,20 @@ Returns true if the file exists This function will return false if the file coul
 

 
 

-Definition at line 1039 of file modules.cpp.
+Definition at line 968 of file modules.cpp.
 

-References fc.
+References fc.
 

-
01040 {
-01041         if (fc.size() == 0)
-01042         {
-01043                 return(false);
-01044         }
-01045         else
-01046         {
-01047                 return(true);
-01048         }
-01049 }
+
00969 {
+00970         if (fc.size() == 0)
+00971         {
+00972                 return(false);
+00973         }
+00974         else
+00975         {
+00976                 return(true);
+00977         }
+00978 }
 
    
   
 
@@ -244,13 +244,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 1058 of file modules.cpp.
+Definition at line 987 of file modules.cpp.
 

-References fc.
+References fc.
 

-
01059 {
-01060         return fc.size();
-01061 }
+
00988 {
+00989         return fc.size();
+00990 }
 
    
   
 
@@ -284,15 +284,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 1051 of file modules.cpp.
+Definition at line 980 of file modules.cpp.
 

-References fc.
+References fc.
 

-
01052 {
-01053         if ((x<0) || (x>fc.size()))
-01054                 return "";
-01055         return fc[x];
-01056 }
+
00981 {
+00982         if ((x<0) || (x>fc.size()))
+00983                 return "";
+00984         return fc[x];
+00985 }
 
    
   
 
@@ -326,15 +326,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 1027 of file modules.cpp.
+Definition at line 956 of file modules.cpp.
 

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

-
01028 {
-01029         file_cache c;
-01030         readfile(c,filename.c_str());
-01031         this->fc = c;
-01032 }
+
00957 {
+00958         file_cache c;
+00959         readfile(c,filename.c_str());
+00960         this->fc = c;
+00961 }
 
    
   
 
@@ -360,14 +360,14 @@ References fc, and 
 
 

-Definition at line 1238 of file modules.h.
+Definition at line 1241 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 Fri May 13 15:49:38 2005 for InspIRCd by
+
Generated on Sun May 15 17:03:26 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3