Parse() remains original value when the function returns errror

[platform/framework/native/appfw.git] / inc / FBaseShort.h

diff --git a/inc/FBaseShort.h b/inc/FBaseShort.h
index d006439..9b921d4 100644 (file)
--- a/inc/FBaseShort.h
+++ b/inc/FBaseShort.h
@@ -231,8 +231,9 @@ public:
         *      @param[out]     ret                             The result of the operation
         *      @exception      E_SUCCESS               The method is successful.
         *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
-        *      @remarks        The method assumes that the string representing the numeric value
-        *                              uses radix 10.
+        *      @remarks
+        *                              - This method assumes that the string representing the numeric value uses a radix 10.
+        *                              - This method guarantees that the original value of out-parameter is not changed when the method returns error.
         */
        static result Parse(const String& s, short& ret);
 
@@ -242,14 +243,15 @@ public:
         *
         *      @since 2.0
         *
-        *      @return                 An error code
-        *      @param[in]      s                       A string representing a numeric value
-        *  @param[in]  radix           The radix of the string representing a numeric value @n
-        *                                                      It must either be @c 2, @c 8, @c 10, or @c 16.
+        *      @return         An error code
+        *      @param[in]      s               A string representing a numeric value
+        *      @param[in]      radix           The radix of the string representing a numeric value @n
+        *                                              It must either be @c 2, @c 8, @c 10, or @c 16.
         *      @param[out]     ret                             The result of the operation
         *      @exception      E_SUCCESS               The method is successful.
         *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
-        *  @exception  E_OUT_OF_RANGE The specified @c radix is invalid.
+        *      @exception      E_OUT_OF_RANGE The specified @c radix is invalid.
+        *      @remarks        This method guarantees that the original value of out-parameter is not changed when the method returns error.
         */
        static result Parse(const String& s, int radix, short& ret);