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 --- include/base.h | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) (limited to 'include/base.h') diff --git a/include/base.h b/include/base.h index c959cf869..d253c5dc3 100644 --- a/include/base.h +++ b/include/base.h @@ -56,23 +56,34 @@ class Extensible : public classbase public: /** Extend an Extensible class. + * + * @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) * 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. + * + * @return Returns true on success, false if otherwise */ bool Extend(std::string key, char* p); /** Shrink an Extensible class. + * + * @param 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 true on success. + * + * @return Returns true on success. */ bool Shrink(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. + * + * @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. */ char* GetExt(std::string key); }; -- cgit v1.2.3