//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
* delete pMapEnum;
*
* // Deallocates all objects
- * // Because the destructor calls RemoveAll() internally, you don't need to call RemoveAll() to destroy all elements at the end.
- * map.RemoveAll();
- *
+ * // Because the destructor calls RemoveAll() internally, you do not need to call RemoveAll() to destroy all elements at the end.
+ * // map.RemoveAll();
* }
* @endcode
*/
* @since 2.0
*
* @param[in] deleter The function pointer to type of the element deleter
- * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
- * It means that you don't transfer the ownership of elements to the collection.
+ * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
+ * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
+ * It means that you do not transfer the ownership of elements to the collection.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
result Construct(int capacity = 16, float loadFactor = 0.75);
/**
- * Initializes an instance of a %HashMap class by copying the elements of the specified map.
+ * Initializes an instance of a %HashMap class by copying the elements of the specified @c map.
*
* @since 2.0
*
result Construct(int capacity, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer);
/**
- * Initializes an instance of a %HashMap class by copying the elements of a specified map with a specified load factor, hash code provider, and comparer.
+ * Initializes an instance of a %HashMap class by copying the elements of the specified map with the specified load factor, hash code provider, and comparer.
*
* @since 2.0
*
virtual IMapEnumerator* GetMapEnumeratorN(void) const;
/**
- * Gets the value associated with the specified key.
+ * Gets the value associated with the specified @c key.
*
* @since 2.0
*
* else @c null if an exception occurs
* @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
+ * @exception E_INVALID_ARG The specified input parameter is invalid, or
* the comparer has failed to compare the keys.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
* @remarks The specific error code can be accessed using the GetLastResult() method.
virtual const Object* GetValue(const Object& key) const;
/**
- * Gets the value associated with the specified key.
+ * Gets the value associated with the specified @c key.
*
* @since 2.0
*
virtual IList* GetValuesN(void) const;
/**
- * Removes the values associated with a specified key.
+ * Removes the values associated with the specified @c key.
*
* @since 2.0
*
* @return An error code
* @param[in] key The key to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
+ * @exception E_INVALID_ARG The specified input parameter is invalid, or
* the comparer has failed to compare keys.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
* @see Add()
/**
* Removes all the object pointers in the collection. @n
- * This method can be called before deleting a collection.
+ * The %RemoveAll() method can be called before deleting a collection.
*
* @since 2.0
*/
virtual void RemoveAll(void);
/**
- * Sets the value associated with a specified key by allocating it a new value.
+ * Sets the value associated with the specified @c key by allocating it a new value.
*
* @since 2.0
*
virtual int GetCount(void) const;
/**
- * Checks whether the map contains the specified key.
+ * Checks whether the map contains the specified @c key.
*
* @since 2.0
*
- * @return @c true if the map contains the specified key, @n
+ * @return @c true if the map contains the specified @c key, @n
* else @c false
* @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
+ * @exception E_INVALID_ARG The specified input parameter is invalid, or
* the comparer has failed to compare the keys.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ContainsValue()
virtual bool ContainsKey(const Object& key) const;
/**
- * Checks whether the map contains the specified value.
+ * Checks whether the map contains the specified @c value.
*
* @since 2.0
*
- * @return @c true if the map contains the specified value, @n
+ * @return @c true if the map contains the specified @c value, @n
* else @c false
* @param[in] value The value to locate
*
*
* @since 2.0
*
- * @return An function pointer to the existing element deleter
+ * @return A function pointer to the existing element deleter
*/
virtual DeleterFunctionType GetDeleter(void) const;
HashMap& operator =(const HashMap& map);
/**
- * Copies all the pairs from a specified map to this map
+ * Copies all the pairs from the specified @c map to this map.
*
* @return An error code
* @param[in] map The map to copy
result AddAll(const IMap& map);
/**
- * Gets the hash value for a specified object.
+ * Gets the hash value for the specified object.
*
* @return The hash value for the specified object
* @param[in] obj
*
* @since 2.0
*
- * @param[in] deleter An function pointer to the element deleter to set
+ * @param[in] deleter A function pointer to the element deleter to set
*/
virtual void SetDeleter(DeleterFunctionType deleter);
projects / platform / framework / native / appfw.git / blobdiff