X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColIteratorT.h;h=b380468e5644a6b430cfcd5382cbae62328d93e3;hb=60d143778a54ae4c638a08d8c7304b099f70434e;hp=67ad607fcd565dec9dc76c540c37d849875b8867;hpb=3b569ff3e66a065cb5728bc19d1da493c66f7583;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColIteratorT.h b/inc/FBaseColIteratorT.h index 67ad607..b380468 100644 --- a/inc/FBaseColIteratorT.h +++ b/inc/FBaseColIteratorT.h @@ -36,12 +36,12 @@ namespace Tizen { namespace Base { namespace Collection /** * @class IteratorT * @brief This class provides an iterator that is used to convert %IList to STL containers. @n - * %StlConverter provides static methods to get this iterator from %IList. + * %StlConverter provides static methods to get this iterator from IList. * * @since 2.1 * - * @remarks The %IteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen collection. - * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments. + * @remarks The %IteratorT class satisfies only the requirements of the C++ standard library InputIterator concept due to limitations of the %Tizen collection. @n + * This class can be used with the C++ standard library algorithms which require only the InputIterator concept for their arguments. * * The %IteratorT class provides an iterator that is used to convert IList to STL containers. * StlConverter provides static methods to get this iterator from IList. @@ -53,12 +53,12 @@ class IteratorT { public: /** - * Initializes an instance of %IteratorT class. + * Initializes an instance of %IteratorT. * * @since 2.1 * * @param[in] list A reference to the IList instance to convert - * @param[in] isPostEnd A boolean value to check the end of a list + * @param[in] isPostEnd The boolean value that checks the end of the list */ explicit IteratorT(const IList& list, bool isPostEnd = false) : __pList(&list) @@ -115,7 +115,7 @@ public: } /** - * This is an assignment operator of the %IteratorT class. + * This is the assignment operator of the %IteratorT class. * * @since 2.1 * @@ -130,7 +130,7 @@ public: } /** - * This is the indirection operator for the %IteratorT class. + * This is the indirection operator of the %IteratorT class. * * @since 2.1 * @@ -143,7 +143,7 @@ public: } /** - * This is a structure dereference operator for the %IteratorT class. + * This is the structure dereference operator of the %IteratorT class. * * @since 2.1 * @@ -162,8 +162,9 @@ public: * @return A reference to the %IteratorT type instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @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. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T >& operator ++(void) @@ -193,8 +194,9 @@ CATCH: * @return An %IteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @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. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T > operator ++(int) @@ -212,8 +214,9 @@ CATCH: * @return A reference to the %IteratorT type instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @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. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T >& operator --(void) @@ -245,8 +248,9 @@ CATCH: * @return An %IteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @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. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T > operator --(int)