X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseBoolean.h;h=7c51f039d08e954eab10f9a00ef6492d23dd19a2;hb=HEAD;hp=7a40c0610866ee93635454a2bbb8861540683155;hpb=4d451910df2d31e4c7ec7da85ded34bb09be862e;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseBoolean.h b/inc/FBaseBoolean.h index 7a40c06..7c51f03 100644 --- a/inc/FBaseBoolean.h +++ b/inc/FBaseBoolean.h @@ -35,7 +35,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %Boolean class wraps a boolean type value. This enables passing a boolean value to a method that only accepts an instance of the Object class. + * The %Boolean class wraps a bool type value. This enables passing a bool value to a method that only accepts an instance of the Object class. * It provides methods to convert %Boolean instances to String and %String instances to %Boolean. * * The following example demonstrates how to use the %Boolean class. @@ -68,11 +68,11 @@ class _OSP_EXPORT_ Boolean { public: /** - * Initializes this instance of %Boolean with the specified @c value. + * Initializes this instance of the %Boolean class with the specified @c value. * * @since 2.0 * - * @param[in] value The @c bool value used to initialize %Boolean + * @param[in] value The input @c bool value to initialize the %Boolean instance */ Boolean(bool value); @@ -81,14 +81,14 @@ public: * * @since 2.0 * - * @param[in] value An instance of %Boolean + * @param[in] value An instance of the %Boolean class */ Boolean(const Boolean& value); /** * Initializes this instance of %Boolean with the specified input string. @n - * If the input is "true" (ignoring cases), the object is initialized to @c true, - * otherwise to @c false. + * If the input is "true" (ignoring case), the object is initialized to @c true, + * else @c false. * * @since 2.0 * @@ -108,8 +108,8 @@ public: * * @since 2.0 * - * @return @c true if the values of the objects are equal, @n - * else @c false + * @return @c true if the values of the objects are equal, @n + * else @c false. * @param[in] rhs An instance of %Boolean to compare with the current instance */ bool operator ==(const Boolean& rhs) const; @@ -119,7 +119,7 @@ public: * * @since 2.0 * - * @return @c true if the values of the objects are not equal, @n + * @return @c true if the values of the objects are not equal, @n * else @c false * @param[in] rhs An instance of %Boolean to compare with the current instance */ @@ -135,13 +135,14 @@ public: Boolean& operator =(const Boolean& rhs); /** - * Compares the specified Object instance with the current %Boolean instance. + * Converts an instance of the Object class to an instance of %Boolean and then + * compares it with the calling %Boolean instance. * * @since 2.0 * - * @return @c true if @c obj matches the current %Boolean instance, @n + * @return @c true if the value of @c obj matches the value of the calling %Boolean instance, @n * else @c false - * @param[in] obj A reference to the Object instance to compare with the current %Boolean instance + * @param[in] obj A reference to the Object instance to compare with the calling %Boolean instance * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -151,30 +152,30 @@ public: * * @since 2.0 * - * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n - * For better performance, the used hash function must generate a random distribution for all the inputs. + * @return The hash value of the current instance + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n + * the used hash function must generate a random distribution for all inputs. */ virtual int GetHashCode(void) const; /** - * Converts a @c bool value to an instance of %Boolean and then - * compares it with the current %Boolean instance. + * Converts a bool value to an instance of %Boolean and then + * compares it with the calling %Boolean instance. * * @since 2.0 * - * @return @c true if @c value matches the current %Boolean instance, @n + * @return @c true if the parameter matches the calling %Boolean instance, @n * else @c false * @param[in] value The @c bool value to compare to this instance */ bool Equals(bool value) const; /** - * Returns the value of the current object as @c bool. + * Returns the value of the calling object as @c bool. * * @since 2.0 * - * @return The value of the %Boolean instance as @c bool + * @return The value of the %Boolean instance as bool */ bool ToBool(void) const; @@ -184,9 +185,10 @@ public: * @since 2.0 * * @return @c true if the value of the specified string is "true", @n - * else @c false + * else @c false * @param[in] s An instance of String - * @remarks This method is case sensitive and accepts only lowercase strings. + * @remarks This method is case sensitive. @n + * It only accepts lowercase strings. * * @code * bool b1 = Boolean::Parse(trueString); // trueString is L"true" @@ -202,11 +204,11 @@ public: * @since 2.0 * * @return @c true if the value of the specified string is "true", @n - * else @c false + * else @c false * @param[in] s An instance of String * @param[in] caseSensitive Set to @c true to perform a * case sensitive comparison of string @c s - * @remarks If @c caseSensitive is @c true, L"True" returns @c false, else it returns @c true. + * @remarks If @c caseSensitive is @c true, L"True" returns @c false, else @c true. * * @code * bool b1 = Boolean::Parse(L"True", false ); // Returns @c true @@ -216,11 +218,11 @@ public: static bool Parse(const String& s, bool caseSensitive); /** - * Converts the value of the current instance from @c bool to String. + * Converts the value of the calling instance from @c bool to String. * * @since 2.0 * - * @return @c true if this instance is @c true, @n + * @return @c true if this instance is @c true, @n * else @c false */ String ToString(void) const; @@ -232,9 +234,9 @@ public: * * @since 2.0 * - * @return @c true if the parameter is @c true, @n + * @return @c true if the parameter is @c true, @n * else @c false - * @param[in] value The @c bool value to convert to String + * @param[in] value A @c bool value to convert to String */ static String ToString(bool value);