Added documentation of new ConfigReader methods suggested by Azhrarn for sanity

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@772 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 126 insertions, 18 deletions

diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html
index 99ac7ab9b..b587a938e 100644
--- a/docs/module-doc/modules_8h.html
+++ b/docs/module-doc/modules_8h.html
@@ -68,16 +68,20 @@ This graph shows which files directly or indirectly include this file:<p><center
 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a19">AC_GENERAL_MODE</a>&nbsp;&nbsp;&nbsp;8</td></tr>
 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a20">FOREACH_MOD</a>&nbsp;&nbsp;&nbsp;for (int i = 0; i &lt;= <a class="el" href="modules_8cpp.html#a1">MODCOUNT</a>; i++) modules[i]-&gt;</td></tr>
 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a21">FOREACH_RESULT</a>(x)</td></tr>
+<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a22">CONF_NOT_A_NUMBER</a>&nbsp;&nbsp;&nbsp;0x000010</td></tr>
+<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a23">CONF_NOT_UNSIGNED</a>&nbsp;&nbsp;&nbsp;0x000080</td></tr>
+<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a24">CONF_VALUE_NOT_FOUND</a>&nbsp;&nbsp;&nbsp;0x000100</td></tr>
+<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a25">CONF_FILE_NOT_FOUND</a>&nbsp;&nbsp;&nbsp;0x000200</td></tr>
 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
-<tr><td nowrap align=right valign=top>typedef std::deque&lt; std::string &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a22">file_cache</a></td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.</em> <a href="#a22"></a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>typedef <a class="el" href="modules_8h.html#a22">file_cache</a>&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a23">string_list</a></td></tr>
-<tr><td nowrap align=right valign=top>typedef std::deque&lt; <a class="el" href="classuserrec.html">userrec</a> * &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a24">chanuserlist</a></td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Holds a list of users in a channel.</em> <a href="#a24"></a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>typedef DLLFactory&lt; <a class="el" href="classModuleFactory.html">ModuleFactory</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a25">ircd_module</a></td></tr>
+<tr><td nowrap align=right valign=top>typedef std::deque&lt; std::string &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a26">file_cache</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.</em> <a href="#a26"></a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>typedef <a class="el" href="modules_8h.html#a26">file_cache</a>&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a27">string_list</a></td></tr>
+<tr><td nowrap align=right valign=top>typedef std::deque&lt; <a class="el" href="classuserrec.html">userrec</a> * &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a28">chanuserlist</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Holds a list of users in a channel.</em> <a href="#a28"></a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>typedef DLLFactory&lt; <a class="el" href="classModuleFactory.html">ModuleFactory</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a29">ircd_module</a></td></tr>
 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
-<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a26">createcommand</a> (char *cmd, handlerfunc f, char flags, int minparams)</td></tr>
-<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a27">server_mode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a30">createcommand</a> (char *cmd, handlerfunc f, char flags, int minparams)</td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a31">server_mode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 </table>
 <hr><h2>Define Documentation</h2>
 <a name="a17" doxytag="modules.h::AC_DEHALFOP"></a><p>
@@ -370,6 +374,110 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00304">Module::OnAcc
 Definition at line <a class="el" href="modules_8h-source.html#l00028">28</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
   </tr>
 </table>
