diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-05-15 17:05:15 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-05-15 17:05:15 +0000 |
| commit | 4d5a17380bc71cabe544b41c7c8a26a292384f3d (patch) | |
| tree | 9a882bc421d4c250817a17980265b76e06e4cf8c /docs/module-doc/classFileReader.html | |
| parent | a48ee868ed80b689b773fdd9bbd8f1e761dc3b8a (diff) | |
Added docs for hashcomp
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1396 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 d9be72a02..646b92de9 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -4,7 +4,7 @@ <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.3.3 --> -<div class="qindex"><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></div> +<div class="qindex"><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="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> <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> @@ -53,7 +53,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#l01236">1236</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#l01239">1239</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 class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> @@ -83,10 +83,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#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#l00952">952</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>01024 { -01025 } +<div class="fragment"><pre>00953 { +00954 } </pre></div> </td> </tr> </table> @@ -120,15 +120,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#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#l00945">945</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -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>. +References <a class="el" href="modules_8h-source.html#l01241">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>. <p> -<div class="fragment"><pre>01017 { -01018 <a class="code" href="modules_8h.html#a31">file_cache</a> c; -01019 readfile(c,filename.c_str()); -01020 this-><a class="code" href="classFileReader.html#r0">fc</a> = c; -01021 } +<div class="fragment"><pre>00946 { +00947 <a class="code" href="modules_8h.html#a31">file_cache</a> c; +00948 readfile(c,filename.c_str()); +00949 this-><a class="code" href="classFileReader.html#r0">fc</a> = c; +00950 } </pre></div> </td> </tr> </table> @@ -161,10 +161,10 @@ Default destructor. <p> This deletes the memory allocated to the file. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l01035">1035</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#l00964">964</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>01036 { -01037 } +<div class="fragment"><pre>00965 { +00966 } </pre></div> </td> </tr> </table> @@ -198,20 +198,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#l01039">1039</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#l00968">968</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01238">fc</a>. +References <a class="el" href="modules_8h-source.html#l01241">fc</a>. <p> -<div class="fragment"><pre>01040 { -01041 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#r0">fc</a>.size() == 0) -01042 { -01043 <span class="keywordflow">return</span>(<span class="keyword">false</span>); -01044 } -01045 <span class="keywordflow">else</span> -01046 { -01047 <span class="keywordflow">return</span>(<span class="keyword">true</span>); -01048 } -01049 } +<div class="fragment"><pre>00969 { +00970 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#r0">fc</a>.size() == 0) +00971 { +00972 <span class="keywordflow">return</span>(<span class="keyword">false</span>); +00973 } +00974 <span class="keywordflow">else</span> +00975 { +00976 <span class="keywordflow">return</span>(<span class="keyword">true</span>); +00977 } +00978 } </pre></div> </td> </tr> </table> @@ -244,13 +244,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#l01058">1058</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#l00987">987</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01238">fc</a>. +References <a class="el" href="modules_8h-source.html#l01241">fc</a>. <p> -<div class="fragment"><pre>01059 { -01060 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>.size(); -01061 } +<div class="fragment"><pre>00988 { +00989 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>.size(); +00990 } </pre></div> </td> </tr> </table> @@ -284,15 +284,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#l01051">1051</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#l00980">980</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l01238">fc</a>. +References <a class="el" href="modules_8h-source.html#l01241">fc</a>. <p> -<div class="fragment"><pre>01052 { -01053 <span class="keywordflow">if</span> ((x<0) || (x><a class="code" href="classFileReader.html#r0">fc</a>.size())) -01054 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; -01055 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>[x]; -01056 } +<div class="fragment"><pre>00981 { +00982 <span class="keywordflow">if</span> ((x<0) || (x><a class="code" href="classFileReader.html#r0">fc</a>.size())) +00983 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; +00984 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>[x]; +00985 } </pre></div> </td> </tr> </table> @@ -326,15 +326,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#l01027">1027</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#l00956">956</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -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>. +References <a class="el" href="modules_8h-source.html#l01241">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>. <p> -<div class="fragment"><pre>01028 { -01029 <a class="code" href="modules_8h.html#a31">file_cache</a> c; -01030 readfile(c,filename.c_str()); -01031 this-><a class="code" href="classFileReader.html#r0">fc</a> = c; -01032 } +<div class="fragment"><pre>00957 { +00958 <a class="code" href="modules_8h.html#a31">file_cache</a> c; +00959 readfile(c,filename.c_str()); +00960 this-><a class="code" href="classFileReader.html#r0">fc</a> = c; +00961 } </pre></div> </td> </tr> </table> @@ -360,14 +360,14 @@ References <a class="el" href="modules_8h-source.html#l01238">fc</a>, and <a cla <p> <p> -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>. +Definition at line <a class="el" href="modules_8h-source.html#l01241">1241</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#l01039">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l01016">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l01058">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l01051">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l01027">LoadFile()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00968">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00945">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00987">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00980">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00956">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 Fri May 13 15:49:38 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Sun May 15 17:03:26 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> |