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

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

diff --git a/inc/FBaseColIMapEnumerator.h b/inc/FBaseColIMapEnumerator.h
index 29c90ee..91131b2 100644 (file)
--- a/inc/FBaseColIMapEnumerator.h
+++ b/inc/FBaseColIMapEnumerator.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -27,24 +26,23 @@
 #include <FBaseColIEnumerator.h>
 #include <FBaseObject.h>
 
-
 namespace Tizen { namespace Base { namespace Collection
 {
 
 class MapEntry;
 
 /**
- * @interface IMapEnumerator
- * @brief      This interface supports simple iteration over a map.
+ * @interface  IMapEnumerator
+ * @brief              This interface supports a simple iteration over a map.
  *
  * @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 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 %IMapEnumerator interface supports simple iteration over a map.
+ * The %IMapEnumerator interface supports a simple iteration over a map.
  * One can only access the elements in a collection through %IMapEnumerator. The elements cannot be modified through this interface.
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
@@ -63,19 +61,18 @@ public:
        virtual ~IMapEnumerator(void) {}
 
        /**
-        * Gets the current object from the collection.
+        * Gets the current object in the collection.
         *
         * @since 2.0
         *
         * @return              A pointer to 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
-        *                                                                      - The enumerator is currently positioned before the first element or after the last element. @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.
         *                                                                      - The collection is modified after the enumerator is created.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                 GetLastResult()
         */
        virtual Object* GetCurrent(void) const = 0;
 
@@ -87,12 +84,11 @@ public:
         * @return              A pointer to the current key in the map, @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
-        *                                                                      - The enumerator is currently positioned before the first element or after the last element. @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.
         *                                                                      - The collection is modified after the enumerator is created.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                         GetLastResult()
         */
        virtual Object* GetKey(void) const = 0;
 
@@ -104,12 +100,11 @@ public:
         * @return              A pointer to the current value in the map, @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
-        *                                                                      - The enumerator is currently positioned before the first element or after the last element. @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.
         *                                                                      - The collection is modified after the enumerator is created.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
-        * @see                         GetLastResult()
         */
        virtual Object* GetValue(void) const = 0;