Merge "[2.2.1][P130807-00904] Fail to get the host of the uri which has only ? charac...
[platform/framework/native/appfw.git] / inc / FBaseColIMapT.h
index 252674f..7d8ca4d 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 IMapT
- * @brief      This interface abstracts a template-based collection of key-value pairs.
+ * @interface  IMapT
+ * @brief              This interface abstracts a template-based collection of key-value pairs.
  *
  * @since 2.0
  *
@@ -70,18 +68,18 @@ public:
         * @param[in]   value   The corresponding value to add
         * @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.
+        *                                                                      the comparer has failed to compare the keys.
         * @exception   E_OBJ_ALREADY_EXIST     The specified @c key already exists.
         * @see Remove()
         */
        virtual result Add(const KeyType& key, const ValueType& value) = 0;
 
        /**
-        * Gets the value associated with the specified key.
+        * Gets the value associated with the specified @c key.
         *
         * @since 2.0
         *
-        * @return              The value associated with the specified key, @n
+        * @return              The value associated with the specified @c key, @n
         *                              else @c null if an exception occurs
         * @param[in]   key             The key to find the associated value
         * @param[out]  value   The value associated with the key
@@ -94,7 +92,7 @@ public:
        virtual result GetValue(const KeyType& key, ValueType& value) const = 0;
 
        /**
-        * Gets the value associated with the specified key.
+        * Gets the value associated with the specified @c key.
         *
         * @since 2.0
         *
@@ -139,12 +137,12 @@ public:
        virtual IListT< ValueType >* GetValuesN(void) const = 0;
 
        /**
-        * Removes the value associated with the specified key.
+        * Removes the value associated with the specified @c key.
         *
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   key The key for which the value is to remove
+        * @param[in]   key                             The key for which the value is 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.
@@ -161,7 +159,7 @@ public:
        virtual void RemoveAll(void) = 0;
 
        /**
-        * Replaces the value associated with the specified key with the specified value.
+        * Replaces the value associated with the specified @c key with the specified @c value.
         *
         * @since 2.0
         *
@@ -179,16 +177,16 @@ public:
        virtual result SetValue(const KeyType& key, const ValueType& value) = 0;
 
        /**
-        * Checks whether the map contains the specified key.
+        * Checks whether the map contains the specified @c key.
         *
         * @since 2.0
         *
         * @return              An error code
         * @param[in]   key             The key to locate
-        * @param[out]  out     Set to @c true if the map contains the specified key, @n
+        * @param[out]  out     Set to @c true if the map contains the specified @c key, @n
         *                                              else @c false
-        * @exception   E_SUCCESS               The method is successful. @n
-        *                                                              The map contains the specified key.
+        * @exception   E_SUCCESS               The method is successful, or
+        *                                                              the map contains the specified @c key.
         * @exception   E_INVALID_ARG   A specified input parameter is invalid, or
         *                                                              the comparer has failed to compare the keys.
         * @see                 ContainsValue()
@@ -196,11 +194,11 @@ public:
        virtual result ContainsKey(const KeyType& key, bool& out) const = 0;
 
        /**
-        * 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
         *