Added documentation of new ConfigReader methods suggested by Azhrarn for sanity

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

1 files changed, 50 insertions, 50 deletions

diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html
index fc98c5761..6c35863a4 100644
--- a/docs/module-doc/classFileReader.html
+++ b/docs/module-doc/classFileReader.html
@@ -37,7 +37,7 @@ Inheritance diagram for FileReader:<p><center><img src="classFileReader__inherit
 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classFileReader.html#a6">FileSize</a> ()</td></tr>
 <tr><td>&nbsp;</td><td><font size=-1><em>Returns the size of the file in lines.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
 <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top><a class="el" href="modules_8h.html#a22">file_cache</a>&nbsp;</td><td valign=bottom><a class="el" href="classFileReader.html#o0">fc</a></td></tr>
+<tr><td nowrap align=right valign=top><a class="el" href="modules_8h.html#a26">file_cache</a>&nbsp;</td><td valign=bottom><a class="el" href="classFileReader.html#o0">fc</a></td></tr>
 </table>
 <hr><a name="_details"></a><h2>Detailed Description</h2>
 Caches a text file into memory and can be used to retrieve lines from it.
@@ -46,7 +46,7 @@ This class contains methods for read-only manipulation of a text file in memory.
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8h-source.html#l00672">672</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
+Definition at line <a class="el" href="modules_8h-source.html#l00698">698</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
 <a name="a0" doxytag="FileReader::FileReader"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
@@ -76,10 +76,10 @@ Default constructor.
 <p>
 This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.
 <p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00608">608</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00670">670</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-<div class="fragment"><pre>00609 {
-00610 }
+<div class="fragment"><pre>00671 {
+00672 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -113,15 +113,15 @@ Secondary constructor.
 <p>
 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, <a class="el" href="classFileReader.html#a6">FileReader::FileSize</a> returns 0.
 <p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00601">601</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00663">663</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00674">fc</a>, and <a class="el" href="modules_8h-source.html#l00050">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l00700">fc</a>, and <a class="el" href="modules_8h-source.html#l00050">file_cache</a>.
 <p>
-<div class="fragment"><pre>00602 {
-00603         <a class="code" href="modules_8h.html#a22">file_cache</a> c;
-00604         readfile(c,filename.c_str());
-00605         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
-00606 }
+<div class="fragment"><pre>00664 {
+00665         <a class="code" href="modules_8h.html#a26">file_cache</a> c;
+00666         readfile(c,filename.c_str());
+00667         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
+00668 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -154,10 +154,10 @@ Default destructor.
 <p>
 This deletes the memory allocated to the file.
 <p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00620">620</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00682">682</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-<div class="fragment"><pre>00621 {
-00622 }
+<div class="fragment"><pre>00683 {
+00684 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -191,20 +191,20 @@ Returns true if the file exists This function will return false if the file coul
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00624">624</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00686">686</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00674">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00700">fc</a>.
 <p>
-<div class="fragment"><pre>00625 {
-00626         <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0)
-00627         {
-00628                 <span class="keywordflow">return</span>(false);
-00629         }
-00630         <span class="keywordflow">else</span>
-00631         {
-00632                 <span class="keywordflow">return</span>(true);
-00633         }
-00634 }
+<div class="fragment"><pre>00687 {
+00688         <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0)
+00689         {
+00690                 <span class="keywordflow">return</span>(false);
+00691         }
+00692         <span class="keywordflow">else</span>
+00693         {
+00694                 <span class="keywordflow">return</span>(true);
+00695         }
+00696 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -237,13 +237,13 @@ Returns the size of the file in lines.
 <p>
 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.
 <p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00643">643</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00705">705</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00674">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00700">fc</a>.
 <p>
-<div class="fragment"><pre>00644 {
-00645         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
-00646 }
+<div class="fragment"><pre>00706 {
+00707         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
+00708 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -277,15 +277,15 @@ Retrieve one line from the file.
 <p>
 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.
 <p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00636">636</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00698">698</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00674">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00700">fc</a>.
 <p>
-<div class="fragment"><pre>00637 {
-00638         <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#o0">fc</a>.size()))
-00639                 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
-00640         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
-00641 }
+<div class="fragment"><pre>00699 {
+00700         <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#o0">fc</a>.size()))
+00701                 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
+00702         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
+00703 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -319,15 +319,15 @@ Used to load a file.
 <p>
 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, <a class="el" href="classFileReader.html#a6">FileReader::FileSize</a> returns 0.
 <p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00612">612</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00674">674</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00674">fc</a>, and <a class="el" href="modules_8h-source.html#l00050">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l00700">fc</a>, and <a class="el" href="modules_8h-source.html#l00050">file_cache</a>.
 <p>
-<div class="fragment"><pre>00613 {
-00614         <a class="code" href="modules_8h.html#a22">file_cache</a> c;
-00615         readfile(c,filename.c_str());
-00616         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
-00617 }
+<div class="fragment"><pre>00675 {
+00676         <a class="code" href="modules_8h.html#a26">file_cache</a> c;
+00677         readfile(c,filename.c_str());
+00678         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
+00679 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -338,7 +338,7 @@ References <a class="el" href="modules_8h-source.html#l00674">fc</a>, and <a cla
     <td class="md">
       <table cellpadding="0" cellspacing="0" border="0">
         <tr>
-          <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a22">file_cache</a> FileReader::fc<code> [private]</code>
+          <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a26">file_cache</a> FileReader::fc<code> [private]</code>
       </table>
     </td>
   </tr>
@@ -353,14 +353,14 @@ References <a class="el" href="modules_8h-source.html#l00674">fc</a>, and <a cla
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8h-source.html#l00674">674</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
+Definition at line <a class="el" href="modules_8h-source.html#l00700">700</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00624">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00601">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00643">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00636">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00612">LoadFile()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00686">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00663">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00705">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00698">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00674">LoadFile()</a>.    </td>
   </tr>
 </table>
 <hr>The documentation for this class was generated from the following files:<ul>
 <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
-<hr><address style="align: right;"><small>Generated on Sat May 1 17:50:26 2004 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Sat May 1 20:58:06 2004 for InspIRCd by
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
 width=110 height=53></a>1.3-rc3 </small></address>