[2.2.1] Apply reviewed header file (Base to Collection)

[platform/framework/native/appfw.git] / inc / FBaseColRandomIteratorT.h

diff --git a/inc/FBaseColRandomIteratorT.h b/inc/FBaseColRandomIteratorT.h
index cdfae6d..ad9b725 100644 (file)
--- a/inc/FBaseColRandomIteratorT.h
+++ b/inc/FBaseColRandomIteratorT.h
@@ -35,12 +35,12 @@ namespace Tizen { namespace Base { namespace Collection
 /**
  * @class      RandomIteratorT
  * @brief      This class provides a random iterator that is used to convert %IList to STL containers. @n
- *                     %StlConverter provides static methods to get this random iterator from %IList.
+ *                     %StlConverter provides static methods to get this random iterator from IList.
  *
  * @since      2.1
  *
- * @remarks    The %RandomIteratorT 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 %RandomIteratorT class satisfies only the requirements of the C++ standard library InputIterator concept due to the 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 %RandomIteratorT class provides a random iterator that is used to convert IList to STL containers.
  * StlConverter provides static methods to get this random iterator from IList.
@@ -57,8 +57,8 @@ public:
         * @since               2.1
         *
         * @param[in]   list    A reference to the IList instance to convert
-        * @param[in]   index   A start index
-        * @remarks             %RandomIteratorT only supports random accessible collection for performance.
+        * @param[in]   index   The starting index
+        * @remarks             %RandomIteratorT only supports random accessible collection for its performance.
         * @see                 Tizen::Base::Collection::IList::IsRandomAccessible()
         */
        explicit RandomIteratorT(const IList& list, int index = 0)
@@ -130,8 +130,10 @@ public:
         *
         * @return              A reference to the %RandomIteratorT instance
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_OUT_OF_RANGE          The specified index is outside the bounds of the data structure,
-        *                                                                      or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+        * @exception   E_OUT_OF_RANGE          Either of the following conditions has occurred:
+        *                                                                      - The specified @c index is outside the bounds of the data structure.
+        *                                                                      - The specified @c index is either greater than or equal to the number of elements in the list.
+        *                                                                      - The specified @c index is less than @c 0.
         * @remarks             The specific error code can be accessed using GetLastResult() method.
         */
        RandomIteratorT< T >& operator ++(void)
@@ -151,8 +153,10 @@ public:
         *
         * @return              A %RandomIteratorT instance
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_OUT_OF_RANGE          The specified index is outside the bounds of the data structure,
-        *                                                                      or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+        * @exception   E_OUT_OF_RANGE          Either of the following conditions has occurred:
+        *                                                                      - The specified @c index is outside the bounds of the data structure.
+        *                                                                      - The specified @c index is either greater than or equal to the number of elements in the list.
+        *                                                                      - The specified @c index is less than @c 0.
         * @remarks             The specific error code can be accessed using GetLastResult() method.
         */
        RandomIteratorT< T > operator ++(int)
@@ -163,14 +167,16 @@ public:
        }
 
        /**
-        * Decrease __index by 1.
+        * Decreases __index by 1.
         *
         * @since               2.1
         *
         * @return              A reference to the %RandomIteratorT instance
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_OUT_OF_RANGE          The specified index is outside the bounds of the data structure,
-        *                                                                      or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+        * @exception   E_OUT_OF_RANGE          Either of the following conditions has occurred:
+        *                                                                      - The specified @c index is outside the bounds of the data structure.
+        *                                                                      - The specified @c index is either greater than or equal to the number of elements in the list.
+        *                                                                      - The specified @c index is less than @c 0.
         * @remarks             The specific error code can be accessed using GetLastResult() method.
         */
        RandomIteratorT< T >& operator --(void)
@@ -184,14 +190,16 @@ public:
        }
 
        /**
-        * Decrease __index by 1 and returns the previous state.
+        * Decreases __index by 1 and returns the previous state.
         *
         * @since               2.1
         *
         * @return              A %RandomIteratorT instance
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_OUT_OF_RANGE          The specified index is outside the bounds of the data structure,
-        *                                                                      or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+        * @exception   E_OUT_OF_RANGE          Either of the following conditions has occurred:
+        *                                                                      - The specified @c index is outside the bounds of the data structure.
+        *                                                                      - The specified @c index is either greater than or equal to the number of elements in the list.
+        *                                                                      - The specified @c index is less than @c 0.
         * @remarks             The specific error code can be accessed using GetLastResult() method.
         */
        RandomIteratorT< T > operator --(int)
