Added new documentation for ELine class and OnUserPostNick method

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@977 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 3cb35ebd7..377933336 100644
--- a/docs/man/man3/FileReader.3
+++ b/docs/man/man3/FileReader.3
@@ -1,4 +1,4 @@
-.TH "FileReader" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*-
+.TH "FileReader" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -57,100 +57,100 @@ 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 758 of file modules.h.
+Definition at line 764 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 729 of file modules.cpp.
+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 730 of file modules.cpp.
 .PP
 .nf
-730 {
-731 }
+731 {
+732 }
 .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 722 of file modules.cpp.
+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 723 of file modules.cpp.
 .PP
 References fc, and file_cache.
 .PP
 .nf
-723 {
-724         file_cache c;
-725         readfile(c,filename.c_str());
-726         this->fc = c;
-727 }
+724 {
+725         file_cache c;
+726         readfile(c,filename.c_str());
+727         this->fc = c;
+728 }
 .fi
 .SS "FileReader::~\fBFileReader\fP ()"
 .PP
-Default destructor. This deletes the memory allocated to the file.Definition at line 741 of file modules.cpp.
+Default destructor. This deletes the memory allocated to the file.Definition at line 742 of file modules.cpp.
 .PP
 .nf
-742 {
-743 }
+743 {
+744 }
 .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 745 of file modules.cpp.
+Returns true if the file exists This function will return false if the file could not be opened. Definition at line 746 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-746 {
-747         if (fc.size() == 0)
-748         {
-749                 return(false);
-750         }
-751         else
-752         {
-753                 return(true);
-754         }
-755 }
+747 {
+748         if (fc.size() == 0)
+749         {
+750                 return(false);
+751         }
+752         else
+753         {
+754                 return(true);
+755         }
+756 }
 .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 764 of file modules.cpp.
+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 765 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-765 {
-766         return fc.size();
-767 }
+766 {
+767         return fc.size();
+768 }
 .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 757 of file modules.cpp.
+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 758 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-758 {
-759         if ((x<0) || (x>fc.size()))
-760                 return '';
-761         return fc[x];
-762 }
+759 {
+760         if ((x<0) || (x>fc.size()))
+761                 return '';
+762         return fc[x];
+763 }
 .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 733 of file modules.cpp.
+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 734 of file modules.cpp.
 .PP
 References fc, and file_cache.
 .PP
 .nf
-734 {
-735         file_cache c;
-736         readfile(c,filename.c_str());
-737         this->fc = c;
-738 }
+735 {
+736         file_cache c;
+737         readfile(c,filename.c_str());
+738         this->fc = c;
+739 }
 .fi
 .SH "Member Data Documentation"
 .PP 
 .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP"
 .PP
-Definition at line 760 of file modules.h.
+Definition at line 766 of file modules.h.
 .PP
 Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().