From 1ea860b5708d065f9ed51234fc031969215fd806 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 2 Apr 2004 13:47:31 +0000 Subject: Updated documentation to document Server::SendMode git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@356 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 92 ++++++++++++++++++------------------ 1 file changed, 46 insertions(+), 46 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index d2ba2399b..75ff67749 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -45,7 +45,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 347 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 367 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 265 of file modules.cpp. +Definition at line 269 of file modules.cpp.

-

00266 {
-00267 }
+
00270 {
+00271 }
 
@@ -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 258 of file modules.cpp. +Definition at line 262 of file modules.cpp.

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

-

00259 {
-00260         file_cache c;
-00261         readfile(c,filename.c_str());
-00262         this->fc = c;
-00263 }
+
00263 {
+00264         file_cache c;
+00265         readfile(c,filename.c_str());
+00266         this->fc = c;
+00267 }
 
@@ -153,10 +153,10 @@ Default destructor.

This deletes the memory allocated to the file.

-Definition at line 277 of file modules.cpp. +Definition at line 281 of file modules.cpp.

-

00278 {
-00279 }
+
00282 {
+00283 }
 
@@ -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 281 of file modules.cpp. +Definition at line 285 of file modules.cpp.

-References fc. +References fc.

-

00282 {
-00283         if (fc.size() == 0)
-00284         {
-00285                 return(false);
-00286         }
-00287         else
+
00286 {
+00287         if (fc.size() == 0)
 00288         {
-00289                 return(true);
+00289                 return(false);
 00290         }
-00291 }
+00291         else
+00292         {
+00293                 return(true);
+00294         }
+00295 }
 
@@ -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 300 of file modules.cpp. +Definition at line 304 of file modules.cpp.

-References fc. +References fc.

-

00301 {
-00302         return fc.size();
-00303 }
+
00305 {
+00306         return fc.size();
+00307 }
 
@@ -274,15 +274,15 @@ References fc.

-Definition at line 293 of file modules.cpp. +Definition at line 297 of file modules.cpp.

-References fc. +References fc.

-

00294 {
-00295         if ((x<0) || (x>fc.size()))
-00296                 return "";
-00297         return fc[x];
-00298 }
+
00298 {
+00299         if ((x<0) || (x>fc.size()))
+00300                 return "";
+00301         return fc[x];
+00302 }
 
@@ -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 269 of file modules.cpp. +Definition at line 273 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 }
+
00274 {
+00275         file_cache c;
+00276         readfile(c,filename.c_str());
+00277         this->fc = c;
+00278 }
 
@@ -350,14 +350,14 @@ References fc, and

-Definition at line 349 of file modules.h. +Definition at line 369 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 Apr 2 13:37:39 2004 for InspIRCd by +
Generated on Fri Apr 2 14:46:16 2004 for InspIRCd by doxygen1.3-rc3
-- cgit v1.2.3