Added new module docs

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2301 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 42 insertions, 42 deletions

diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3
index c6111fde1..09067f8f8 100644
--- a/docs/man/man3/FileReader.3
+++ b/docs/man/man3/FileReader.3
@@ -1,4 +1,4 @@
-.TH "FileReader" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
+.TH "FileReader" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -57,7 +57,7 @@ Caches a text file into memory and can be used to retrieve lines from it.
 
 This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file.
 .PP
-Definition at line 1210 of file modules.h.
+Definition at line 1599 of file modules.h.
 .SH "Constructor & Destructor Documentation"
 .PP 
 .SS "FileReader::FileReader ()"
@@ -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 950 of file modules.cpp.
+Definition at line 988 of file modules.cpp.
 .PP
 .nf
-951 {
-952 }
+989 {
+990 }
 .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 943 of file modules.cpp.
+Definition at line 981 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-944 {
-945         file_cache c;
-946         readfile(c,filename.c_str());
-947         this->fc = c;
-948 }
+982 {
+983         file_cache c;
+984         readfile(c,filename.c_str());
+985         this->fc = c;
+986 }
 .fi
 .PP
 .SS "FileReader::~FileReader ()"
@@ -97,11 +97,11 @@ Default destructor.
 .PP
 This deletes the memory allocated to the file.
 .PP
-Definition at line 962 of file modules.cpp.
+Definition at line 1000 of file modules.cpp.
 .PP
 .nf
-963 {
-964 }
+1001 {
+1002 }
 .fi
 .PP
 .SH "Member Function Documentation"
@@ -110,21 +110,21 @@ Definition at line 962 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 966 of file modules.cpp.
+Definition at line 1004 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-967 {
-968         if (fc.size() == 0)
-969         {
-970                 return(false);
-971         }
-972         else
-973         {
-974                 return(true);
-975         }
-976 }
+1005 {
+1006         if (fc.size() == 0)
+1007         {
+1008                 return(false);
+1009         }
+1010         else
+1011         {
+1012                 return(true);
+1013         }
+1014 }
 .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 985 of file modules.cpp.
+Definition at line 1023 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-986 {
-987         return fc.size();
-988 }
+1024 {
+1025         return fc.size();
+1026 }
 .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 978 of file modules.cpp.
+Definition at line 1016 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-979 {
-980         if ((x<0) || ((unsigned)x>fc.size()))
-981                 return '';
-982         return fc[x];
-983 }
+1017 {
+1018         if ((x<0) || ((unsigned)x>fc.size()))
+1019                 return '';
+1020         return fc[x];
+1021 }
 .fi
 .PP
 .SS "void FileReader::LoadFile (\fBstd::string\fP filename)"
@@ -167,23 +167,23 @@ 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 954 of file modules.cpp.
+Definition at line 992 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-955 {
-956         file_cache c;
-957         readfile(c,filename.c_str());
-958         this->fc = c;
-959 }
+993 {
+994         file_cache c;
+995         readfile(c,filename.c_str());
+996         this->fc = c;
+997 }
 .fi
 .PP
 .SH "Member Data Documentation"
 .PP 
 .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP"
 .PP
-Definition at line 1212 of file modules.h.
+Definition at line 1601 of file modules.h.
 .PP
 Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().