X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseShortComparer.h;h=e42ef9a2de3106248ff78820580ec8df30c5cac9;hb=72749ddd32dd1e3e2833ada50fad8fceefbdcddc;hp=36ad325e2ab37e48fad13d0c80161a5644717214;hpb=ba579df8b7bd47e2875e4833455443f56683ee01;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseShortComparer.h b/inc/FBaseShortComparer.h index 36ad325..e42ef9a 100644 --- a/inc/FBaseShortComparer.h +++ b/inc/FBaseShortComparer.h @@ -18,10 +18,10 @@ * @file FBaseShortComparer.h * @brief This is the header file for the %ShortComparer class. * + * This header file contains the declarations of the %ShortComparer class. + * * @see Short * @see Tizen::Base::Collection::IComparer - * - * This header file contains the declarations of the %ShortComparer class. */ #ifndef _FBASE_SHORT_COMPARER_H_ #define _FBASE_SHORT_COMPARER_H_ @@ -35,11 +35,11 @@ namespace Tizen { namespace Base { /** * @class ShortComparer - * @brief This class compares 2 instances of the %Short type for equivalence. + * @brief This class compares two instances of the %Short type for equivalence. * * @since 2.0 * - * The %ShortComparer class compares 2 instances of the Short type for equivalence. + * The %ShortComparer class compares two instances of the Short type for equivalence. * * For more information on the class features, see Collection Comparisons. * @@ -91,18 +91,18 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] obj1 An object of Short to compare - * @param[in] obj2 An object of Short to compare - * @param[out] cmp The result of comparison + * @return An error code + * @param[in] obj1 The object of Short to compare + * @param[in] obj2 The object of Short to compare + * @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: + * @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;