+<a name="a25" doxytag="modules.h::CONF_FILE_NOT_FOUND"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+  <tr>
+    <td class="md">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> #define CONF_FILE_NOT_FOUND&nbsp;&nbsp;&nbsp;0x000200
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="modules_8h-source.html#l00609">609</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#l00553">ConfigReader::ConfigReader()</a>.    </td>
+  </tr>
+</table>
+<a name="a22" doxytag="modules.h::CONF_NOT_A_NUMBER"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+  <tr>
+    <td class="md">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> #define CONF_NOT_A_NUMBER&nbsp;&nbsp;&nbsp;0x000010
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="modules_8h-source.html#l00606">606</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#l00610">ConfigReader::ReadInteger()</a>.    </td>
+  </tr>
+</table>
+<a name="a23" doxytag="modules.h::CONF_NOT_UNSIGNED"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+  <tr>
+    <td class="md">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> #define CONF_NOT_UNSIGNED&nbsp;&nbsp;&nbsp;0x000080
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="modules_8h-source.html#l00607">607</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#l00610">ConfigReader::ReadInteger()</a>.    </td>
+  </tr>
+</table>
+<a name="a24" doxytag="modules.h::CONF_VALUE_NOT_FOUND"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+  <tr>
+    <td class="md">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> #define CONF_VALUE_NOT_FOUND&nbsp;&nbsp;&nbsp;0x000100
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="modules_8h-source.html#l00608">608</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#l00593">ConfigReader::ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00610">ConfigReader::ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00577">ConfigReader::ReadValue()</a>.    </td>
+  </tr>
+</table>
 <a name="a0" doxytag="modules.h::DEBUG"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
@@ -631,7 +739,7 @@ Definition at line <a class="el" href="modules_8h-source.html#l00014">14</a> of
   </tr>
 </table>
 <hr><h2>Typedef Documentation</h2>
-<a name="a24" doxytag="modules.h::chanuserlist"></a><p>
+<a name="a28" doxytag="modules.h::chanuserlist"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
     <td class="md">
@@ -659,7 +767,7 @@ Definition at line <a class="el" href="modules_8h-source.html#l00055">55</a> of
 Referenced by <a class="el" href="modules_8cpp-source.html#l00349">Server::GetUsers()</a>.    </td>
   </tr>
 </table>
-<a name="a22" doxytag="modules.h::file_cache"></a><p>
+<a name="a26" doxytag="modules.h::file_cache"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
     <td class="md">
@@ -684,10 +792,10 @@ Low level definition of a <a class="el" href="classFileReader.html">FileReader</
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00050">50</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#l00601">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00612">FileReader::LoadFile()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00663">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00674">FileReader::LoadFile()</a>.    </td>
   </tr>
 </table>
-<a name="a25" doxytag="modules.h::ircd_module"></a><p>
+<a name="a29" doxytag="modules.h::ircd_module"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
     <td class="md">
@@ -708,16 +816,16 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00601">FileReader::F
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8h-source.html#l00740">740</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
+Definition at line <a class="el" href="modules_8h-source.html#l00766">766</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
   </tr>
 </table>
-<a name="a23" doxytag="modules.h::string_list"></a><p>
+<a name="a27" doxytag="modules.h::string_list"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
     <td class="md">
       <table cellpadding="0" cellspacing="0" border="0">
         <tr>
-          <td class="md" nowrap valign="top"> typedef <a class="el" href="modules_8h.html#a22">file_cache</a> string_list
+          <td class="md" nowrap valign="top"> typedef <a class="el" href="modules_8h.html#a26">file_cache</a> string_list
       </table>
     </td>
   </tr>
@@ -738,7 +846,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00306">Module::OnCha
   </tr>
 </table>
 <hr><h2>Function Documentation</h2>
-<a name="a26" doxytag="modules.h::createcommand"></a><p>
+<a name="a30" doxytag="modules.h::createcommand"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
     <td class="md">
@@ -790,7 +898,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00306">Module::OnCha
 Referenced by <a class="el" href="modules_8cpp-source.html#l00394">Server::AddCommand()</a>.    </td>
   </tr>
 </table>
-<a name="a27" doxytag="modules.h::server_mode"></a><p>
+<a name="a31" doxytag="modules.h::server_mode"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
     <td class="md">
@@ -836,7 +944,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00394">Server::AddCo
 Referenced by <a class="el" href="modules_8cpp-source.html#l00399">Server::SendMode()</a>.    </td>
   </tr>
 </table>
-<hr><address style="align: right;"><small>Generated on Sat May 1 17:50:15 2004 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Sat May 1 20:57:55 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>