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

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

diff --git a/inc/FBaseComparerT.h b/inc/FBaseComparerT.h
index cb597e1..176c3d3 100644 (file)
--- a/inc/FBaseComparerT.h
+++ b/inc/FBaseComparerT.h
@@ -31,10 +31,10 @@ namespace Tizen { namespace Base
 /**
  * @class ComparerT
  *
- * @brief      This class checks for equivalence between 2 values of the same primitive type.
+ * @brief      This class checks for equivalence between two values of the same primitive type.
  * @since 2.0
  *
- * The %ComparerT class checks for equivalence between 2 values of the same primitive type.
+ * The %ComparerT class checks for equivalence between two values of the same primitive type.
  *
  * The following example demonstrates how to use the %ComparerT class.
  *
@@ -88,16 +88,16 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   obj1    The first object to compare
-        * @param[in]   obj2    The second object to compare
-        * @param[out]  cmp             The result of comparison
+        * @param[in]   obj1                    The first object to compare
+        * @param[in]   obj2                    The second object to compare
+        * @param[out]  cmp                             The result of the comparison
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   The specified objects are not of the expected type.
         * @remarks             @c cmp can take one of the following values:
         * @code
-        * <  0  if the value of @c obj1 is less than the value of @c obj2
-        * == 0  if the value of @c obj1 is equal to the value of @c obj2
-        * >  0  if the value of @c obj1 is greater than the value of @c obj2
+        * <  0  if the value of obj1 is less than the value of obj2
+        * == 0  if the value of obj1 is equal to the value of obj2
+        * >  0  if the value of obj1 is greater than the value of obj2
         * @endcode
         */
        virtual result Compare(const Type& obj1, const Type& obj2, int& cmp) const
@@ -152,14 +152,14 @@ public:
        virtual ~ComparerT(void) { }
 
        /**
-        * Compare two String instances.
+        * Compares two String instances.
         *
         * @since 2.1
         *
-        * @return       Always returns E_SUCCESS
+        * @return       Always returns @c E_SUCCESS
         * @param[in]    str1     The String instance to compare
         * @param[in]    str2     The String instance to compare
-        * @param[in]    cmp      An integer value for result
+        * @param[in]    cmp      The integer value for the result
         */
        virtual result Compare(const Tizen::Base::String& str1, const Tizen::Base::String& str2, int& cmp) const
        {