diff options
author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-19 01:36:09 +0000 |
---|---|---|
committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-19 01:36:09 +0000 |
commit | 74e9276df9d67147885dd2a11b1c23913c9c94f1 (patch) | |
tree | 3b9f690645a06c58afc504400cf59af7df9c5a3e /docs/module-doc/classConfigReader.html | |
parent | af723b70330c7a8c6b4a293e12b7173349d6bad9 (diff) |
Documentation update
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@668 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classConfigReader.html')
-rw-r--r-- | docs/module-doc/classConfigReader.html | 72 |
1 files changed, 36 insertions, 36 deletions
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 6c8d729e1..957309bf3 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -79,14 +79,14 @@ Default constructor. <p> This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure. <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> References <a class="el" href="modules_8h-source.html#l00505">cache</a>, and <a class="el" href="modules_8h-source.html#l00508">error</a>. <p> -<div class="fragment"><pre>00335 { -00336 this-><a class="code" href="classConfigReader.html#n0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); -00337 this-><a class="code" href="classConfigReader.html#n1">error</a> = LoadConf(CONFIG_FILE,this->cache); -00338 } +<div class="fragment"><pre>00337 { +00338 this-><a class="code" href="classConfigReader.html#n0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +00339 this-><a class="code" href="classConfigReader.html#n1">error</a> = LoadConf(CONFIG_FILE,this->cache); +00340 } </pre></div> </td> </tr> </table> @@ -120,14 +120,14 @@ Overloaded constructor. <p> This constructor initialises the ConfigReader class to read a user-specified config file <p> -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>. +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>. <p> References <a class="el" href="modules_8h-source.html#l00505">cache</a>, and <a class="el" href="modules_8h-source.html#l00508">error</a>. <p> -<div class="fragment"><pre>00349 { -00350 this-><a class="code" href="classConfigReader.html#n0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); -00351 this-><a class="code" href="classConfigReader.html#n1">error</a> = LoadConf(filename.c_str(),this-><a class="code" href="classConfigReader.html#n0">cache</a>); -00352 }; +<div class="fragment"><pre>00351 { +00352 this-><a class="code" href="classConfigReader.html#n0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +00353 this-><a class="code" href="classConfigReader.html#n1">error</a> = LoadConf(filename.c_str(),this-><a class="code" href="classConfigReader.html#n0">cache</a>); +00354 }; </pre></div> </td> </tr> </table> @@ -160,14 +160,14 @@ Default destructor. <p> This method destroys the ConfigReader class. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00341">341</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#l00343">343</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l00505">cache</a>. <p> -<div class="fragment"><pre>00342 { -00343 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#n0">cache</a>) -00344 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#n0">cache</a>; -00345 } +<div class="fragment"><pre>00344 { +00345 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#n0">cache</a>) +00346 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#n0">cache</a>; +00347 } </pre></div> </td> </tr> </table> @@ -202,11 +202,11 @@ Counts the number of times a given tag appears in the config file. <p> This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of <a class="el" href="classConfigReader.html#a3">ConfigReader::ReadValue</a> to loop through all copies of a multiple instance tag. <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> -<div class="fragment"><pre>00363 { -00364 <span class="keywordflow">return</span> EnumConf(cache,tag.c_str()); -00365 } +<div class="fragment"><pre>00365 { +00366 <span class="keywordflow">return</span> EnumConf(cache,tag.c_str()); +00367 } </pre></div> </td> </tr> </table> @@ -249,11 +249,11 @@ Returns the number of items within a tag. <p> For example if the tag was <test tag="blah" data="foo"> then this function would return 2. Spaces and newlines both qualify as valid seperators between values. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00367">367</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#l00369">369</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00368 { -00369 <span class="keywordflow">return</span> EnumValues(cache, tag.c_str(), index); -00370 } +<div class="fragment"><pre>00370 { +00371 <span class="keywordflow">return</span> EnumValues(cache, tag.c_str(), index); +00372 } </pre></div> </td> </tr> </table> @@ -302,13 +302,13 @@ Retrieves a value from the config file. <p> This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00354">354</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#l00356">356</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00355 { -00356 <span class="keywordtype">char</span> val[MAXBUF]; -00357 ReadConf(cache,tag.c_str(),name.c_str(),index,val); -00358 <span class="keywordflow">return</span> val; -00359 } +<div class="fragment"><pre>00357 { +00358 <span class="keywordtype">char</span> val[MAXBUF]; +00359 ReadConf(cache,tag.c_str(),name.c_str(),index,val); +00360 <span class="keywordflow">return</span> val; +00361 } </pre></div> </td> </tr> </table> @@ -341,13 +341,13 @@ Returns true if a config file is valid. <p> This method is partially implemented and will only return false if the config file does not exist or could not be opened. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00372">372</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#l00374">374</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l00508">error</a>. <p> -<div class="fragment"><pre>00373 { -00374 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#n1">error</a>; -00375 } +<div class="fragment"><pre>00375 { +00376 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#n1">error</a>; +00377 } </pre></div> </td> </tr> </table> @@ -377,7 +377,7 @@ It will contain a pointer to the configuration file data with unneeded data (suc <p> Definition at line <a class="el" href="modules_8h-source.html#l00505">505</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#l00334">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00341">~ConfigReader()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00336">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00343">~ConfigReader()</a>. </td> </tr> </table> <a name="n1" doxytag="ConfigReader::error"></a><p> @@ -405,12 +405,12 @@ Used to store errors. <p> Definition at line <a class="el" href="modules_8h-source.html#l00508">508</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#l00334">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00372">Verify()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00336">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00374">Verify()</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 17 13:33:53 2004 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Mon Apr 19 02:34:42 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> |