X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColIMapEnumerator.h;h=91131b2c69eafae2b0faa0f29da62fd8f548fd36;hb=20597a73bc3098301ba91a48378f3ef009c3be96;hp=f656fb9701e002dbfb05f01a833a3cd8bd858416;hpb=8add6e34504456d593983014101182e11e867b5f;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColIMapEnumerator.h b/inc/FBaseColIMapEnumerator.h index f656fb9..91131b2 100644 --- a/inc/FBaseColIMapEnumerator.h +++ b/inc/FBaseColIMapEnumerator.h @@ -26,24 +26,23 @@ #include #include - 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 HashMap and MultiHashMap. @@ -62,16 +61,16 @@ 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. */ @@ -85,9 +84,9 @@ 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. */ @@ -101,9 +100,9 @@ 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. */