summaryrefslogtreecommitdiff
path: root/docs/module-doc/classConfigReader.html
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2004-04-04 22:03:32 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2004-04-04 22:03:32 +0000
commit78a96055c428d1970ece93dfb01902ac0d1699bd (patch)
treeb0df96bae212f97c67ebf2339d40454f2283e5d3 /docs/module-doc/classConfigReader.html
parentdb6ed68db7e38e21a9ce66cecaf42006f034dc62 (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/classConfigReader.html')
-rw-r--r--docs/module-doc/classConfigReader.html62
1 files changed, 31 insertions, 31 deletions
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html
index 5d18c102f..35e957755 100644
--- a/docs/module-doc/classConfigReader.html
+++ b/docs/module-doc/classConfigReader.html
@@ -5,7 +5,7 @@
</head><body>
<!-- Generated by Doxygen 1.3-rc3 -->
<center>
-<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
+<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ConfigReader Class Reference</h1>Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.
<a href="#_details">More...</a>
<p>
@@ -45,7 +45,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#l00357">357</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#l00358">358</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="ConfigReader::ConfigReader"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
@@ -75,13 +75,13 @@ 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#l00236">236</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#l00265">265</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00362">fname</a>.
+References <a class="el" href="modules_8h-source.html#l00363">fname</a>.
<p>
-<div class="fragment"><pre>00237 {
-00238 <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
-00239 }
+<div class="fragment"><pre>00266 {
+00267 <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
+00268 }
</pre></div> </td>
</tr>
</table>
@@ -115,9 +115,9 @@ 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#l00247">247</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#l00276">276</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00247 : <a class="code" href="classConfigReader.html#n0">fname</a>(filename) { };
+<div class="fragment"><pre>00276 : <a class="code" href="classConfigReader.html#n0">fname</a>(filename) { };
</pre></div> </td>
</tr>
</table>
@@ -150,10 +150,10 @@ Default destructor.
<p>
This method destroys the ConfigReader class.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00242">242</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#l00271">271</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00243 {
-00244 }
+<div class="fragment"><pre>00272 {
+00273 }
</pre></div> </td>
</tr>
</table>
@@ -188,13 +188,13 @@ 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#l00257">257</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#l00286">286</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00362">fname</a>.
+References <a class="el" href="modules_8h-source.html#l00363">fname</a>.
<p>
-<div class="fragment"><pre>00258 {
-00259 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
-00260 }
+<div class="fragment"><pre>00287 {
+00288 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
+00289 }
</pre></div> </td>
</tr>
</table>
@@ -243,15 +243,15 @@ 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#l00249">249</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#l00278">278</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00362">fname</a>.
+References <a class="el" href="modules_8h-source.html#l00363">fname</a>.
<p>
-<div class="fragment"><pre>00250 {
-00251 <span class="keywordtype">char</span> val[MAXBUF];
-00252 ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
-00253 <span class="keywordflow">return</span> val;
-00254 }
+<div class="fragment"><pre>00279 {
+00280 <span class="keywordtype">char</span> val[MAXBUF];
+00281 ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
+00282 <span class="keywordflow">return</span> val;
+00283 }
</pre></div> </td>
</tr>
</table>
@@ -284,11 +284,11 @@ Returns true if a config file is valid.
<p>
This method is unimplemented and will always return true.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00263">263</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#l00292">292</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00264 {
-00265 <span class="keywordflow">return</span> <span class="keyword">true</span>;
-00266 }
+<div class="fragment"><pre>00293 {
+00294 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+00295 }
</pre></div> </td>
</tr>
</table>
@@ -316,14 +316,14 @@ The filename of the configuration file, as set by the constructor.
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l00362">362</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#l00363">363</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#l00236">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00257">Enumerate()</a>, and <a class="el" href="modules_8cpp-source.html#l00249">ReadValue()</a>. </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00265">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00286">Enumerate()</a>, and <a class="el" href="modules_8cpp-source.html#l00278">ReadValue()</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:11 2004 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:24 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-16 08:00:40 +0000