Added new documentation

[user/henk/code/inspircd.git] / docs / module-doc / classFileReader.html

diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html
index efd44913b59cf84008a223ed09bf88cd90c3d3dd..000c829b8a53cca5a8f29d3ab5d11c585f79bec1 100644 (file)
--- a/docs/module-doc/classFileReader.html
+++ b/docs/module-doc/classFileReader.html
@@ -31,8 +31,8 @@ Inheritance diagram for FileReader:<p><center><img src="classFileReader__inherit
 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classFileReader.html#a3">LoadFile</a> (std::string filename)</td></tr>
 <tr><td>&nbsp;</td><td><font size=-1><em>Used to load a file.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classFileReader.html#a4">Exists</a> ()</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Retrieve one line from the file.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>std::string&nbsp;</td><td valign=bottom><a class="el" href="classFileReader.html#a5">GetLine</a> (int x)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Retrieve one line from the file.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
 <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>
@@ -45,7 +45,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#l00403">403</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#l00522">522</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>
@@ -75,10 +75,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#l00305">305</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#l00366">366</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-<div class="fragment"><pre>00306 {
-00307 }
+<div class="fragment"><pre>00367 {
+00368 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -112,15 +112,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#l00298">298</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#l00359">359</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00405">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l00524">fc</a>, and <a class="el" href="modules_8h-source.html#l00030">file_cache</a>.
 <p>
-<div class="fragment"><pre>00299 {
-00300         <a class="code" href="modules_8h.html#a10">file_cache</a> c;
-00301         readfile(c,filename.c_str());
-00302         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
-00303 }
+<div class="fragment"><pre>00360 {
+00361         <a class="code" href="modules_8h.html#a10">file_cache</a> c;
+00362         readfile(c,filename.c_str());
+00363         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
+00364 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -153,10 +153,10 @@ Default destructor.
 <p>
 This deletes the memory allocated to the file.
 <p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00317">317</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#l00378">378</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-<div class="fragment"><pre>00318 {
-00319 }
+<div class="fragment"><pre>00379 {
+00380 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -186,24 +186,22 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00317">317</a>
     <td>
 
 <p>
-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#l00321">321</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#l00382">382</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00405">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00524">fc</a>.
 <p>
-<div class="fragment"><pre>00322 {
-00323         <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0)
-00324         {
-00325                 <span class="keywordflow">return</span>(false);
-00326         }
-00327         <span class="keywordflow">else</span>
-00328         {
-00329                 <span class="keywordflow">return</span>(true);
-00330         }
-00331 }
+<div class="fragment"><pre>00383 {
+00384         <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0)
+00385         {
+00386                 <span class="keywordflow">return</span>(false);
+00387         }
+00388         <span class="keywordflow">else</span>
+00389         {
+00390                 <span class="keywordflow">return</span>(true);
+00391         }
+00392 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -236,13 +234,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#l00340">340</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#l00401">401</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00405">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00524">fc</a>.
 <p>
-<div class="fragment"><pre>00341 {
-00342         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
-00343 }
+<div class="fragment"><pre>00402 {
+00403         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
+00404 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -272,17 +270,19 @@ References <a class="el" href="modules_8h-source.html#l00405">fc</a>.
     <td>
 
 <p>
-
+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#l00333">333</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#l00394">394</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00405">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00524">fc</a>.
 <p>
-<div class="fragment"><pre>00334 {
-00335         <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#o0">fc</a>.size()))
-00336                 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
-00337         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
-00338 }
+<div class="fragment"><pre>00395 {
+00396         <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#o0">fc</a>.size()))
+00397                 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
+00398         <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
+00399 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -316,15 +316,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#l00309">309</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#l00370">370</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00405">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l00524">fc</a>, and <a class="el" href="modules_8h-source.html#l00030">file_cache</a>.
 <p>
-<div class="fragment"><pre>00310 {
-00311         <a class="code" href="modules_8h.html#a10">file_cache</a> c;
-00312         readfile(c,filename.c_str());
-00313         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
-00314 }
+<div class="fragment"><pre>00371 {
+00372         <a class="code" href="modules_8h.html#a10">file_cache</a> c;
+00373         readfile(c,filename.c_str());
+00374         this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
+00375 }
 </pre></div>    </td>
   </tr>
 </table>
@@ -350,14 +350,14 @@ References <a class="el" href="modules_8h-source.html#l00405">fc</a>, and <a cla
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8h-source.html#l00405">405</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#l00524">524</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#l00321">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00298">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00340">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00333">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00309">LoadFile()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00382">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00359">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00401">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00394">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00370">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 Sun Apr 4 23:02:27 2004 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Wed Apr 7 19:20:44 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>