From cc61d20faae9a29422d34a367db9ac54d8de3d0e Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 23 Jan 2003 20:38:00 +0000 Subject: Updated documentation scripts git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@143 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 72 ++++++++++++++++++------------------ 1 file changed, 36 insertions(+), 36 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index ee84a6d74..9b2a4f528 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -36,7 +36,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 271 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 277 of file modules.h.

Constructor & Destructor Documentation

@@ -66,10 +66,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 202 of file modules.cpp. +Definition at line 205 of file modules.cpp.

-

00203 {
-00204 }
+
00206 {
+00207 }
 
@@ -103,15 +103,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 195 of file modules.cpp. +Definition at line 198 of file modules.cpp.

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

-

00196 {
-00197         file_cache c;
-00198         readfile(c,filename.c_str());
-00199         this->fc = c;
-00200 }
+
00199 {
+00200         file_cache c;
+00201         readfile(c,filename.c_str());
+00202         this->fc = c;
+00203 }
 
@@ -144,10 +144,10 @@ Default destructor.

This deletes the memory allocated to the file.

-Definition at line 213 of file modules.cpp. +Definition at line 216 of file modules.cpp.

-

00214 {
-00215 }
+
00217 {
+00218 }
 
@@ -181,13 +181,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 224 of file modules.cpp. +Definition at line 227 of file modules.cpp.

-References fc. +References fc.

-

00225 {
-00226         return fc.size();
-00227 }
+
00228 {
+00229         return fc.size();
+00230 }
 
@@ -221,15 +221,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 217 of file modules.cpp. +Definition at line 220 of file modules.cpp.

-References fc. +References fc.

-

00218 {
-00219         if ((x<0) || (x>fc.size()))
-00220                 return "";
-00221         return fc[x];
-00222 }
+
00221 {
+00222         if ((x<0) || (x>fc.size()))
+00223                 return "";
+00224         return fc[x];
+00225 }
 
@@ -263,15 +263,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 206 of file modules.cpp. +Definition at line 209 of file modules.cpp.

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

-

00207 {
-00208         file_cache c;
-00209         readfile(c,filename.c_str());
-00210         this->fc = c;
-00211 }
+
00210 {
+00211         file_cache c;
+00212         readfile(c,filename.c_str());
+00213         this->fc = c;
+00214 }
 
@@ -297,14 +297,14 @@ References fc, and

-Definition at line 273 of file modules.h. +Definition at line 279 of file modules.h.

-Referenced by FileReader(), FileSize(), GetLine(), and LoadFile(). +Referenced by FileReader(), FileSize(), GetLine(), and LoadFile().


The documentation for this class was generated from the following files: -
Generated on Wed Jan 22 20:56:48 2003 for InspIRCd by +
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by doxygen1.3-rc2
-- cgit v1.3.1-10-gc9f91