Added manpages

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

1 files changed, 159 insertions, 0 deletions

diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3
new file mode 100644
index 000000000..ec0652118
--- /dev/null
+++ b/docs/man/man3/FileReader.3
@@ -0,0 +1,159 @@
+.TH "FileReader" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+FileReader \- Caches a text file into memory and can be used to retrieve lines from it. 
+
+.PP
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <modules.h>\fP
+.PP
+Inherits \fBclassbase\fP.
+.PP
+.SS "Public Member Functions"
+
+.in +1c
+.ti -1c
+.RI "\fBFileReader\fP ()"
+.br
+.RI "\fIDefault constructor.\fP"
+.ti -1c
+.RI "\fBFileReader\fP (std::string filename)"
+.br
+.RI "\fISecondary constructor.\fP"
+.ti -1c
+.RI "\fB~FileReader\fP ()"
+.br
+.RI "\fIDefault destructor.\fP"
+.ti -1c
+.RI "void \fBLoadFile\fP (std::string filename)"
+.br
+.RI "\fIUsed to load a file.\fP"
+.ti -1c
+.RI "bool \fBExists\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)"
+.br
+.RI "\fIRetrieve one line from the file.\fP"
+.ti -1c
+.RI "int \fBFileSize\fP ()"
+.br
+.RI "\fIReturns the size of the file in lines.\fP"
+.in -1c
+.SS "Private Attributes"
+
+.in +1c
+.ti -1c
+.RI "\fBfile_cache\fP \fBfc\fP"
+.br
+.in -1c
+.SH "Detailed Description"
+.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. 
+.PP
+Definition at line 699 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 670 of file modules.cpp.
+.PP
+.nf
+671 {
+672 }
+.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 663 of file modules.cpp.
+.PP
+References fc, and file_cache.
+.PP
+.nf
+664 {
+665         file_cache c;
+666         readfile(c,filename.c_str());
+667         this->fc = c;
+668 }
+.fi
+.SS "FileReader::~FileReader ()"
+.PP
+Default destructor.This deletes the memory allocated to the file.Definition at line 682 of file modules.cpp.
+.PP
+.nf
+683 {
+684 }
+.fi
+.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 686 of file modules.cpp.
+.PP
+References fc.
+.PP
+.nf
+687 {
+688         if (fc.size() == 0)
+689         {
+690                 return(false);
+691         }
+692         else
+693         {
+694                 return(true);
+695         }
+696 }
+.fi
+.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 705 of file modules.cpp.
+.PP
+References fc.
+.PP
+.nf
+706 {
+707         return fc.size();
+708 }
+.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 698 of file modules.cpp.
+.PP
+References fc.
+.PP
+.nf
+699 {
+700         if ((x<0) || (x>fc.size()))
+701                 return '';
+702         return fc[x];
+703 }
+.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 674 of file modules.cpp.
+.PP
+References fc, and file_cache.
+.PP
+.nf
+675 {
+676         file_cache c;
+677         readfile(c,filename.c_str());
+678         this->fc = c;
+679 }
+.fi
+.SH "Member Data Documentation"
+.PP 
+.SS "\fBfile_cache\fP FileReader::fc\fC [private]\fP"
+.PP
+Definition at line 701 of file modules.h.
+.PP
+Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().
+
+.SH "Author"
+.PP 
+Generated automatically by Doxygen for InspIRCd from the source code.