From 74e9276df9d67147885dd2a11b1c23913c9c94f1 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 19 Apr 2004 01:36:09 +0000 Subject: Documentation update git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@668 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 82 ++++++++++++++++++------------------ 1 file changed, 41 insertions(+), 41 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 62e7ec1c7..e54355d2e 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -76,10 +76,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 385 of file modules.cpp. +Definition at line 387 of file modules.cpp.

-

00386 {
-00387 }
+
00388 {
+00389 }
 
@@ -113,15 +113,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 378 of file modules.cpp. +Definition at line 380 of file modules.cpp.

References fc, and file_cache.

-

00379 {
-00380         file_cache c;
-00381         readfile(c,filename.c_str());
-00382         this->fc = c;
-00383 }
+
00381 {
+00382         file_cache c;
+00383         readfile(c,filename.c_str());
+00384         this->fc = c;
+00385 }
 
@@ -154,10 +154,10 @@ Default destructor.

This deletes the memory allocated to the file.

-Definition at line 397 of file modules.cpp. +Definition at line 399 of file modules.cpp.

-

00398 {
-00399 }
+
00400 {
+00401 }
 
@@ -191,20 +191,20 @@ Returns true if the file exists This function will return false if the file coul

-Definition at line 401 of file modules.cpp. +Definition at line 403 of file modules.cpp.

References fc.

-

00402 {
-00403         if (fc.size() == 0)
-00404         {
-00405                 return(false);
-00406         }
-00407         else
-00408         {
-00409                 return(true);
-00410         }
-00411 }
+
00404 {
+00405         if (fc.size() == 0)
+00406         {
+00407                 return(false);
+00408         }
+00409         else
+00410         {
+00411                 return(true);
+00412         }
+00413 }
 
@@ -237,13 +237,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 420 of file modules.cpp. +Definition at line 422 of file modules.cpp.

References fc.

-

00421 {
-00422         return fc.size();
-00423 }
+
00423 {
+00424         return fc.size();
+00425 }
 
@@ -277,15 +277,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 413 of file modules.cpp. +Definition at line 415 of file modules.cpp.

References fc.

-

00414 {
-00415         if ((x<0) || (x>fc.size()))
-00416                 return "";
-00417         return fc[x];
-00418 }
+
00416 {
+00417         if ((x<0) || (x>fc.size()))
+00418                 return "";
+00419         return fc[x];
+00420 }
 
@@ -319,15 +319,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 389 of file modules.cpp. +Definition at line 391 of file modules.cpp.

References fc, and file_cache.

-

00390 {
-00391         file_cache c;
-00392         readfile(c,filename.c_str());
-00393         this->fc = c;
-00394 }
+
00392 {
+00393         file_cache c;
+00394         readfile(c,filename.c_str());
+00395         this->fc = c;
+00396 }
 
@@ -355,12 +355,12 @@ References fc, and Definition at line 559 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 17 13:33:55 2004 for InspIRCd by +
Generated on Mon Apr 19 02:34:44 2004 for InspIRCd by doxygen1.3-rc3
-- cgit v1.3.1-10-gc9f91