Sync with tizen_2.2.1
[platform/framework/native/appfw.git] / inc / FBaseColMultiHashMap.h
index 681ccc8..78e728b 100644 (file)
@@ -28,7 +28,6 @@
 #include <FBaseColIHashCodeProvider.h>
 #include <FBaseColIMultiMap.h>
 
-
 namespace Tizen { namespace Base { namespace Collection
 {
 
@@ -116,7 +115,7 @@ public:
         * @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
+        * @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()
@@ -142,7 +141,7 @@ public:
         * @param[in]   loadFactor              The maximum ratio of elements to buckets
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
-        *                                                                the @c capacity or the @c loadFactor is negative.
+        *                                                              the @c capacity or the @c loadFactor is negative.
         * @remarks             The GetHashCode() method of the key object is used for hashing and the
         *                              Equals() method of the key object is used for comparing the keys.
         * @see                 MultiHashMap()
@@ -183,7 +182,7 @@ public:
         * @param[in]   comparer        An instance of the IComparer derived class to use when comparing keys
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
-        *                                                                the @c capacity or the @c loadFactor is negative.
+        *                                                              the @c capacity or the @c loadFactor is negative.
         * @remarks             The instances of hash code provider and comparer will not be deallocated later from this map.
         * @see                 MultiHashMap()
         */
@@ -238,7 +237,7 @@ public:
         * @return              An enumerator (an instance of the IEnumerator derived class) of this map, @n
         *                              else @c null if some exception occurs
         * @remarks             If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
-        *                      The specific error code can be accessed using the GetLastResult() method.
+        *                              The specific error code can be accessed using the GetLastResult() method.
         * @see                 IMapEnumerator
         */
        virtual IEnumerator* GetEnumeratorN(void) const;
@@ -251,7 +250,7 @@ public:
         * @return              An enumerator (an instance of the IMapEnumerator derived class) of this map, @n
         *                              else @c null if some exception occurs
         * @remarks             If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
-        *              The specific error code can be accessed using the GetLastResult() method.
+        *                      The specific error code can be accessed using the GetLastResult() method.
         * @see                 IEnumerator
         */
        virtual IMapEnumerator* GetMapEnumeratorN(void) const;
@@ -263,7 +262,7 @@ public:
         *
         * @return              An enumerator (an instance of the IEnumerator derived class) of the values associated with the specified key, @n
         *                              else @c null if some exception occurs
-        * @param[in]   key     A key to locate
+        * @param[in]   key                             A key to locate
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           A specified input parameter is invalid, or
         *                                                                      the comparer has failed to compare the keys.
@@ -280,7 +279,7 @@ public:
         *
         * @return              A list of all unique keys in this map
         * @remarks             The %IList stores just the pointers to the elements in the map, not the elements themselves.
-        *                      The specific error code can be accessed using the GetLastResult() method.
+        *                              The specific error code can be accessed using the GetLastResult() method.
         * @see                 GetValuesN()
         */
        virtual IList* GetKeysN(void) const;
@@ -292,7 +291,7 @@ public:
         *
         * @return              A list of all the values in this map
         * @remarks             The IList stores just the pointers to the elements in the map, not the elements themselves.
-        *                      The specific error code can be accessed using the GetLastResult() method.
+        *                              The specific error code can be accessed using the GetLastResult() method.
         * @see                 GetKeysN()
         */
        virtual IList* GetValuesN(void) const;
@@ -303,7 +302,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   key The key to remove
+        * @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
         *                                                                      the comparer has failed to compare keys.
@@ -318,7 +317,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   key The key whose mapping is to remove from the map
+        * @param[in]   key             The key whose mapping is to remove from the map
         * @param[in]   value   The value to remove
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           A specified input parameter is invalid, or
@@ -344,8 +343,8 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   key             The key for which the associated value needs to replace
-        * @param[in]   value   The value to replace
+        * @param[in]   key                     The key for which the associated value needs to replace
+        * @param[in]   value           The value to replace
         * @param[in]   pNewValue       The pointer to new value to replace the existing value
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           A specified input parameter is invalid, or
@@ -388,8 +387,8 @@ public:
         *
         * @return              @c true if the map contains the specified key and value pair, @n
         *                              else @c false
-        * @param[in]   key     The key to locate
-        * @param[in]   value   The value to locate
+        * @param[in]   key             The key to locate
+        * @param[in]   value   The value to locate
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
@@ -406,7 +405,7 @@ public:
         *
         * @return              @c true if the map contains the specified key, @n
         *                              else @c false
-        * @param[in]   key     The key to locate
+        * @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
         *                                                              the comparer has failed to compare the keys.
@@ -482,7 +481,7 @@ private:
         * Copies all the pairs from the specified map to this map.
         *
         * @return              An error code
-        * @param[in]   map The map to copy
+        * @param[in]   map                                     The map to copy
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation. @n
         *                                                                      The @c map is modified during the operation of this method.
@@ -505,7 +504,7 @@ private:
         * @return              An error code
         * @param[in]   newCapacity             The new capacity @n
         *                                                              It must be a power of two and be greater than current capacity.
-        * @exception   E_SUCCESS                       The method is successful.
+        * @exception   E_SUCCESS               The method is successful.
         */
        result Resize(int newCapacity);