@@ -230,11 +238,11 @@ public:
        }
 
        /**
-        *  Checks l-value is less than r-value.
+        *  Checks whether the l-value is less than the r-value.
         *
         *      @since          2.1
         *
-        *      @return         @c true if l-value of the specified %RandomIteratorT instance is less than the calling instance's members, @n
+        *      @return         @c true if the l-value of the specified %RandomIteratorT instance is less than the calling instance's members, @n
         *                              else @c false
         *      @param[in]      rhs     A reference to the %RandomIteratorT instance on the right-hand side of the operator
         */
@@ -244,11 +252,11 @@ public:
        }
 
        /**
-        *      Checks whether l-value is greater than r-value.
+        *      Checks whether the l-value is greater than the r-value.
         *
         *      @since          2.1
         *
-        *      @return         @c true if l-value of the specified %RandomIteratorT instance is greater than the calling instance's members, @n
+        *      @return         @c true if the l-value of the specified %RandomIteratorT instance is greater than the calling instance's members, @n
         *                              else @c false
         *      @param[in]      rhs     A reference to the %RandomIteratorT instance on the right-hand side of the operator
         */
@@ -258,15 +266,17 @@ public:
        }
 
        /**
-        * Increases __index as specified by the diff parameter.
+        * Increases __index as specified by the @c diff parameter.
         *
         * @since               2.1
         *
         * @return              A %RandomIteratorT instance
         * @param[in]   diff                            The length to move forward
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_OUT_OF_RANGE          The specified index is outside the bounds of the data structure,
-        *                                                                      or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+        * @exception   E_OUT_OF_RANGE          Either of the following conditions has occurred:
+        *                                                                      - The specified @c index is outside the bounds of the data structure.
+        *                                                                      - The specified @c index is either greater than or equal to the number of elements in the list.
+        *                                                                      - The specified @c index is less than @c 0.
         * @remarks             The specific error code can be accessed using GetLastResult() method.
         */
        RandomIteratorT< T > operator +(int diff)
@@ -281,15 +291,17 @@ public:
        }
 
        /**
-        * Decrease __index as specified by the diff parameter.
+        * Decreases __index as specified by the @c diff parameter.
         *
         * @since               2.1
         *
         * @return              A %RandomIteratorT instance
         * @param[in]   diff                            The length to move backward
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_OUT_OF_RANGE          The specified index is outside the bounds of the data structure,
-        *                                                                      or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+        * @exception   E_OUT_OF_RANGE          Either of the following conditions has occurred:
+        *                                                                      - The specified @c index is outside the bounds of the data structure.
+        *                                                                      - The specified @c index is either greater than or equal to the number of elements in the list.
+        *                                                                  - The specified @c index is less than @c 0.
         * @remarks             The specific error code can be accessed using GetLastResult() method.
         */
        RandomIteratorT< T > operator -(int diff)
@@ -314,10 +326,12 @@ public:
         * @since               2.1
         *
         * @return              A reference to the T type instance
-        * @param[in]   index                           An index to reach
+        * @param[in]   index                           The index to reach
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_OUT_OF_RANGE          The specified index is outside the bounds of the data structure,
-        *                                                                      or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+        * @exception   E_OUT_OF_RANGE          Either of the following conditions has occurred:
+        *                                                                      - The specified @c index is outside the bounds of the data structure.
+        *                                                                      - The specified @c index is either greater than or equal to the number of elements in the list.
+        *                                                                      - The specified @c index is less than @c 0.
         * @remarks             The specific error code can be accessed using GetLastResult() method.
         */
        T& operator [](int index) const
@@ -329,7 +343,7 @@ public:
        }
 
        /**
-        *      Swaps values of the two %RandomIteratorT instances.
+        *      Swaps the values of the two %RandomIteratorT instances.
         *
         *      @since          2.1
         *