X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColIEnumeratorT.h;h=45c07fb92efc198f5535726af2b60de2f1447c8a;hb=60d143778a54ae4c638a08d8c7304b099f70434e;hp=ad6c2f25345def102194a7b38271bd78a4720bcb;hpb=6b44196c40a66b895028f7ba2e9b5e41bc715ab2;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColIEnumeratorT.h b/inc/FBaseColIEnumeratorT.h index ad6c2f2..45c07fb 100644 --- a/inc/FBaseColIEnumeratorT.h +++ b/inc/FBaseColIEnumeratorT.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); @@ -37,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 %IEnumeratorT interface supports simple iteration over a template-based collection. * One can only access the elements in a collection through %IEnumeratorT. The elements cannot be modified through this interface. @@ -65,11 +64,13 @@ public: * @since 2.0 * * @return An error code - * @param[out] obj A pointer to the current object + * @param[out] obj A pointer to the current object * @exception E_SUCCESS The method is successful. - * @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. */ virtual result GetCurrent(Type& obj) const = 0; @@ -83,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; @@ -96,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;