diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-11-27 01:44:46 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-11-27 01:44:46 +0000 |
| commit | cd9f9a8add02597a2998ba74b803ed3fbf81314c (patch) | |
| tree | b53e3ea035c25a0580e9b31dc31f27ee33c36c96 /docs/module-doc/classExtensible.html | |
| parent | 91755849c3bdf089f4583c119fcbb90ff99bed5b (diff) | |
Added new documentation
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1966 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classExtensible.html')
| -rw-r--r-- | docs/module-doc/classExtensible.html | 111 |
1 files changed, 53 insertions, 58 deletions
diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html index 516f0bf3a..4308465d9 100644 --- a/docs/module-doc/classExtensible.html +++ b/docs/module-doc/classExtensible.html @@ -1,82 +1,79 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> -<title>InspIRCd: Extensible class Reference</title> +<title>InspIRCd: Extensible Class Reference</title> <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.3.3 --> -<div class="qindex"><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="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> -<h1>Extensible Class Reference</h1>class Extensible is the parent class of many classes such as userrec and chanrec. +<!-- Generated by Doxygen 1.4.4-20050815 --> +<div class="qindex"><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">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<h1>Extensible Class Reference</h1><!-- doxytag: class="Extensible" --><!-- doxytag: inherits="classbase" -->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="8,157,77,184" alt=""> -<area href="classcommand__t.html" shape="rect" coords="101,157,192,184" alt=""> -<area href="classconnection.html" shape="rect" coords="216,157,301,184" alt=""> -<area href="classircd__connector.html" shape="rect" coords="325,157,434,184" alt=""> -<area href="classclassbase.html" shape="rect" coords="162,8,242,34" alt=""> -<area href="classserverrec.html" shape="rect" coords="172,232,249,258" alt=""> -<area href="classuserrec.html" shape="rect" coords="273,232,340,258" alt=""> +<area href="classchanrec.html" shape="rect" coords="7,156,76,183" alt=""> +<area href="classcommand__t.html" shape="rect" coords="100,156,191,183" alt=""> +<area href="classconnection.html" shape="rect" coords="215,156,300,183" alt=""> +<area href="classclassbase.html" shape="rect" coords="106,7,186,33" alt=""> +<area href="classuserrec.html" shape="rect" coords="224,231,291,257" 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,98,87,125" alt=""> +<area href="classclassbase.html" shape="rect" coords="7,97,87,124" 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> +<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>Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classExtensible.html#a0">Extend</a> (std::string key, char *p)</td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExtensible.html#Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29">Extend</a> (<a class="el" href="namespaceirc.html#string">std::string</a> key, char *p)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Extend an Extensible class. </em> <a href="#a0"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classExtensible.html#a1">Shrink</a> (std::string key)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Extend an Extensible class. <a href="#Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExtensible.html#Shrink_28std_3A_3Astring_20key_29">Shrink</a> (<a class="el" href="namespaceirc.html#string">std::string</a> key)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Shrink an Extensible class. </em> <a href="#a1"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="classExtensible.html#a2">GetExt</a> (std::string key)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Shrink an Extensible class. <a href="#Shrink_28std_3A_3Astring_20key_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExtensible.html#GetExt_28std_3A_3Astring_20key_29">GetExt</a> (<a class="el" href="namespaceirc.html#string">std::string</a> key)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an extension item. </em> <a href="#a2"></a><em><br><br></td></tr> -<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>std::map< std::string, char * > </td><td class="memItemRight" valign=bottom><a class="el" href="classExtensible.html#r0">Extension_Items</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an extension item. <a href="#GetExt_28std_3A_3Astring_20key_29"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">std::map< <a class="el" href="namespaceirc.html#string">std::string</a>, char * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExtensible.html#Extension_5FItems">Extension_Items</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Private data store. </em> <a href="#r0"></a><em><br><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Private data store. <a href="#Extension_5FItems"></a><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). +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#l00050">50</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Member Function Documentation</h2> -<a name="a0" doxytag="Extensible::Extend"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29"></a><!-- doxytag: member="Extensible::Extend" ref="Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29" args="(std::string key, char *p)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> bool Extensible::Extend </td> + <td class="md" nowrap valign="top">bool Extensible::Extend </td> <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">std::string </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td> <td class="mdname" nowrap> <em>key</em>, </td> </tr> <tr> - <td></td> - <td></td> + <td class="md" nowrap align="right"></td> + <td class="md"></td> <td class="md" nowrap>char * </td> <td class="mdname" nowrap> <em>p</em></td> </tr> <tr> - <td></td> + <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> - </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -88,34 +85,33 @@ Extend an Extensible class. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data </td></tr> - <tr><td valign=top><em>p</em> </td><td>This parameter is a pointer to any data you wish to associate with the object</td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data </td></tr> + <tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>This parameter is a pointer to any data you wish to associate with the object</td></tr> </table> </dl> -You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, <a class="el" href="classExtensible.html#a0">Extensible::Extend</a> will return false in this case.<p> +You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, <a class="el" href="classExtensible.html#Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29">Extensible::Extend</a> will return false in this case.<p> <dl compact><dt><b>Returns:</b></dt><dd>Returns true on success, false if otherwise</dd></dl> </td> </tr> </table> -<a name="a2" doxytag="Extensible::GetExt"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="GetExt_28std_3A_3Astring_20key_29"></a><!-- doxytag: member="Extensible::GetExt" ref="GetExt_28std_3A_3Astring_20key_29" args="(std::string key)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> char* Extensible::GetExt </td> + <td class="md" nowrap valign="top">char* Extensible::GetExt </td> <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">std::string </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td> <td class="mdname1" valign="top" nowrap> <em>key</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> - </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -127,32 +123,31 @@ Get an extension item. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data</td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data</td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.</dd></dl> </td> </tr> </table> -<a name="a1" doxytag="Extensible::Shrink"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="Shrink_28std_3A_3Astring_20key_29"></a><!-- doxytag: member="Extensible::Shrink" ref="Shrink_28std_3A_3Astring_20key_29" args="(std::string key)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> bool Extensible::Shrink </td> + <td class="md" nowrap valign="top">bool Extensible::Shrink </td> <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">std::string </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td> <td class="mdname1" valign="top" nowrap> <em>key</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> - </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -164,7 +159,7 @@ Shrink an Extensible class. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data</td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data</td></tr> </table> </dl> You must provide a key name. The given key name will be removed from the classes data. If you provide a nonexistent key (case is important) then the function will return false.<p> @@ -173,18 +168,19 @@ You must provide a key name. The given key name will be removed from the classes </tr> </table> <hr><h2>Member Data Documentation</h2> -<a name="r0" doxytag="Extensible::Extension_Items"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="Extension_5FItems"></a><!-- doxytag: member="Extensible::Extension_Items" ref="Extension_5FItems" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> std::map<std::string,char*> <a class="el" href="classExtensible.html#r0">Extensible::Extension_Items</a><code> [private]</code> + <td class="md" nowrap valign="top">std::map<<a class="el" href="namespaceirc.html#string">std::string</a>,char*> <a class="el" href="classExtensible.html#Extension_5FItems">Extensible::Extension_Items</a><code> [private]</code> </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -201,9 +197,8 @@ Definition at line <a class="el" href="base_8h-source.html#l00054">54</a> of fil </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 size="1"><address style="align: right;"><small>Generated on Mon May 30 05:16:57 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> -<img src="doxygen.png" alt="doxygen" align="middle" border=0 > -</a>1.3.3 </small></address> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address> </body> </html> |