summaryrefslogtreecommitdiff
path: root/docs/module-doc/classConfigReader.html
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2003-03-30 12:32:32 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2003-03-30 12:32:32 +0000
commit44b62866f83dea028500d81274eaaba8e886e1c3 (patch)
tree0a7a97f683173fadcc396bf1282c111aa4831241 /docs/module-doc/classConfigReader.html
parent48012b330a08a81af84a5ff1d901ddc5e24a942f (diff)
Added DOT files to documentation for class diagrams (pretteh!)
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@169 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classConfigReader.html')
-rw-r--r--docs/module-doc/classConfigReader.html81
1 files changed, 42 insertions, 39 deletions
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html
index 6ae16f47a..a83fd9e29 100644
--- a/docs/module-doc/classConfigReader.html
+++ b/docs/module-doc/classConfigReader.html
@@ -3,7 +3,7 @@
<title>ConfigReader class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.3-rc2 -->
+<!-- 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>
<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.
@@ -11,14 +11,17 @@
<p>
<code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
<p>
-<p>Inheritance diagram for ConfigReader:
-<p><center><img src="classConfigReader.png" usemap="#ConfigReader_map" border="0" alt=""></center>
-<map name="ConfigReader_map">
-<area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,90,24">
+Inheritance diagram for ConfigReader:<p><center><img src="classConfigReader__inherit__graph.gif" border="0" usemap="#ConfigReader__inherit__map" alt="Inheritance graph"></center>
+<map name="ConfigReader__inherit__map">
+<area href="classclassbase.html" shape="rect" coords="19,16,85,37" alt="">
</map>
-<a href="classConfigReader-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ConfigReader:<p><center><img src="classConfigReader__coll__graph.gif" border="0" usemap="#ConfigReader__coll__map" alt="Collaboration graph"></center>
+<map name="ConfigReader__coll__map">
+<area href="classclassbase.html" shape="rect" coords="7,107,73,128" alt="">
+</map>
+<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classConfigReader-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
-<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classConfigReader.html#a0">ConfigReader</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classConfigReader.html#a1">ConfigReader</a> (string filename)</td></tr>
@@ -42,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#l00218">218</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#l00219">219</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>
@@ -72,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#l00151">151</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#l00152">152</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00223">fname</a>.
+References <a class="el" href="modules_8h-source.html#l00224">fname</a>.
<p>
-<div class="fragment"><pre>00152 {
-00153 <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
-00154 }
+<div class="fragment"><pre>00153 {
+00154 <a class="code" href="classConfigReader.html#n0">fname</a> = CONFIG_FILE;
+00155 }
</pre></div> </td>
</tr>
</table>
@@ -112,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#l00162">162</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#l00163">163</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00162 : <a class="code" href="classConfigReader.html#n0">fname</a>(filename) { };
+<div class="fragment"><pre>00163 : <a class="code" href="classConfigReader.html#n0">fname</a>(filename) { };
</pre></div> </td>
</tr>
</table>
@@ -147,10 +150,10 @@ Default destructor.
<p>
This method destroys the ConfigReader class.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00157">157</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#l00158">158</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00158 {
-00159 }
+<div class="fragment"><pre>00159 {
+00160 }
</pre></div> </td>
</tr>
</table>
@@ -185,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#l00173">173</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#l00174">174</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00223">fname</a>.
+References <a class="el" href="modules_8h-source.html#l00224">fname</a>.
<p>
-<div class="fragment"><pre>00174 {
-00175 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
-00176 }
+<div class="fragment"><pre>00175 {
+00176 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str());
+00177 }
</pre></div> </td>
</tr>
</table>
@@ -240,16 +243,16 @@ 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#l00164">164</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#l00165">165</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00223">fname</a>.
+References <a class="el" href="modules_8h-source.html#l00224">fname</a>.
<p>
-<div class="fragment"><pre>00165 {
-00166 <span class="keywordtype">char</span> val[MAXBUF];
-00167 ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
-00168 string s = val;
-00169 <span class="keywordflow">return</span> s;
-00170 }
+<div class="fragment"><pre>00166 {
+00167 <span class="keywordtype">char</span> val[MAXBUF];
+00168 ReadConf(<a class="code" href="classConfigReader.html#n0">fname</a>.c_str(),tag.c_str(),name.c_str(),index,val);
+00169 string s = val;
+00170 <span class="keywordflow">return</span> s;
+00171 }
</pre></div> </td>
</tr>
</table>
@@ -282,11 +285,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#l00179">179</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#l00180">180</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00180 {
-00181 <span class="keywordflow">return</span> <span class="keyword">true</span>;
-00182 }
+<div class="fragment"><pre>00181 {
+00182 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+00183 }
</pre></div> </td>
</tr>
</table>
@@ -314,16 +317,16 @@ The filename of the configuration file, as set by the constructor.
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l00223">223</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#l00224">224</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#l00151">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00173">Enumerate()</a>, and <a class="el" href="modules_8cpp-source.html#l00164">ReadValue()</a>. </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00152">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00174">Enumerate()</a>, and <a class="el" href="modules_8cpp-source.html#l00165">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 Sun Feb 9 12:48:17 2003 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Sun Mar 30 13:28:46 2003 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-rc2 </small></address>
+width=110 height=53></a>1.3-rc3 </small></address>
</body>
</html>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-16 07:21:18 +0000