diff options
Diffstat (limited to 'docs/module-doc/classConfigReader.html')
| -rw-r--r-- | docs/module-doc/classConfigReader.html | 96 |
1 files changed, 48 insertions, 48 deletions
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 34229d103..648d7fd88 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -49,7 +49,7 @@ It may either be instantiated with one parameter or none. Constructing the class <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00588">588</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#l00612">612</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="ConfigReader::ConfigReader"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> @@ -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#l00385">385</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#l00553">553</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00596">cache</a>, and <a class="el" href="modules_8h-source.html#l00599">error</a>. +References <a class="el" href="modules_8h-source.html#l00620">cache</a>, and <a class="el" href="modules_8h-source.html#l00623">error</a>. <p> -<div class="fragment"><pre>00386 { -00387 this-><a class="code" href="classConfigReader.html#n0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); -00388 this-><a class="code" href="classConfigReader.html#n1">error</a> = LoadConf(CONFIG_FILE,this->cache); -00389 } +<div class="fragment"><pre>00554 { +00555 this-><a class="code" href="classConfigReader.html#n0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +00556 this-><a class="code" href="classConfigReader.html#n1">error</a> = LoadConf(CONFIG_FILE,this->cache); +00557 } </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#l00399">399</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#l00567">567</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00596">cache</a>, and <a class="el" href="modules_8h-source.html#l00599">error</a>. +References <a class="el" href="modules_8h-source.html#l00620">cache</a>, and <a class="el" href="modules_8h-source.html#l00623">error</a>. <p> -<div class="fragment"><pre>00400 { -00401 this-><a class="code" href="classConfigReader.html#n0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); -00402 this-><a class="code" href="classConfigReader.html#n1">error</a> = LoadConf(filename.c_str(),this-><a class="code" href="classConfigReader.html#n0">cache</a>); -00403 }; +<div class="fragment"><pre>00568 { +00569 this-><a class="code" href="classConfigReader.html#n0">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out); +00570 this-><a class="code" href="classConfigReader.html#n1">error</a> = LoadConf(filename.c_str(),this-><a class="code" href="classConfigReader.html#n0">cache</a>); +00571 }; </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#l00392">392</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#l00560">560</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00596">cache</a>. +References <a class="el" href="modules_8h-source.html#l00620">cache</a>. <p> -<div class="fragment"><pre>00393 { -00394 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#n0">cache</a>) -00395 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#n0">cache</a>; -00396 } +<div class="fragment"><pre>00561 { +00562 <span class="keywordflow">if</span> (this-><a class="code" href="classConfigReader.html#n0">cache</a>) +00563 <span class="keyword">delete</span> this-><a class="code" href="classConfigReader.html#n0">cache</a>; +00564 } </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#l00417">417</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#l00585">585</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00418 { -00419 <span class="keywordflow">return</span> EnumConf(cache,tag.c_str()); -00420 } +<div class="fragment"><pre>00586 { +00587 <span class="keywordflow">return</span> EnumConf(cache,tag.c_str()); +00588 } </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#l00422">422</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#l00590">590</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00423 { -00424 <span class="keywordflow">return</span> EnumValues(cache, tag.c_str(), index); -00425 } +<div class="fragment"><pre>00591 { +00592 <span class="keywordflow">return</span> EnumValues(cache, tag.c_str(), index); +00593 } </pre></div> </td> </tr> </table> @@ -302,17 +302,17 @@ 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#l00405">405</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -<div class="fragment"><pre>00406 { -00407 <span class="keywordtype">char</span> val[MAXBUF]; -00408 <span class="keywordtype">char</span> t[MAXBUF]; -00409 <span class="keywordtype">char</span> n[MAXBUF]; -00410 strncpy(t,tag.c_str(),MAXBUF); -00411 strncpy(n,name.c_str(),MAXBUF); -00412 ReadConf(cache,t,n,index,val); -00413 <span class="keywordflow">return</span> std::string(val); -00414 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00573">573</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00574 { +00575 <span class="keywordtype">char</span> val[MAXBUF]; +00576 <span class="keywordtype">char</span> t[MAXBUF]; +00577 <span class="keywordtype">char</span> n[MAXBUF]; +00578 strncpy(t,tag.c_str(),MAXBUF); +00579 strncpy(n,name.c_str(),MAXBUF); +00580 ReadConf(cache,t,n,index,val); +00581 <span class="keywordflow">return</span> std::string(val); +00582 } </pre></div> </td> </tr> </table> @@ -345,13 +345,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#l00427">427</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#l00595">595</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00599">error</a>. +References <a class="el" href="modules_8h-source.html#l00623">error</a>. <p> -<div class="fragment"><pre>00428 { -00429 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#n1">error</a>; -00430 } +<div class="fragment"><pre>00596 { +00597 <span class="keywordflow">return</span> this-><a class="code" href="classConfigReader.html#n1">error</a>; +00598 } </pre></div> </td> </tr> </table> @@ -379,9 +379,9 @@ The contents of the configuration file This protected member should never be acc <p> It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it. <p> -Definition at line <a class="el" href="modules_8h-source.html#l00596">596</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#l00620">620</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#l00385">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00392">~ConfigReader()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00553">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00560">~ConfigReader()</a>. </td> </tr> </table> <a name="n1" doxytag="ConfigReader::error"></a><p> @@ -407,14 +407,14 @@ Used to store errors. <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00599">599</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#l00623">623</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#l00385">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00427">Verify()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00553">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00595">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 May 1 13:39:13 2004 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Sat May 1 17:50:22 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> |