diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-04 22:03:32 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-04 22:03:32 +0000 |
| commit | 78a96055c428d1970ece93dfb01902ac0d1699bd (patch) | |
| tree | b0df96bae212f97c67ebf2339d40454f2283e5d3 /docs/module-doc/modules_8h-source.html | |
| parent | db6ed68db7e38e21a9ce66cecaf42006f034dc62 (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/modules_8h-source.html')
| -rw-r--r-- | docs/module-doc/modules_8h-source.html | 92 |
1 files changed, 46 insertions, 46 deletions
diff --git a/docs/module-doc/modules_8h-source.html b/docs/module-doc/modules_8h-source.html index e1848aeb4..39b1855fd 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -5,7 +5,7 @@ </head><body> <!-- Generated by Doxygen 1.3-rc3 --> <center> -<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> +<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>modules.h</h1><a href="modules_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span> 00002 <span class="comment"></span> 00003 <span class="comment"></span> @@ -136,55 +136,55 @@ 00282 <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a16">GetServerName</a>(); 00285 <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a17">GetNetworkName</a>(); 00291 <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>(); -00309 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a19">AddExtendedMode</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> default_on, <span class="keywordtype">int</span> params_when_on, <span class="keywordtype">int</span> params_when_off); -00310 -00325 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a20">AddCommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams); -00326 -00348 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a21">SendMode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user); -00349 }; -00350 -<a name="l00357"></a><a class="code" href="classConfigReader.html">00357</a> <span class="keyword">class </span><a class="code" href="classConfigReader.html">ConfigReader</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> -00358 { -00359 <span class="keyword">protected</span>: -<a name="l00362"></a><a class="code" href="classConfigReader.html#n0">00362</a> std::string <a class="code" href="classConfigReader.html#n0">fname</a>; -00363 <span class="keyword">public</span>: -00368 <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(); <span class="comment">// default constructor reads ircd.conf</span> -00372 <span class="comment"></span> <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(std::string filename); <span class="comment">// read a module-specific config</span> -00376 <span class="comment"></span> <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>(); -00381 std::string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index); -00388 <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(std::string tag); -00392 <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>(); -00393 }; -00394 +00310 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a19">AddExtendedMode</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> requires_oper, <span class="keywordtype">int</span> params_when_on, <span class="keywordtype">int</span> params_when_off); +00311 +00326 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a20">AddCommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams); +00327 +00349 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a21">SendMode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user); +00350 }; +00351 +<a name="l00358"></a><a class="code" href="classConfigReader.html">00358</a> <span class="keyword">class </span><a class="code" href="classConfigReader.html">ConfigReader</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> +00359 { +00360 <span class="keyword">protected</span>: +<a name="l00363"></a><a class="code" href="classConfigReader.html#n0">00363</a> std::string <a class="code" href="classConfigReader.html#n0">fname</a>; +00364 <span class="keyword">public</span>: +00369 <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(); <span class="comment">// default constructor reads ircd.conf</span> +00373 <span class="comment"></span> <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(std::string filename); <span class="comment">// read a module-specific config</span> +00377 <span class="comment"></span> <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>(); +00382 std::string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index); +00389 <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(std::string tag); +00393 <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>(); +00394 }; 00395 00396 -<a name="l00402"></a><a class="code" href="classFileReader.html">00402</a> <span class="keyword">class </span><a class="code" href="classFileReader.html">FileReader</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> -00403 { -<a name="l00404"></a><a class="code" href="classFileReader.html#o0">00404</a> <a class="code" href="modules_8h.html#a10">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>; -00405 <span class="keyword">public</span>: -00410 <a class="code" href="classFileReader.html#a0">FileReader</a>(); -00416 <a class="code" href="classFileReader.html#a0">FileReader</a>(std::string filename); -00420 <a class="code" href="classFileReader.html#a2">~FileReader</a>(); -00426 <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(std::string filename); -00431 <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">Exists</a>(); -00432 std::string <a class="code" href="classFileReader.html#a5">GetLine</a>(<span class="keywordtype">int</span> x); -00438 <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileSize</a>(); -00439 }; -00440 +00397 +<a name="l00403"></a><a class="code" href="classFileReader.html">00403</a> <span class="keyword">class </span><a class="code" href="classFileReader.html">FileReader</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> +00404 { +<a name="l00405"></a><a class="code" href="classFileReader.html#o0">00405</a> <a class="code" href="modules_8h.html#a10">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>; +00406 <span class="keyword">public</span>: +00411 <a class="code" href="classFileReader.html#a0">FileReader</a>(); +00417 <a class="code" href="classFileReader.html#a0">FileReader</a>(std::string filename); +00421 <a class="code" href="classFileReader.html#a2">~FileReader</a>(); +00427 <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(std::string filename); +00432 <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">Exists</a>(); +00433 std::string <a class="code" href="classFileReader.html#a5">GetLine</a>(<span class="keywordtype">int</span> x); +00439 <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileSize</a>(); +00440 }; 00441 -<a name="l00448"></a><a class="code" href="classModuleFactory.html">00448</a> <span class="keyword">class </span><a class="code" href="classModuleFactory.html">ModuleFactory</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> -00449 { -00450 <span class="keyword">public</span>: -<a name="l00451"></a><a class="code" href="classModuleFactory.html#a0">00451</a> <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { } -<a name="l00452"></a><a class="code" href="classModuleFactory.html#a1">00452</a> <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { } -00457 <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0; -00458 }; -00459 +00442 +<a name="l00449"></a><a class="code" href="classModuleFactory.html">00449</a> <span class="keyword">class </span><a class="code" href="classModuleFactory.html">ModuleFactory</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> +00450 { +00451 <span class="keyword">public</span>: +<a name="l00452"></a><a class="code" href="classModuleFactory.html#a0">00452</a> <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { } +<a name="l00453"></a><a class="code" href="classModuleFactory.html#a1">00453</a> <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { } +00458 <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0; +00459 }; 00460 -<a name="l00461"></a><a class="code" href="modules_8h.html#a12">00461</a> <span class="keyword">typedef</span> DLLFactory<ModuleFactory> <a class="code" href="modules_8h.html#a12">ircd_module</a>; -00462 -00463 <span class="preprocessor">#endif</span> -</pre></div><hr><address style="align: right;"><small>Generated on Sat Apr 3 16:36:03 2004 for InspIRCd by +00461 +<a name="l00462"></a><a class="code" href="modules_8h.html#a12">00462</a> <span class="keyword">typedef</span> DLLFactory<ModuleFactory> <a class="code" href="modules_8h.html#a12">ircd_module</a>; +00463 +00464 <span class="preprocessor">#endif</span> +</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:14 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> |