From 71e6de4b88c3d51bfa59fed44049a4d1ea6d26a1 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 29 Apr 2004 15:23:02 +0000 Subject: Documentation update for class 'Extensible' git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@749 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classExtensible.html | 73 ++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 docs/module-doc/classExtensible.html (limited to 'docs/module-doc/classExtensible.html') 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 @@ + + +Extensible class Reference + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

Extensible Class Reference

class Extensible is the parent class of many classes such as userrec and chanrec. +More... +

+#include <base.h> +

+Inheritance diagram for Extensible:

Inheritance graph
+ + + + + + + +
[legend]
Collaboration diagram for Extensible:

Collaboration graph
+ + + +
[legend]
List of all members. + + + + +

Private Attributes

std::map< std::string, VoidPointer > Extension_Items
 Private data store.

+

Detailed Description

+class Extensible is the parent class of many classes such as userrec and chanrec. +

+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). +

+ +

+Definition at line 38 of file base.h.

Member Data Documentation

+

+ + + + +
+ + +
std::map<std::string,VoidPointer> Extensible::Extension_Items [private] +
+
+ + + + + +
+   + + +

+Private data store. +

+ +

+Definition at line 42 of file base.h.

+

The documentation for this class was generated from the following file: +
Generated on Thu Apr 29 16:22:03 2004 for InspIRCd by + +doxygen1.3-rc3
+ + -- cgit v1.3.1-10-gc9f91