X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColIMapEnumeratorT.h;h=8f2242388a004760ea044ce23b72fbb6d0887af7;hb=ebb2ea372f640b8fe09dc5a85abb29bb349508fa;hp=c0724651b0221c06fc99cb603f3a845d246085b6;hpb=1b9f6ea4dd0e9a4d55f950755677bd746f519a23;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColIMapEnumeratorT.h b/inc/FBaseColIMapEnumeratorT.h index c072465..8f22423 100644 --- a/inc/FBaseColIMapEnumeratorT.h +++ b/inc/FBaseColIMapEnumeratorT.h @@ -31,17 +31,17 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface IMapEnumeratorT - * @brief This interface supports simple iteration over a template-based map. @n + * @brief This interface supports a simple iteration over a template-based map. @n * Using this method, you can only access the elements in the map. You cannot modify the elements. * * @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 @c 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 %IMapEnumeratorT interface supports simple iteration over a template-based map. + * The %IMapEnumeratorT interface supports a simple iteration over a template-based map. * Using this method, you can only access the elements in the map. You cannot modify the elements. * * For more information on the class features, see HashMap and MultiHashMap. @@ -67,8 +67,10 @@ public: * * @return An error code * @param[out] key The current key - * @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. * @exception E_SUCCESS The method is successful. */ virtual result GetKey(KeyType& key) const = 0; @@ -80,8 +82,10 @@ public: * * @return An error code * @param[out] value The current value - * @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. * @exception E_SUCCESS The method is successful. */ virtual result GetValue(ValueType& value) const = 0;