From 4e9f3d169285127e60dc9e0437925c90600bfe05 Mon Sep 17 00:00:00 2001
From: brain
Date: Wed, 25 May 2005 22:01:10 +0000
Subject: Added parameters
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1522 e03df62e-2008-0410-955e-edbf42e46eb7
---
docs/module-doc/classExtensible.html | 29 +++++++++++++++++++++++++----
1 file changed, 25 insertions(+), 4 deletions(-)
(limited to 'docs/module-doc/classExtensible.html')
diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html
index 8e3371ba5..393ef362b 100644
--- a/docs/module-doc/classExtensible.html
+++ b/docs/module-doc/classExtensible.html
@@ -86,7 +86,15 @@ Definition at line 50 of fil
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.
+
- Parameters:
-
+
+ | key | The key parameter is an arbitary string which identifies the extension data |
+ | p | This parameter is a pointer to any data you wish to associate with the object |
+
+
+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.
+
- Returns:
- Returns true on success, false if otherwise
+
@@ -117,7 +125,13 @@ You must provide a key to store the data as, and a void* to the data (typedef Vo
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.
+
- Parameters:
-
+
+ | key | The key parameter is an arbitary string which identifies the extension data |
+
+
+- Returns:
- If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.
+
@@ -148,7 +162,14 @@ You must provide a key name, which is case sensitive. If you provide a non-exist
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.
+
- Parameters:
-
+
+ | key | The key parameter is an arbitary string which identifies the extension data |
+
+
+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:
- Returns true on success.
+
Member Data Documentation
@@ -180,7 +201,7 @@ Definition at line 54 of fil
The documentation for this class was generated from the following file:
-
Generated on Tue May 24 02:31:59 2005 for InspIRCd by
+
Generated on Wed May 25 21:43:11 2005 for InspIRCd by
1.3.3
--
cgit v1.3.1-10-gc9f91