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

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

diff --git a/inc/FBaseColIEnumeratorT.h b/inc/FBaseColIEnumeratorT.h
index d26de5f..45c07fb 100644 (file)
--- a/inc/FBaseColIEnumeratorT.h
+++ b/inc/FBaseColIEnumeratorT.h
@@ -36,11 +36,11 @@ namespace Tizen { namespace Base { namespace Collection
  *
  * @since 2.0
  *
- * @remarks
- * An enumerator remains valid as long as the collection remains unchanged.
- * If changes are made to the collection, such as adding, modifying, or
- * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), or Reset() fails and returns
- * E_INVALID_OPERATION.
+ * @remarks    An enumerator remains valid as long as the collection remains unchanged. @n
+ *                             If changes are made to the collection, such as adding, modifying, or
+ *                             deleting elements, the enumerator is irrecoverably invalidated. @n
+ *                             The next call to GetCurrent(), MoveNext(), or Reset() fails and returns
+ *                             @c E_INVALID_OPERATION.
  *
  * The %IEnumeratorT interface supports simple iteration over a template-based collection.
  * One can only access the elements in a collection through %IEnumeratorT. The elements cannot be modified through this interface.
@@ -64,11 +64,13 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[out]  obj A pointer to the current object
+        * @param[out]  obj                             A pointer to the current object
         * @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 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.
         */
        virtual result GetCurrent(Type& obj) const = 0;
 
@@ -82,9 +84,9 @@ public:
         * @return              An error code
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OUT_OF_RANGE          The enumerator has passed the end of the collection.
-        * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation, or
-        *                                                                      the collection is modified after the enumerator is created.
-        * @see                 Reset()
+        * @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 collection is modified after the enumerator is created.
         */
        virtual result MoveNext(void) = 0;
 
@@ -95,8 +97,9 @@ public:
         *
         * @return              An error code
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation, 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 collection is modified after the enumerator is created.
         */
        virtual result Reset(void) = 0;