[2.2.1] Apply reviewed header file (Base to Collection)
[platform/framework/native/appfw.git] / inc / FBaseColIBidirectionalEnumerator.h
index 371ad85..05449db 100644 (file)
@@ -36,13 +36,13 @@ 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(), MovePrevious(), Reset(), or ResetLast() fails (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(), MovePrevious(), Reset(), or ResetLast() fails (@c E_INVALID_OPERATION).
  *
  * The %IBidirectionalEnumerator interface supports a bidirectional iteration over a collection.
- *     One can only access the elements in a collection through %IBidirectionalEnumerator. The elements cannot be modified through this interface.
+ * One can only access the elements in a collection through %IBidirectionalEnumerator. The elements cannot be modified through this interface.
  */
 class _OSP_EXPORT_ IBidirectionalEnumerator
        : public virtual IEnumerator
@@ -58,17 +58,17 @@ public:
 
        /**
         * Moves %IBidirectionalEnumerator to the previous element of the collection. @n
-        * A call to the MovePrevious() method after the ResetLast() method positions the enumerator to the last element in the collection.
+        * A call to the %MovePrevious() method after the ResetLast() method, positions the enumerator to the last element in the collection.
         *
         * @since 2.0
         *
         * @return              An error code
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_OUT_OF_RANGE          The enumerator has passed the front 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.
+        * @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.
         * @see                 Tizen::Base::Collection::IEnumerator::MoveNext()
-        * @see                 ResetLast()
         */
        virtual result MovePrevious(void) = 0;
 
@@ -79,8 +79,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.
         * @see                 Tizen::Base::Collection::IEnumerator::Reset()
         * @see                 MovePrevious()
         */