diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-04 22:03:32 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-04 22:03:32 +0000 |
| commit | 78a96055c428d1970ece93dfb01902ac0d1699bd (patch) | |
| tree | b0df96bae212f97c67ebf2339d40454f2283e5d3 /docs/module-doc/classFileReader.html | |
| parent | db6ed68db7e38e21a9ce66cecaf42006f034dc62 (diff) | |
New documentation to document user/channel mode handling
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@380 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classFileReader.html')
| -rw-r--r-- | docs/module-doc/classFileReader.html | 98 |
1 files changed, 49 insertions, 49 deletions
diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index b44d63b9b..efd44913b 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -5,7 +5,7 @@ </head><body> <!-- Generated by Doxygen 1.3-rc3 --> <center> -<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> +<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>FileReader Class Reference</h1>Caches a text file into memory and can be used to retrieve lines from it. <a href="#_details">More...</a> <p> @@ -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#l00402">402</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +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 & 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#l00276">276</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#l00305">305</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00277 { -00278 } +<div class="fragment"><pre>00306 { +00307 } </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#l00269">269</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#l00298">298</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00404">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>. +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>. <p> -<div class="fragment"><pre>00270 { -00271 <a class="code" href="modules_8h.html#a10">file_cache</a> c; -00272 readfile(c,filename.c_str()); -00273 this-><a class="code" href="classFileReader.html#o0">fc</a> = c; -00274 } +<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-><a class="code" href="classFileReader.html#o0">fc</a> = c; +00303 } </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#l00288">288</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#l00317">317</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00289 { -00290 } +<div class="fragment"><pre>00318 { +00319 } </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#l00292">292</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#l00321">321</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00404">fc</a>. +References <a class="el" href="modules_8h-source.html#l00405">fc</a>. <p> -<div class="fragment"><pre>00293 { -00294 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0) -00295 { -00296 <span class="keywordflow">return</span>(false); -00297 } -00298 <span class="keywordflow">else</span> -00299 { -00300 <span class="keywordflow">return</span>(true); -00301 } -00302 } +<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 } </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#l00311">311</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#l00404">fc</a>. +References <a class="el" href="modules_8h-source.html#l00405">fc</a>. <p> -<div class="fragment"><pre>00312 { -00313 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size(); -00314 } +<div class="fragment"><pre>00341 { +00342 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size(); +00343 } </pre></div> </td> </tr> </table> @@ -274,15 +274,15 @@ References <a class="el" href="modules_8h-source.html#l00404">fc</a>. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00304">304</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#l00333">333</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00404">fc</a>. +References <a class="el" href="modules_8h-source.html#l00405">fc</a>. <p> -<div class="fragment"><pre>00305 { -00306 <span class="keywordflow">if</span> ((x<0) || (x><a class="code" href="classFileReader.html#o0">fc</a>.size())) -00307 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; -00308 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x]; -00309 } +<div class="fragment"><pre>00334 { +00335 <span class="keywordflow">if</span> ((x<0) || (x><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 } </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#l00280">280</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#l00309">309</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00404">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>. +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>. <p> -<div class="fragment"><pre>00281 { -00282 <a class="code" href="modules_8h.html#a10">file_cache</a> c; -00283 readfile(c,filename.c_str()); -00284 this-><a class="code" href="classFileReader.html#o0">fc</a> = c; -00285 } +<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-><a class="code" href="classFileReader.html#o0">fc</a> = c; +00314 } </pre></div> </td> </tr> </table> @@ -350,14 +350,14 @@ References <a class="el" href="modules_8h-source.html#l00404">fc</a>, and <a cla <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00404">404</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#l00405">405</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#l00292">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00269">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00311">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00304">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00280">LoadFile()</a>. </td> +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> </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 Apr 3 16:36:14 2004 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:27 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> |