From a96514c284514116300794696f062c7fa6b1f79f Mon Sep 17 00:00:00 2001
From: brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>
Date: Wed, 14 Dec 2005 19:17:41 +0000
Subject: Added new docs for class InspIRCd and globals.h etc

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2451 e03df62e-2008-0410-955e-edbf42e46eb7
---
 docs/man/man3/FileReader.3 | 82 +++++++++++++++++++++++-----------------------
 1 file changed, 41 insertions(+), 41 deletions(-)

(limited to 'docs/man/man3/FileReader.3')

diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3
index f9688416d..ee136db97 100644
--- a/docs/man/man3/FileReader.3
+++ b/docs/man/man3/FileReader.3
@@ -66,11 +66,11 @@ Default constructor.
 .PP
 This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.
 .PP
-Definition at line 894 of file modules.cpp.
+Definition at line 886 of file modules.cpp.
 .PP
 .nf
-895 {
-896 }
+887 {
+888 }
 .fi
 .PP
 .SS "FileReader::FileReader (\fBstd::string\fP filename)"
@@ -79,16 +79,16 @@ Secondary constructor.
 .PP
 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, \fBFileReader::FileSize\fP returns 0.
 .PP
-Definition at line 887 of file modules.cpp.
+Definition at line 879 of file modules.cpp.
 .PP
-References fc.
+References fc, and readfile().
 .PP
 .nf
-888 {
-889         file_cache c;
-890         readfile(c,filename.c_str());
-891         this->fc = c;
-892 }
+880 {
+881         file_cache c;
+882         readfile(c,filename.c_str());
+883         this->fc = c;
+884 }
 .fi
 .PP
 .SS "FileReader::~FileReader ()"
@@ -97,11 +97,11 @@ Default destructor.
 .PP
 This deletes the memory allocated to the file.
 .PP
-Definition at line 906 of file modules.cpp.
+Definition at line 898 of file modules.cpp.
 .PP
 .nf
-907 {
-908 }
+899 {
+900 }
 .fi
 .PP
 .SH "Member Function Documentation"
@@ -110,21 +110,21 @@ Definition at line 906 of file modules.cpp.
 .PP
 Returns true if the file exists This function will return false if the file could not be opened. 
 .PP
-Definition at line 910 of file modules.cpp.
+Definition at line 902 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-911 {
-912         if (fc.size() == 0)
-913         {
-914                 return(false);
-915         }
-916         else
-917         {
-918                 return(true);
-919         }
-920 }
+903 {
+904         if (fc.size() == 0)
+905         {
+906                 return(false);
+907         }
+908         else
+909         {
+910                 return(true);
+911         }
+912 }
 .fi
 .PP
 .SS "int FileReader::FileSize ()"
@@ -133,14 +133,14 @@ Returns the size of the file in lines.
 .PP
 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.
 .PP
-Definition at line 929 of file modules.cpp.
+Definition at line 921 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-930 {
-931         return fc.size();
-932 }
+922 {
+923         return fc.size();
+924 }
 .fi
 .PP
 .SS "\fBstd::string\fP FileReader::GetLine (int x)"
@@ -149,16 +149,16 @@ Retrieve one line from the file.
 .PP
 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.
 .PP
-Definition at line 922 of file modules.cpp.
+Definition at line 914 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-923 {
-924         if ((x<0) || ((unsigned)x>fc.size()))
-925                 return '';
-926         return fc[x];
-927 }
+915 {
+916         if ((x<0) || ((unsigned)x>fc.size()))
+917                 return '';
+918         return fc[x];
+919 }
 .fi
 .PP
 .SS "void FileReader::LoadFile (\fBstd::string\fP filename)"
@@ -167,16 +167,16 @@ Used to load a file.
 .PP
 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, \fBFileReader::FileSize\fP returns 0.
 .PP
-Definition at line 898 of file modules.cpp.
+Definition at line 890 of file modules.cpp.
 .PP
-References fc.
+References fc, and readfile().
 .PP
 .nf
-899 {
-900         file_cache c;
-901         readfile(c,filename.c_str());
-902         this->fc = c;
-903 }
+891 {
+892         file_cache c;
+893         readfile(c,filename.c_str());
+894         this->fc = c;
+895 }
 .fi
 .PP
 .SH "Member Data Documentation"
-- 
cgit v1.2.3