Merge "Remove the memory leak on osp-security-service" into tizen_2.2
[platform/framework/native/appfw.git] / inc / FBaseIntegerComparer.h
index 5a1c86b..a593cd8 100644 (file)
  * @file               FBaseIntegerComparer.h
  * @brief              This is the header file for the %IntegerComparer class.
  *
- * @see                        Integer and Tizen::Base::Collection::IComparer
- *
  * This header file contains the declarations of the %IntegerComparer class.
+ *
+ * @see                        Integer
+ * @see                Tizen::Base::Collection::IComparer
  */
 #ifndef _FBASE_INTEGER_COMPARER_H_
 #define _FBASE_INTEGER_COMPARER_H_
@@ -33,11 +34,11 @@ namespace Tizen { namespace Base
 {
 /**
  *     @class  IntegerComparer
- *     @brief  This class checks for equivalence between 2 instances of the Integer type.
+ *     @brief  This class checks for equivalence between two instances of the %Integer type.
  *
  *     @since 2.0
  *
- *     The %IntegerComparer class checks for equivalence between 2 instances of the Integer type.
+ *     The %IntegerComparer class checks for equivalence between two instances of the Integer type.
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
  *
@@ -90,17 +91,17 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   obj1    The first instance of type %Integer
-        * @param[in]   obj2    The second instance of type %Integer
-        * @param[out]  cmp             The result of comparison
+        * @param[in]   obj1                    The first instance of type Integer
+        * @param[in]   obj2                    The second instance of type Integer
+        * @param[out]  cmp                             The result of the comparison
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   The specified object instances are not of the expected type.
         * @remarks     The value of @c cmp can be:
         *
         * @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 Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;