[devel_3.0_main] Cherry-pick Beautification of appfw/inc soure-code. 80665
[platform/framework/native/appfw.git] / inc / FBaseColIMultiMapT.h
index ef1c2e1..1c2a8a4 100644 (file)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
 #include <FBaseColIMapEnumeratorT.h>
 #include <FBaseColMapEntryT.h>
 
-
 namespace Tizen { namespace Base { namespace Collection
 {
 
 template< class Type > class IListT;
 
 /**
- * @interface IMultiMapT
- * @brief      This interface represents a template-based collection of key-value pairs.
+ * @interface  IMultiMapT
+ * @brief              This interface represents a template-based collection of key-value pairs.
  *
  * @since 2.0
  *
@@ -92,7 +90,7 @@ public:
         * @since 2.0
         *
         * @return              The number of values whose key matches the specified key
-        * @param[in]   key     The key to locate in the map
+        * @param[in]   key             The key to locate in the map
         * @param[out]  count   The number of values whose key matches the specified key
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           A specified input parameter is invalid, or
@@ -108,7 +106,7 @@ public:
         *
         * @return              An instance of the IEnumeratorT derived class with the values associated with the specified key, @n
         *                              else @c null if an exception occurs
-        * @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.
@@ -120,16 +118,15 @@ public:
        virtual IEnumeratorT< ValueType >* GetValuesN(const KeyType& key) const = 0;
 
        /**
-        * Gets a list of all the keys in the map.
+        * Gets a list of all unique keys in the map.
         *
         * @since 2.0
         *
-        * @return              A pointer to a list of all the keys in the map, @n
+        * @return              A pointer to a list of all unique keys in the map, @n
         *                              else @c null if an exception occurs
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_OUT_OF_MEMORY The memory is insufficient.
-        * @remarks             The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method.
-        *              The specific error code can be accessed using the GetLastResult() method.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         * @see                 GetValuesN()
         */
        virtual IListT< KeyType >* GetKeysN(void) const = 0;
@@ -154,7 +151,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   key The key whose associated values need to remove
+        * @param[in]   key                             The key whose associated values need 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 the keys.
@@ -170,7 +167,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