Sync with tizen_2.2.1
[platform/framework/native/appfw.git] / inc / FBaseColIEnumerator.h
index e917dd5..7b18e17 100644 (file)
@@ -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 %IEnumerator interface supports simple iteration over a collection.
  * One can only access the elements in a collection through %IEnumerator. The elements cannot be modified through this interface.
@@ -65,13 +65,12 @@ public:
         * @return              The current object in the collection, @n
         *                              else @c null if an exception occurs
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_INVALID_OPERATION     Either of the following conditions has occurred: @n
-        *                                                                      - The current state of the instance prohibits the execution of the specified operation. @n
+        * @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. @n
+        *                                                                        or after the last element.
         *                                                                      - The collection is modified after the enumerator is created.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                 GetLastResult()
         */
        virtual Tizen::Base::Object* GetCurrent(void) const = 0;
 
@@ -85,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;
 
@@ -98,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;