summaryrefslogtreecommitdiff
path: root/docs/module-doc/classFileReader.html
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-05-07 15:35:21 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-05-07 15:35:21 +0000
commitbc0d192a35489b8f5c42aa381ab2b120957ef770 (patch)
tree1fcf2c7fed56053eb6e74cbb6b842578aaade904 /docs/module-doc/classFileReader.html
parent6ff5265391d028cd779cf9e85288e90ea766a6b6 (diff)
Added final documentation for inspircd Beta 4
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1322 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 15bfc3626..1319a66e2 100644
--- a/docs/module-doc/classFileReader.html
+++ b/docs/module-doc/classFileReader.html
@@ -47,7 +47,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#l01186">1186</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#l01236">1236</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 class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
@@ -77,10 +77,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#l00988">988</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#l01004">1004</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00989 {
-00990 }
+<div class="fragment"><pre>01005 {
+01006 }
</pre></div> </td>
</tr>
</table>
@@ -114,15 +114,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#l00981">981</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#l00997">997</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l01188">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l01238">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>.
<p>
-<div class="fragment"><pre>00982 {
-00983 <a class="code" href="modules_8h.html#a31">file_cache</a> c;
-00984 readfile(c,filename.c_str());
-00985 this-&gt;<a class="code" href="classFileReader.html#r0">fc</a> = c;
-00986 }
+<div class="fragment"><pre>00998 {
+00999 <a class="code" href="modules_8h.html#a31">file_cache</a> c;
+01000 readfile(c,filename.c_str());
+01001 this-&gt;<a class="code" href="classFileReader.html#r0">fc</a> = c;
+01002 }
</pre></div> </td>
</tr>
</table>
@@ -155,10 +155,10 @@ Default destructor.
<p>
This deletes the memory allocated to the file.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l01000">1000</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#l01016">1016</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>01001 {
-01002 }
+<div class="fragment"><pre>01017 {
+01018 }
</pre></div> </td>
</tr>
</table>
@@ -192,20 +192,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#l01004">1004</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#l01020">1020</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l01188">fc</a>.
+References <a class="el" href="modules_8h-source.html#l01238">fc</a>.
<p>
-<div class="fragment"><pre>01005 {
-01006 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#r0">fc</a>.size() == 0)
-01007 {
-01008 <span class="keywordflow">return</span>(<span class="keyword">false</span>);
-01009 }
-01010 <span class="keywordflow">else</span>
-01011 {
-01012 <span class="keywordflow">return</span>(<span class="keyword">true</span>);
-01013 }
-01014 }
+<div class="fragment"><pre>01021 {
+01022 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#r0">fc</a>.size() == 0)
+01023 {
+01024 <span class="keywordflow">return</span>(<span class="keyword">false</span>);
+01025 }
+01026 <span class="keywordflow">else</span>
+01027 {
+01028 <span class="keywordflow">return</span>(<span class="keyword">true</span>);
+01029 }
+01030 }
</pre></div> </td>
</tr>
</table>
@@ -238,13 +238,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#l01023">1023</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#l01039">1039</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l01188">fc</a>.
+References <a class="el" href="modules_8h-source.html#l01238">fc</a>.
<p>
-<div class="fragment"><pre>01024 {
-01025 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>.size();
-01026 }
+<div class="fragment"><pre>01040 {
+01041 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>.size();
+01042 }
</pre></div> </td>
</tr>
</table>
@@ -278,15 +278,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#l01016">1016</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#l01032">1032</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l01188">fc</a>.
+References <a class="el" href="modules_8h-source.html#l01238">fc</a>.
<p>
-<div class="fragment"><pre>01017 {
-01018 <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#r0">fc</a>.size()))
-01019 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
-01020 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>[x];
-01021 }
+<div class="fragment"><pre>01033 {
+01034 <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#r0">fc</a>.size()))
+01035 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
+01036 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>[x];
+01037 }
</pre></div> </td>
</tr>
</table>
@@ -320,15 +320,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#l00992">992</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#l01008">1008</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l01188">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l01238">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>.
<p>
-<div class="fragment"><pre>00993 {
-00994 <a class="code" href="modules_8h.html#a31">file_cache</a> c;
-00995 readfile(c,filename.c_str());
-00996 this-&gt;<a class="code" href="classFileReader.html#r0">fc</a> = c;
-00997 }
+<div class="fragment"><pre>01009 {
+01010 <a class="code" href="modules_8h.html#a31">file_cache</a> c;
+01011 readfile(c,filename.c_str());
+01012 this-&gt;<a class="code" href="classFileReader.html#r0">fc</a> = c;
+01013 }
</pre></div> </td>
</tr>
</table>
@@ -354,14 +354,14 @@ References <a class="el" href="modules_8h-source.html#l01188">fc</a>, and <a cla
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l01188">1188</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#l01238">1238</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#l01004">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00981">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l01023">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l01016">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00992">LoadFile()</a>. </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l01020">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00997">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l01039">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l01032">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l01008">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 size="1"><address style="align: right;"><small>Generated on Tue Apr 26 17:11:48 2005 for InspIRCd by
+<hr size="1"><address style="align: right;"><small>Generated on Sat May 7 15:34:25 2005 for InspIRCd by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.3 </small></address>