summaryrefslogtreecommitdiff
path: root/docs/module-doc/classFileReader.html
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2004-04-06 20:16:43 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2004-04-06 20:16:43 +0000
commit59a2c6c2d96a4557cd885fefcbce97f490962692 (patch)
treedc8a13a088a77b7ae469cedbc91ade5584581bc0 /docs/module-doc/classFileReader.html
parent0342f38a0e18773610793abaa5f58b7c400071cd (diff)
Updated docs
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@411 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classFileReader.html')
-rw-r--r--docs/module-doc/classFileReader.html96
1 files changed, 48 insertions, 48 deletions
diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html
index f8fd1a23b..54dfd90e2 100644
--- a/docs/module-doc/classFileReader.html
+++ b/docs/module-doc/classFileReader.html
@@ -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#l00473">473</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#l00493">493</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#l00334">334</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#l00336">336</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00335 {
-00336 }
+<div class="fragment"><pre>00337 {
+00338 }
</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#l00327">327</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#l00329">329</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00475">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l00495">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>.
<p>
-<div class="fragment"><pre>00328 {
-00329 <a class="code" href="modules_8h.html#a10">file_cache</a> c;
-00330 readfile(c,filename.c_str());
-00331 this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
-00332 }
+<div class="fragment"><pre>00330 {
+00331 <a class="code" href="modules_8h.html#a10">file_cache</a> c;
+00332 readfile(c,filename.c_str());
+00333 this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
+00334 }
</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#l00346">346</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#l00348">348</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00347 {
-00348 }
+<div class="fragment"><pre>00349 {
+00350 }
</pre></div> </td>
</tr>
</table>
@@ -190,20 +190,20 @@ 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#l00350">350</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#l00352">352</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00475">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00495">fc</a>.
<p>
-<div class="fragment"><pre>00351 {
-00352 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0)
-00353 {
-00354 <span class="keywordflow">return</span>(false);
-00355 }
-00356 <span class="keywordflow">else</span>
-00357 {
-00358 <span class="keywordflow">return</span>(true);
-00359 }
-00360 }
+<div class="fragment"><pre>00353 {
+00354 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0)
+00355 {
+00356 <span class="keywordflow">return</span>(false);
+00357 }
+00358 <span class="keywordflow">else</span>
+00359 {
+00360 <span class="keywordflow">return</span>(true);
+00361 }
+00362 }
</pre></div> </td>
</tr>
</table>
@@ -236,13 +236,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#l00369">369</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#l00371">371</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00475">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00495">fc</a>.
<p>
-<div class="fragment"><pre>00370 {
-00371 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
-00372 }
+<div class="fragment"><pre>00372 {
+00373 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
+00374 }
</pre></div> </td>
</tr>
</table>
@@ -274,15 +274,15 @@ References <a class="el" href="modules_8h-source.html#l00475">fc</a>.
<p>
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00362">362</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#l00364">364</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00475">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00495">fc</a>.
<p>
-<div class="fragment"><pre>00363 {
-00364 <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#o0">fc</a>.size()))
-00365 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
-00366 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
-00367 }
+<div class="fragment"><pre>00365 {
+00366 <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#o0">fc</a>.size()))
+00367 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
+00368 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
+00369 }
</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#l00338">338</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#l00340">340</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00475">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l00495">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>.
<p>
-<div class="fragment"><pre>00339 {
-00340 <a class="code" href="modules_8h.html#a10">file_cache</a> c;
-00341 readfile(c,filename.c_str());
-00342 this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
-00343 }
+<div class="fragment"><pre>00341 {
+00342 <a class="code" href="modules_8h.html#a10">file_cache</a> c;
+00343 readfile(c,filename.c_str());
+00344 this-&gt;<a class="code" href="classFileReader.html#o0">fc</a> = c;
+00345 }
</pre></div> </td>
</tr>
</table>
@@ -350,14 +350,14 @@ References <a class="el" href="modules_8h-source.html#l00475">fc</a>, and <a cla
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l00475">475</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#l00495">495</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#l00350">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00327">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00369">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00362">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00338">LoadFile()</a>. </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00352">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00329">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00371">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00364">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00340">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 Tue Apr 6 11:42:42 2004 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Tue Apr 6 21:13:59 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>