//
/**
- * @file FBaseStringComparer.h
+ * @file FBaseStringComparer.h
* @brief This is the header file for the %StringComparer class.
*
- * @see String and Tizen::Base::Collection::IComparer
- *
* This header file contains the declarations of the %StringComparer class.
+ *
+ * @see Tizen::Base::String
+ * @see Tizen::Base::Collection::IComparer
*/
#ifndef _FBASE_STRING_COMPARER_H_
#define _FBASE_STRING_COMPARER_H_
{
/**
* @class StringComparer
- * @brief This class checks for equivalence between 2 instances of the %String type.
+ * @brief This class checks for equivalence between two instances of the %String type.
*
* @since 2.0
*
- * The %StringComparer class checks for equivalence between 2 instances of the String type.
+ * The %StringComparer class checks for equivalence between two instances of the String type.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj1 An object of String to compare
- * @param[in] obj2 An object of String to compare
- * @param[out] cmp The result of comparison
+ * @param[in] obj1 The object of String to compare
+ * @param[in] obj2 The object of String 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:
*
* @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;