Add doxygen comment of Parse(), ToString()

Change-Id: Ib3dc3c999b8c80a63b380f95aef9ef102406fa7b
Signed-off-by: dahyeong.kim <dahyeong.kim@samsung.com>

diff --git a/inc/FBaseDouble.h b/inc/FBaseDouble.h
index 87f873c..d1b7e6f 100644 (file)
--- a/inc/FBaseDouble.h
+++ b/inc/FBaseDouble.h
@@ -207,6 +207,7 @@ public:
         * @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.
+        * @remarks             The behavior of this method is dependent on the system default locale setting.
         */
        static result Parse(const String& s, double& ret);
 
@@ -282,6 +283,7 @@ public:
         * @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.
+        * @remarks             The behavior of this method is dependent on the system default locale setting.
         */
        virtual String ToString(void) const;
 
@@ -295,6 +297,7 @@ public:
         * @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.
+        * @remarks             The behavior of this method is dependent on the system default locale setting.
         */
        static String ToString(double value);
 

diff --git a/inc/FBaseFloat.h b/inc/FBaseFloat.h
index 041f5f4..7e2b38c 100644 (file)
--- a/inc/FBaseFloat.h
+++ b/inc/FBaseFloat.h
@@ -195,6 +195,7 @@ public:
         *      @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.
+        *      @remarks        The behavior of this method is dependent on the system default locale setting.
         *      @see            Tizen::Base::Double::Parse()
         */
        static result Parse(const String& s, float& ret);
@@ -271,6 +272,7 @@ public:
         * @remarks             If the 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.
+        * @remarks             The behavior of this method is dependent on the system default locale setting.
         */
        virtual String ToString(void) const;
 
@@ -284,6 +286,7 @@ public:
         *  @remarks    If the 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.
+        * @remarks             The behavior of this method is dependent on the system default locale setting.
         */
        static String ToString(float value);