Changing the return value description of IsBitSet(), IsProbablePrimeNumber() API 28/13728/1
authordarpan.ka <darpan.ka@samsung.com>
Fri, 13 Dec 2013 04:44:21 +0000 (10:14 +0530)
committerdarpan.ka <darpan.ka@samsung.com>
Fri, 13 Dec 2013 04:44:21 +0000 (10:14 +0530)
Change-Id: I6fccf13ae78b3254c49270b99a8659cb9cadebf5
Signed-off-by: darpan.ka <darpan.ka@samsung.com>
inc/FBaseBigInteger.h

index 395486e..d585300 100644 (file)
@@ -140,7 +140,7 @@ public:
         *              -The behavior of this constructor is not  dependent on the system default locale setting.
         *
         * @exception   E_SUCCESS       The method is successful.
-        * @exception   E_NUM_FORMAT    The specified string does not represent valid binary, octal, decimal or hexadecimal number, or
+        * @exception   E_NUM_FORMAT    The specified string does not represent valid number in specified radix, or
         *                              The specified string contains decimal separator which represent a floating point number.
         * @exception   E_OUT_OF_RANGE  The specified radix is not in between 2 to 36.
         */
@@ -211,7 +211,7 @@ public:
         *              -GetLastResult() should be called to retrieve the last set exception
         *
         * @exception   E_SUCCESS       The method is successful.
-        * @exception   E_NUM_FORMAT    The specified string does not represent valid binary, octal, decimal or hexadecimal number, or
+        * @exception   E_NUM_FORMAT    The specified string does not represent valid number in specified radix, or
         *                              The specified string contains decimal separator which represent a floating point number.
         * @exception   E_OUT_OF_RANGE  The specified radix is not in between 2 to 36.
         */
@@ -458,7 +458,7 @@ public:
         *
         * @param[in]   bitIndex        Position of the bit whose value is checked whether it is set.
         *
-        * @return      A new %BigInteger instance containing value of greater common divisor.
+        * @return      @c true if the bit is set @c false
         *
         * @remarks     -If the bitIndex is invalid it sets the exception.
         *              -GetLastResult() should be called to retrieve the last set exception
@@ -474,7 +474,7 @@ public:
         * @since 3.0
         *
         *
-        * @return      @c true if the value if prime else @c false
+        * @return      PrimeNumberResult enum containing prime number information
         *
         * @remarks
         * -returns PROBABLY_PRIME if probably prime.