From f61345bd0eed92ccc4882a190a19c902fbbfc5fb Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 30 Apr 2004 12:26:11 +0000 Subject: Added manpages, extra docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@753 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classExtensible.html | 114 ++++++++++++++++++++++++++++++++++- 1 file changed, 112 insertions(+), 2 deletions(-) (limited to 'docs/module-doc/classExtensible.html') diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html index ab505f9ed..61543dbed 100644 --- a/docs/module-doc/classExtensible.html +++ b/docs/module-doc/classExtensible.html @@ -28,6 +28,13 @@ Inheritance diagram for Extensible:

[legend]
List of all members. + + + + + + + @@ -39,7 +46,110 @@ class Extensible implements a system which allows modules to 'extend' the class

-Definition at line 38 of file base.h.

Member Data Documentation

+Definition at line 38 of file base.h.

Member Function Documentation

+

+


Public Member Functions

bool Extend (std::string key, VoidPointer p)
 Extend an Extensible class.

bool Shrink (std::string key)
 Shrink an Extensible class.

VoidPointer GetExt (std::string key)
 Get an extension item.


Private Attributes

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

+ + + +
+ + + + + + + + + + + + + + + + + + + +
bool Extensible::Extend ( std::string   key,
VoidPointer   p
) 
+
+ + + + + +
+   + + +

+Extend an Extensible class. +

+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, Extensible::Extend will return false in this case. On successful extension, Extend returns true.

+

+ + + + +
+ + + + + + + + + + +
VoidPointer Extensible::GetExt ( std::string   key ) 
+
+ + + + + +
+   + + +

+Get an extension item. +

+You must provide a key name, which is case sensitive. If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.

+

+ + + + +
+ + + + + + + + + + +
bool Extensible::Shrink ( std::string   key ) 
+
+ + + + + +
+   + + +

+Shrink an Extensible class. +

+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. Returns true on success.

+

Member Data Documentation

@@ -68,7 +178,7 @@ Definition at line 42 of fil

The documentation for this class was generated from the following file: -
Generated on Thu Apr 29 16:30:49 2004 for InspIRCd by +
Generated on Fri Apr 30 13:23:30 2004 for InspIRCd by doxygen1.3-rc3
-- cgit v1.2.3