Merge "Added new method to the NotificationManager Interface" into tizen_2.2
[platform/framework/native/appfw.git] / inc / FBaseLongComparer.h
index 1c1aa7d..91d3bfe 100644 (file)
  * @file               FBaseLongComparer.h
  * @brief              This is the header file for the %LongComparer class.
  *
- * @see                        Long and Tizen::Base::Collection::IComparer
  *
  * This header file contains the declarations of the %LongComparer class.
+ *
+ * @see                        Tizen::Base::Long
+ * @see         Tizen::Base::Collection::IComparer
  */
 #ifndef _FBASE_LONG_COMPARER_H_
 #define _FBASE_LONG_COMPARER_H_
 #include <FBaseObject.h>
 #include <FBaseColIComparer.h>
 
-
 namespace Tizen { namespace Base
 {
 /**
  * @class      LongComparer
- * @brief      This class checks for equivalence between 2 instances of the %Long type.
+ * @brief      This class checks for equivalence between two instances of the %Long type.
  *
  * @since 2.0
  *
- * The %LongComparer class checks for equivalence between 2 instances of the Long type.
+ * The %LongComparer class checks for equivalence between two instances of the Long type.
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
  *
@@ -91,17 +92,17 @@ public:
         *      @since 2.0
         *
         *  @return             An error code
-        *      @param[in]      obj1    The first instance of type %Long
-        *      @param[in]      obj2    The second instance of type %Long
-        *      @param[out] cmp         The result of comparison
+        *  @param[in]  obj1                    The first instance of type Long
+        *  @param[in]  obj2                    The second instance of type Long
+        *  @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
+        *      @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;
@@ -119,7 +120,7 @@ private:
        LongComparer& operator =(const LongComparer& rhs);
 
        friend class _LongComparerImpl;
-       class _LongComparerImpl * __pLongComparerImpl;
+       class _LongComparerImpl* __pLongComparerImpl;
 
 }; // LongComparer