[2.2.1] Apply reviewed header file (Base to Collection)

[platform/framework/native/appfw.git] / inc / FBaseColIMapEnumeratorT.h

diff --git a/inc/FBaseColIMapEnumeratorT.h b/inc/FBaseColIMapEnumeratorT.h
index c072465..8f22423 100644 (file)
--- a/inc/FBaseColIMapEnumeratorT.h
+++ b/inc/FBaseColIMapEnumeratorT.h
@@ -31,17 +31,17 @@ namespace Tizen { namespace Base { namespace Collection
 
 /**
  * @interface  IMapEnumeratorT
- * @brief              This interface supports simple iteration over a template-based map. @n
+ * @brief              This interface supports a simple iteration over a template-based map. @n
  *                             Using this method, you can only access the elements in the map. You cannot modify the elements.
  *
  * @since 2.0
  *
- * @remarks
- * An enumerator remains valid as long as the map remains unchanged.
- * If changes are made to the map, such as adding, modifying, or
- * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an @c E_INVALID_OPERATION message.
+ * @remarks    An enumerator remains valid as long as the map remains unchanged. @n
+ *                             If changes are made to the map, such as adding, modifying, or
+ *                             deleting elements, the enumerator is irrecoverably invalidated. @n
+ *                             The next call to any method returns @c E_INVALID_OPERATION.
  *
- * The %IMapEnumeratorT interface supports simple iteration over a template-based map.
+ * The %IMapEnumeratorT interface supports a simple iteration over a template-based map.
  * Using this method, you can only access the elements in the map. You cannot modify the elements.
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
@@ -67,8 +67,10 @@ public:
         *
         * @return              An error code
         * @param[out]  key                             The current key
-        * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation. @n
-        *                                                                      The enumerator is currently positioned before the first element or after the last element or the collection is modified after the enumerator is created.
+        * @exception   E_INVALID_OPERATION     Either of the following conditions has occurred:
+        *                                                                      - The current state of the instance prohibits the execution of the specified operation.
+        *                                                                      - The enumerator is currently positioned before the first element or after the last element.
+        *                                                                      - The collection is modified after the enumerator is created.
         * @exception   E_SUCCESS                       The method is successful.
         */
        virtual result GetKey(KeyType& key) const = 0;
@@ -80,8 +82,10 @@ public:
         *
         * @return              An error code
         * @param[out]  value                           The current value
-        * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation. @n
-        *                                                                      The enumerator is currently positioned before the first element or after the last element or the collection is modified after the enumerator is created.
+        * @exception   E_INVALID_OPERATION     Either of the following conditions has occurred:
+        *                                                                      - The current state of the instance prohibits the execution of the specified operation.
+        *                                                                      - The enumerator is currently positioned before the first element or after the last element.
+        *                                                                      - The collection is modified after the enumerator is created.
         * @exception   E_SUCCESS                       The method is successful.
         */
        virtual result GetValue(ValueType& value) const = 0;