diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-29 15:23:02 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-29 15:23:02 +0000 |
| commit | 71e6de4b88c3d51bfa59fed44049a4d1ea6d26a1 (patch) | |
| tree | 3bbb869f7922895db64b079a8fb413b754691188 /docs/module-doc/classExtensible.html | |
| parent | 59b272674502e010d91c37ad5847e44b81574d9a (diff) | |
Documentation update for class 'Extensible'
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@749 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classExtensible.html')
| -rw-r--r-- | docs/module-doc/classExtensible.html | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html new file mode 100644 index 000000000..5ffac6fac --- /dev/null +++ b/docs/module-doc/classExtensible.html @@ -0,0 +1,73 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Extensible class Reference</title> +<link href="inspircd.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3-rc3 --> +<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>Extensible Class Reference</h1>class Extensible is the parent class of many classes such as userrec and chanrec. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="base_8h-source.html">base.h</a>></code> +<p> +Inheritance diagram for Extensible:<p><center><img src="classExtensible__inherit__graph.gif" border="0" usemap="#Extensible__inherit__map" alt="Inheritance graph"></center> +<map name="Extensible__inherit__map"> +<area href="classchanrec.html" shape="rect" coords="7,155,65,176" alt=""> +<area href="classconnection.html" shape="rect" coords="89,155,159,176" alt=""> +<area href="classclassbase.html" shape="rect" coords="47,16,113,38" alt=""> +<area href="classserverrec.html" shape="rect" coords="48,224,115,246" alt=""> +<area href="classuserrec.html" shape="rect" coords="139,224,195,246" alt=""> +</map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Extensible:<p><center><img src="classExtensible__coll__graph.gif" border="0" usemap="#Extensible__coll__map" alt="Collaboration graph"></center> +<map name="Extensible__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="classExtensible-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>std::map< std::string, <a class="el" href="base_8h.html#a0">VoidPointer</a> > </td><td valign=bottom><a class="el" href="classExtensible.html#o0">Extension_Items</a></td></tr> +<tr><td> </td><td><font size=-1><em>Private data store.</em> <a href="#o0"></a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +class Extensible is the parent class of many classes such as userrec and chanrec. +<p> +class Extensible implements a system which allows modules to 'extend' the class by attaching data within a map associated with the object. In this way modules can store their own custom information within user objects, channel objects and server objects, without breaking other modules (this is more sensible than using a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and supports arbitary data storage). +<p> + +<p> +Definition at line <a class="el" href="base_8h-source.html#l00038">38</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Member Data Documentation</h2> +<a name="o0" doxytag="Extensible::Extension_Items"></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"> std::map<std::string,<a class="el" href="base_8h.html#a0">VoidPointer</a>> Extensible::Extension_Items<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Private data store. +<p> + +<p> +Definition at line <a class="el" href="base_8h-source.html#l00042">42</a> of file <a class="el" href="base_8h-source.html">base.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="base_8h-source.html">base.h</a></ul> +<hr><address style="align: right;"><small>Generated on Thu Apr 29 16:22:03 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> +</body> +</html> |