X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseFloatComparer.h;h=ff6a31d1e74cdd07651d516106ad08276ae83dd1;hb=376b1791f5888970901326fa60f67431fa701a4d;hp=54e6e43f7ca2880466fe43d3bc881243b5783a04;hpb=8f5f7c07039d34a2f4ccb9836ace7f7e0d54d08a;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseFloatComparer.h b/inc/FBaseFloatComparer.h index 54e6e43..ff6a31d 100644 --- a/inc/FBaseFloatComparer.h +++ b/inc/FBaseFloatComparer.h @@ -18,9 +18,11 @@ * @file FBaseFloatComparer.h * @brief This is the header file for the %FloatComparer class. * - * @see Float and Tizen::Base::Collection::IComparer * * This header file contains the declarations of the %FloatComparer class. + * + * @see Float + * @see Tizen::Base::Collection::IComparer */ #ifndef _FBASE_FLOAT_COMPARER_H_ #define _FBASE_FLOAT_COMPARER_H_ @@ -32,11 +34,11 @@ namespace Tizen { namespace Base { /** * @class FloatComparer - * @brief This class checks for equivalence between 2 instances of the %Float type. + * @brief This class checks for equivalence between two instances of the %Float type. * * @since 2.0 * - * The %FloatComparer class checks for equivalence between 2 instances of the Float type. + * The %FloatComparer class checks for equivalence between two instances of the Float type. * * For more information on the class features, see Collection Comparisons. * @@ -90,17 +92,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj1 The first instance of type Float - * @param[in] obj2 The second instance of type Float - * @param[out] cmp The result of comparison + * @param[in] obj1 The first instance of type Float + * @param[in] obj2 The second instance of type Float + * @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;