summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2006-07-10 20:26:42 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2006-07-10 20:26:42 +0000
commit1b9da9797151a770dda699c75419678db4b31257 (patch)
tree00255b190568a01f77e715d8cd206f7f1400c9fe
parent57a5c3b9b33f0c7c55e7f5feee1df35de3482e16 (diff)
Update docs to indicate new templated GetExt and Extend, remove references to char* and void* pointers in here, and indicate how its now possible to store a NULL in Extensible :p
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@4306 e03df62e-2008-0410-955e-edbf42e46eb7
-rw-r--r--include/base.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/include/base.h b/include/base.h
index fa3399e29..3fa0dac6d 100644
--- a/include/base.h
+++ b/include/base.h
@@ -64,7 +64,8 @@ public:
* @param key The key parameter is an arbitary string which identifies the extension data
* @param 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)
+ * You must provide a key to store the data as via the parameter 'key' and store the data
+ * in the templated parameter 'p'.
* 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.
*
@@ -92,7 +93,8 @@ public:
/** Get an extension item.
*
* @param key The key parameter is an arbitary string which identifies the extension data
- * @return If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.
+ * @param p If you provide a non-existent key, this value will be NULL. Otherwise a pointer to the item you requested will be placed in this templated parameter.
+ * @return Returns true if the item was found and false if it was nor, regardless of wether 'p' is NULL. This allows you to store NULL values in Extensible.
*/
template<typename T> bool GetExt(const std::string &key, T* &p)
{