X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColIteratorT.h;h=9aeeed4a29517fd54dc9b6cc32d6d55cfc3dca8c;hb=07744f597c745d14286c4073d14ae6cd29791feb;hp=4fe967aa6aa45215e7f4f0fe8981d9eed79af71b;hpb=d33cc2e9f30697fc25b132353669ecf252a2ce9e;p=platform%2Fframework%2Fnative%2Fappfw.git

diff --git a/inc/FBaseColIteratorT.h b/inc/FBaseColIteratorT.h
index 4fe967a..9aeeed4 100644
--- a/inc/FBaseColIteratorT.h
+++ b/inc/FBaseColIteratorT.h
@@ -36,13 +36,16 @@ namespace Tizen { namespace Base { namespace Collection
 {
 /**
  * @class	IteratorT
- * @brief	This class provides an iterator that is used to convert IList to STL containers.
- *			StlConverter provides static methods to get this iterator from IList.
+ * @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.
  *
  * @since	2.1
  *
- * @remarks	This class satisfies only requirements of C++ standard library InputIterator concept due to limitations of Tizen Collection.
+ * @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.
+ *
+ * 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.
  */
 
 template < typename T >
@@ -51,12 +54,12 @@ class IteratorT
 {
 public:
 	/**
-	 * Initializes this instance of %IteratorT class.
+	 * Initializes an instance of %IteratorT class.
 	 *
 	 * @since		2.1
 	 *
 	 * @param[in]	list		 A reference to the IList instance to convert
-	 * @param[in]	isPostEnd	 A boolean value to check the end
+	 * @param[in]	isPostEnd	 A boolean value to check the end of a list
 	 */
 	explicit IteratorT(const IList& list, bool isPostEnd = false)
 		: __pList(&list)
@@ -86,7 +89,7 @@ public:
 	}
 
 	/**
-	 * This is copy constructor of %IteratorT class.
+	 * This is the copy constructor of the %IteratorT class.
 	 *
 	 * @since		2.1
 	 *
@@ -113,7 +116,7 @@ public:
 	}
 
 	/**
-	 * This is assignment operator of %IteratorT class.
+	 * This is an assignment operator of the %IteratorT class.
 	 *
 	 * @since		2.1
 	 *
@@ -128,7 +131,7 @@ public:
 	}
 
 	/**
-	 * This is the indirection operator for %IteratorT class.
+	 * This is the indirection operator for the %IteratorT class.
 	 *
 	 * @since	2.1
 	 *
@@ -141,11 +144,11 @@ public:
 	}
 
 	/**
-	 * This is the structure dereference operator for %IteratorT class.
+	 * This is a structure dereference operator for the %IteratorT class.
 	 *
 	 * @since	2.1
 	 *
-	 * @return		A T type pointer equivalent to the pointer address
+	 * @return		A T type pointer that is equivalent to the pointer address
 	 */
 	T* operator->(void) const
 	{
@@ -153,14 +156,14 @@ public:
 	}
 
 	/**
-	 * Moves to the next element of the collection.
+	 * Moves to the next element in the collection.
 	 *
 	 * @since		2.1
 	 *
 	 * @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
+	 * @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.
 	 * @remarks		The specific error code can be accessed using GetLastResult() method.
 	 */
@@ -187,12 +190,11 @@ public:
 	 *
 	 * @since	2.1
 	 *
-	 * @return		An IteratorT instance
+	 * @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
+	 * @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.
-	 * @remarks		It takes O(n) time to get current Enumerate point to return. So use this operator as little as possible.
 	 * @remarks		The specific error code can be accessed using GetLastResult() method.
 	 */
 	IteratorT< T > operator++(int)
@@ -210,7 +212,7 @@ 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
+	 * @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.
 	 * @remarks		The specific error code can be accessed using GetLastResult() method.
 	 */
@@ -240,12 +242,11 @@ CATCH:
 	 *
 	 * @since		2.1
 	 *
-	 * @return		An IteratorT instance
+	 * @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
+	 * @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.
-	 * @remarks		It takes O(n) time to get current Enumerate point to return. So use this operator as little as possible.
 	 * @remarks		The specific error code can be accessed using GetLastResult() method.
 	 */
 	IteratorT< T > operator--(int)
@@ -256,7 +257,7 @@ CATCH:
 	}
 
 	/**
-	 * 	Checks the two %IteratorT instances for equality
+	 * 	Checks the two %IteratorT instances for equality.
 	 *
 	 *	@since		2.1
 	 *
@@ -295,7 +296,7 @@ CATCH:
 	 *
 	 *	@since		2.1
 	 *
-	 * 	@return		@c true if every member of the specified %IteratorT instance is not equal to the calling instance's members, @n
+	 * 	@return		@c true if any member of the specified %IteratorT instance is not equal to the calling instance's members, @n
 	 * 				else @c false
 	 * 	@param[in]	rhs 	A reference to the %IteratorT instance on the right-hand side of the operator
 	 */
@@ -305,11 +306,11 @@ CATCH:
 	}
 
 	/**
-	 * 	Exchanges values of the two %IteratorT instances
+	 * 	Swaps values of two %IteratorT instances.
 	 *
 	 *	@since		2.1
 	 *
-	 * 	@param[in]	rhs	A reference to the %IteratorT instance to swap
+	 * 	@param[in]	rhs	A reference to a %IteratorT instance to swap
 	 */
 	void swap(IteratorT< T >& rhs)
 	{