Fixed doxygen tag link errors
[platform/framework/native/appfw.git] / inc / FBaseLongLongComparer.h
index 654f283..bf42322 100644 (file)
  * @file               FBaseLongLongComparer.h
  * @brief              This is the header file for the %LongLongComparer class.
  *
- * @see                        Long and Tizen::Base::Collection::IComparer
  *
  * This header file contains the declarations of the %LongLongComparer class.
+ *
+ * @see                        Tizen::Base::Long
+ * @see                Tizen::Base::Collection::IComparer
  */
 #ifndef _FBASE_LONG_LONG_COMPARER_H_
 #define _FBASE_LONG_LONG_COMPARER_H_
 #include <FBaseObject.h>
 #include <FBaseColIComparer.h>
 
-
 namespace Tizen { namespace Base
 {
 /**
  * @class      LongLongComparer
- * @brief      This class checks for equivalence between 2 instances of the %LongLong type.
+ * @brief      This class checks for equivalence between two instances of the %LongLong type.
  *
  * @since 2.0
  *
- * The %LongLongComparer class checks for equivalence between 2 instances of the %LongLong type.
+ * The %LongLongComparer class checks for equivalence between two instances of the LongLong type.
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
  *
@@ -72,36 +73,36 @@ class _OSP_EXPORT_ LongLongComparer
 {
 public:
        /**
-        *      This is the default constructor for this class.
+        * This is the default constructor for this class.
         *
-        *      @since 2.0
+        * @since 2.0
         */
        LongLongComparer(void);
 
        /**
-        *      This destructor overrides Tizen::Base::Object::~Object().
+        * This destructor overrides Tizen::Base::Object::~Object().
         *
-        *      @since 2.0
+        * @since 2.0
         */
        virtual ~LongLongComparer(void);
 
        /**
-        *      Compares two given instances of type LongLong.
+        * Compares two given instances of type LongLong.
         *
-        *      @since 2.0
-        *  @return             An error code
-        *      @param[in]      obj1                    The first instance of type LongLong
-        *      @param[in]      obj2                    The second instance of type LongLong
-        *      @param[out] cmp                         The result of 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:
+        * @since 2.0
+        * @return              An error code
+        * @param[in]   obj1                    The first instance of type LongLong
+        * @param[in]   obj2                    The second instance of type LongLong
+        * @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
-        *      @endcode
+        * @code
+        *      <  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;
 
@@ -118,7 +119,7 @@ private:
        LongLongComparer& operator =(const LongLongComparer& rhs);
 
        friend class _LongLongComparerImpl;
-       class _LongLongComparerImpl * __pLongLongComparerImpl;
+       class _LongLongComparerImpl* __pLongLongComparerImpl;
 
 }; // LongLongComparer