Beautified source code of appfw/inc
[platform/framework/native/appfw.git] / inc / FBaseDouble.h
index c61f155..a636438 100644 (file)
 //
 
 /**
- * @file               FBaseDouble.h
- * @brief              This is the header file for the %Double class.
+ * @file       FBaseDouble.h
+ * @brief      This is the header file for the %Double class.
  *
- * @see                        Tizen::Base::Number
+ * @see                Tizen::Base::Number
  *
  * This header file contains the declarations of the %Double class.
  */
@@ -27,7 +27,6 @@
 
 #include <FBaseNumber.h>
 
-
 namespace Tizen { namespace Base
 {
 /**
@@ -85,11 +84,10 @@ public:
         *
         * @since 2.0
         *
-        * @param[in]   value   A @c double value
+        * @param[in]   value   A @c double value
         */
        Double(double value = 0.0L);
 
-
        /**
         * Copying of objects using this copy constructor is allowed.
         *
@@ -179,7 +177,7 @@ public:
         *      @since 2.0
         *
         *      @return         An integer value indicating the hash value of the current instance of %Double
-        *      @remarks        Two equal instances must return the same hash value. For better performance,
+        *      @remarks    Two equal instances must return the same hash value. For better performance,
         *                              the used hash function must generate a random distribution for all inputs. @n
         *                              The default implementation of this method returns the value of the current instance.
         */
@@ -190,8 +188,8 @@ public:
        *
        *        @since 2.0
        *
-       *        @return        An integer value indicating the hash value of the specified @c double value
-       *        @param[in]   val   A @c double value to get the hash value
+       *        @return                An integer value indicating the hash value of the specified @c double value
+       *        @param[in]             val   A @c double value to get the hash value
        */
        static int GetHashCode(double val);
 
@@ -202,12 +200,12 @@ public:
         *
         * @return              An error code
         * @param[in]   s                               A unicode representation of @c signed @c double value
-        * @param[out]  ret                     The converted numeric value
+        * @param[out]  ret             The converted numeric value
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
-        * @remarks             
-        *                                      - This method guarantees that the original value of out-parameter is not changed when the method returns error.
-        *                                      - The behavior of this method is dependent on the system default locale setting.
+        * @remarks
+        *                              - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+        *                              - The behavior of this method is dependent on the system default locale setting.
         */
        static result Parse(const String& s, double& ret);
 
@@ -216,7 +214,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      A @c signed @c char equivalent of the current instance
+        * @return              A @c signed @c char equivalent of the current instance
         */
        virtual char ToChar(void) const;
 
@@ -225,7 +223,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      A @c signed @c short equivalent of the current instance
+        * @return              A @c signed @c short equivalent of the current instance
         */
        virtual short ToShort(void) const;
 
@@ -234,7 +232,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      A @c signed @c int equivalent of the current instance
+        * @return              A @c signed @c int equivalent of the current instance
         */
        virtual int ToInt(void) const;
 
@@ -243,7 +241,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      A @c signed @c long equivalent of the current instance
+        * @return              A @c signed @c long equivalent of the current instance
         */
        virtual long ToLong(void) const;
 
@@ -252,7 +250,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      A @c signed @c long @c long equivalent of the current instance
+        * @return              A @c signed @c long @c long equivalent of the current instance
         */
        virtual long long ToLongLong(void) const;
 
@@ -261,7 +259,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      A @c signed @c float equivalent of the current instance
+        * @return              A @c signed @c float equivalent of the current instance
         */
        virtual float ToFloat(void) const;
 
@@ -270,7 +268,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      A @c signed @c double equivalent of the current instance
+        * @return              A @c signed @c double equivalent of the current instance
         */
        virtual double ToDouble(void) const;
 
@@ -280,11 +278,11 @@ public:
         * @since 2.0
         *
         * @return              A string containing a Unicode representation of the value of the current instance
-        * @remarks             
+        * @remarks
         *                              - If the value of the current instance is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
         *                              produces the result "Infinity". @n
         *                              6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
-        *                              - The behavior of this method is dependent on the system default locale setting.
+        *                              - The behavior of this method is dependent on the system default locale setting.
         */
        virtual String ToString(void) const;
 
@@ -295,11 +293,11 @@ public:
         *
         * @return              A string containing a Unicode representation of the specified @c double value
         * @param[in]   value A @c double value to convert
-        * @remarks             
-        *                              - If the input value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
+        * @remarks
+        *                              - If the input value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
         *                              produces the result "Infinity". @n
         *                              6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
-        *                              - The behavior of this method is dependent on the system default locale setting.
+        *                              - The behavior of this method is dependent on the system default locale setting.
         */
        static String ToString(double value);
 
@@ -309,7 +307,7 @@ public:
         * @since 2.0
         *
         * @return              The bits that represent the floating-point number in the IEEE 754 floating-point "double format" bit layout
-        * @param[in]   value   A @c double value to convert
+        * @param[in]   value   A @c double value to convert
         */
        static long long ToBits(double value);
 
@@ -319,7 +317,7 @@ public:
         * @since 2.0
         *
         * @return              The @c double floating-point value with the same bit pattern
-        * @param[in]   value   The floating-point value to convert
+        * @param[in]   value   The floating-point value to convert
         */
        static double ToDoubleFromBits(long long value);
 
@@ -340,9 +338,8 @@ public:
         *
         * @return              @c true if the specified value equals negative or positive infinity, @n
         *                              else @c false
-        * @param[in]   value   A @c double value to check
+        * @param[in]   value   A @c double value to check
         */
-
        static bool IsInfinity(double value);
 
        /**
@@ -362,7 +359,7 @@ public:
         *
         * @return              @c true if the specified value is Not-a-Number, @n
         *                              else @c false
-        * @param[in]   value   A @c double value to check
+        * @param[in]   value   A @c double value to check
         */
        static bool IsNaN(double value);
 
@@ -393,7 +390,6 @@ public:
         */
        double value;
 
-
 private:
        /**
         *      Checks if the specified @c double value is finite.
@@ -409,10 +405,8 @@ private:
        static const int __DBL_MAX_10_EXP = 308;
 
        friend class _DoubleImpl;
-       class _DoubleImpl * __pDoubleImpl;
+       class _DoubleImpl* __pDoubleImpl;
 
 }; // Double
-
 }} // Tizen::Base
-
-#endif //_FBASE_DOUBLE_H_
+#endif //_FBASE_DOUBLE_H_
\ No newline at end of file