Merge "Update to handle the FG/BG on AppControl response callback" into tizen

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

diff --git a/inc/FBaseBoolean.h b/inc/FBaseBoolean.h
index 91c13f9..7c51f03 100644 (file)
--- a/inc/FBaseBoolean.h
+++ b/inc/FBaseBoolean.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -21,8 +20,8 @@
  *
  * This header file contains the declarations of the %Boolean class.
  */
-#ifndef _FBASE_BOOL_H_
-#define _FBASE_BOOL_H_
+#ifndef _FBASE_BOOLEAN_H_
+#define _FBASE_BOOLEAN_H_
 
 #include <FBaseObject.h>
 #include <FBaseString.h>
@@ -73,7 +72,7 @@ public:
         *
         *      @since 2.0
         *
-        *      @param[in]      value   The input @c bool value to initialize the %Boolean instance
+        *      @param[in]      value   The input @c bool value to initialize the %Boolean instance
         */
        Boolean(bool value);
 
@@ -82,18 +81,18 @@ public:
         *
         *      @since 2.0
         *
-        *      @param[in]      value   An instance of the %Boolean class
+        *      @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 case), the object is initialized to @c true,
+        *  If the input is "true" (ignoring case), the object is initialized to @c true,
         *      else @c false.
         *
         *      @since 2.0
         *
-        *      @param[in]      value   An instance of String
+        *      @param[in]      value   An instance of String
         */
        Boolean(const String& value);
 
@@ -110,7 +109,7 @@ public:
         *      @since 2.0
         *
         *      @return                 @c true if the values of the objects are equal, @n
-        *                                  else @c false.
+        *                                              else @c false.
         *      @param[in]      rhs             An instance of %Boolean to compare with the current instance
         */
        bool operator ==(const Boolean& rhs) const;
@@ -121,8 +120,8 @@ public:
         *      @since 2.0
         *
         *      @return                 @c true if the values of the objects are not equal, @n
-        *                                  else @c false
-        *      @param[in]      rhs             A instance of %Boolean to compare with the current instance
+        *                                              else @c false
+        *      @param[in]      rhs             An instance of %Boolean to compare with the current instance
         */
        bool operator !=(const Boolean& rhs) const;
 
@@ -142,7 +141,7 @@ public:
         *      @since 2.0
         *
         *      @return                 @c true if the value of @c obj matches the value of the calling %Boolean instance, @n
-        *                                  else @c false
+        *                                              else @c false
         *      @param[in]      obj             A reference to the Object instance to compare with the calling %Boolean instance
         *      @see                            Tizen::Base::Object::Equals()
         */
@@ -154,8 +153,8 @@ 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. For better performance, @n
-        *                              the used hash function must generate a random distribution for all inputs.
+        *      @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;
 
@@ -166,7 +165,7 @@ public:
         *      @since 2.0
         *
         *  @return                     @c true if the parameter matches the calling %Boolean instance, @n
-        *                   else @c false
+        *                                              else @c false
         *  @param[in]  value   The @c bool value to compare to this instance
         */
        bool Equals(bool value) const;
@@ -181,12 +180,12 @@ public:
        bool ToBool(void) const;
 
        /**
-        *      Parses the specified string and converts it to a bool value.
+        *      Parses the specified string and converts it to a @c bool value.
         *
         *      @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. @n
         *                              It only accepts lowercase strings.
@@ -199,14 +198,14 @@ public:
        static bool Parse(const String& s);
 
        /**
-        *      Parses the specified string and converts it to a bool value. @n
+        *      Parses the specified string and converts it to a @c bool value. @n
         *      Case sensitivity can be controlled.
         *
         *      @since 2.0
         *
         *      @return         @c true if the value of the specified string is "true", @n
-        *                              else @c false
-        *      @param[in]      s                                       An instance of String
+        *                                      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 @c true.
@@ -219,24 +218,24 @@ public:
        static bool Parse(const String& s, bool caseSensitive);
 
        /**
-        *      Converts the value of the calling instance from 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
-        *                      else @c false
+        *                              else @c false
         */
        String ToString(void) const;
 
        /**
-        *      Converts bool parameter to a String
-        *      instance of the String class and returns the string representation of the
-        *      input bool value (@c true or @c false).
+        *      Converts a @c bool parameter to a String
+        *      instance of the %String class and returns the string representation of the
+        *      input @c bool value (@c true or @c false).
         *
         *      @since 2.0
         *
         *      @return @c true if the parameter is @c true, @n
-        *                      else @c false
+        *                              else @c false
         *      @param[in]      value   A @c bool value to convert to String
         */
        static String ToString(bool value);
@@ -270,10 +269,10 @@ public:
 
 private:
        friend class _BooleanImpl;
-       class _BooleanImpl * __pBooleanImpl;
+       class _BooleanImpl* __pBooleanImpl;
 
 }; // Boolean
 
 }} // Tizen::Base
 
-#endif //_FBASE_BOOL_H_
+#endif //_FBASE_BOOLEAN_H_