Added new documentation

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

1 files changed, 85 insertions, 52 deletions

diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3
index cd9e613ef..c6111fde1 100644
--- a/docs/man/man3/FileReader.3
+++ b/docs/man/man3/FileReader.3
@@ -1,4 +1,4 @@
-.TH "FileReader" 3 "30 May 2005" "InspIRCd" \" -*- nroff -*-
+.TH "FileReader" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -20,7 +20,7 @@ Inherits \fBclassbase\fP.
 .br
 .RI "\fIDefault constructor. \fP"
 .ti -1c
-.RI "\fBFileReader\fP (std::string filename)"
+.RI "\fBFileReader\fP (\fBstd::string\fP filename)"
 .br
 .RI "\fISecondary constructor. \fP"
 .ti -1c
@@ -28,7 +28,7 @@ Inherits \fBclassbase\fP.
 .br
 .RI "\fIDefault destructor. \fP"
 .ti -1c
-.RI "void \fBLoadFile\fP (std::string filename)"
+.RI "void \fBLoadFile\fP (\fBstd::string\fP filename)"
 .br
 .RI "\fIUsed to load a file. \fP"
 .ti -1c
@@ -36,7 +36,7 @@ Inherits \fBclassbase\fP.
 .br
 .RI "\fIReturns true if the file exists This function will return false if the file could not be opened. \fP"
 .ti -1c
-.RI "std::string \fBGetLine\fP (int x)"
+.RI "\fBstd::string\fP \fBGetLine\fP (int x)"
 .br
 .RI "\fIRetrieve one line from the file. \fP"
 .ti -1c
@@ -55,102 +55,135 @@ Inherits \fBclassbase\fP.
 .PP 
 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. 
+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 1239 of file modules.h.
+Definition at line 1210 of file modules.h.
 .SH "Constructor & Destructor Documentation"
 .PP 
 .SS "FileReader::FileReader ()"
 .PP
-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 975 of file modules.cpp.
+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.
 .PP
 .nf
-976 {
-977 }
+951 {
+952 }
 .fi
-.SS "FileReader::FileReader (std::string filename)"
 .PP
-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, \fBFileReader::FileSize\fP returns 0.Definition at line 968 of file modules.cpp.
+.SS "FileReader::FileReader (\fBstd::string\fP filename)"
+.PP
+Secondary constructor. 
 .PP
-References fc, and file_cache.
+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.
+.PP
+References fc.
 .PP
 .nf
-969 {
-970         file_cache c;
-971         readfile(c,filename.c_str());
-972         this->fc = c;
-973 }
+944 {
+945         file_cache c;
+946         readfile(c,filename.c_str());
+947         this->fc = c;
+948 }
 .fi
-.SS "FileReader::~\fBFileReader\fP ()"
 .PP
-Default destructor. This deletes the memory allocated to the file.Definition at line 987 of file modules.cpp.
+.SS "FileReader::~FileReader ()"
+.PP
+Default destructor. 
+.PP
+This deletes the memory allocated to the file.
+.PP
+Definition at line 962 of file modules.cpp.
 .PP
 .nf
-988 {
-989 }
+963 {
+964 }
 .fi
+.PP
 .SH "Member Function Documentation"
 .PP 
 .SS "bool FileReader::Exists ()"
 .PP
-Returns true if the file exists This function will return false if the file could not be opened. Definition at line 991 of file modules.cpp.
+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.
 .PP
 References fc.
 .PP
 .nf
-992 {
-993         if (fc.size() == 0)
-994         {
-995                 return(false);
-996         }
-997         else
-998         {
-999                 return(true);
-1000         }
-1001 }
+967 {
+968         if (fc.size() == 0)
+969         {
+970                 return(false);
+971         }
+972         else
+973         {
+974                 return(true);
+975         }
+976 }
 .fi
+.PP
 .SS "int FileReader::FileSize ()"
 .PP
-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 1010 of file modules.cpp.
+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.
 .PP
 References fc.
 .PP
 .nf
-1011 {
-1012         return fc.size();
-1013 }
+986 {
+987         return fc.size();
+988 }
 .fi
-.SS "std::string FileReader::GetLine (int x)"
 .PP
-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 1003 of file modules.cpp.
+.SS "\fBstd::string\fP FileReader::GetLine (int x)"
+.PP
+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.
 .PP
 References fc.
 .PP
 .nf
-1004 {
-1005         if ((x<0) || (x>fc.size()))
-1006                 return '';
-1007         return fc[x];
-1008 }
+979 {
+980         if ((x<0) || ((unsigned)x>fc.size()))
+981                 return '';
+982         return fc[x];
+983 }
 .fi
-.SS "void FileReader::LoadFile (std::string filename)"
 .PP
-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, \fBFileReader::FileSize\fP returns 0.Definition at line 979 of file modules.cpp.
+.SS "void FileReader::LoadFile (\fBstd::string\fP filename)"
 .PP
-References fc, and file_cache.
+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.
+.PP
+References fc.
 .PP
 .nf
-980 {
-981         file_cache c;
-982         readfile(c,filename.c_str());
-983         this->fc = c;
-984 }
+955 {
+956         file_cache c;
+957         readfile(c,filename.c_str());
+958         this->fc = c;
+959 }
 .fi
+.PP
 .SH "Member Data Documentation"
 .PP 
 .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP"
 .PP
-Definition at line 1241 of file modules.h.
+Definition at line 1212 of file modules.h.
 .PP
 Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().