Merge "Fix dimming issue on KeepScreenOnState function" into tizen_2.2

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

diff --git a/inc/FBaseDateTime.h b/inc/FBaseDateTime.h
index 4f7fdf7..7e626e6 100644 (file)
--- a/inc/FBaseDateTime.h
+++ b/inc/FBaseDateTime.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);
@@ -106,7 +105,7 @@ public:
         *
         *      @since 2.0
         *
-        *      @param[in]      value   The instance of TimeSpan
+        *      @param[in]      value   An instance of TimeSpan
         *      @exception      E_SUCCESS                       The method is successful.
         *      @exception      E_OUT_OF_RANGE          The value of the argument is outside the valid range defined by the method. @n
         *                                                                      The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
@@ -124,7 +123,7 @@ public:
        void SetValue(const DateTime& value);
 
        /**
-        *      Sets the current instance of %DateTime to the specified year, month, day, hour, minute, and second.
+        *      Sets the current instance of %DateTime to the specified @c year, @c month, @c day, @c hour, @c minute, and @c second.
         *
         *      @since 2.0
         *
@@ -145,7 +144,7 @@ public:
        result SetValue(int year, int month, int day, int hour = 0, int minute = 0, int second = 0);
 
        /**
-        *      Sets the current instance of %DateTime to the specified year, month, day, hour, minute, second and millisecond.
+        *      Sets the current instance of %DateTime to the specified @c year, @c month, @c day, @c hour, @c minute, @c second, and @c millisecond.
         *
         *      @since 2.1
         *
@@ -159,26 +158,26 @@ public:
         *      @param[in]      millisecond                     The millisecond to set
         *      @exception      E_SUCCESS                       The method is successful.
         *      @exception      E_OUT_OF_RANGE          The value of the argument is outside the valid range defined by the method. @n
-        *                                                                       Either the arguments are greater than the value returned by GetMaxValue() or
+        *                                                                      Either the arguments are greater than the value returned by GetMaxValue() or
         *                                                                      are less than the value returned by GetMinValue(), or
-        *                                                                       the arguments contain invalid values.
+        *                                                                      the arguments contain invalid values.
         *                                                                      For example, day is 31 when month is 2.
         */
        result SetValue(int year, int month, int day, int hour, int minute, int second, int millisecond);
 
        /**
-        *      Sets the current instance of %DateTime with the specified number of ticks.
-        *      The tick value represents dates and times with long long type ranging from January 1, 1 A.D. 00:00:00.000 am.
+        *      Sets the current instance of %DateTime with the specified number of %ticks.
+        *      The tick value of type @c long @c long represents dates and times ranging from January 1, 1 A.D. 00:00:00.000 am.
         *
         *      @since  2.1
         *
         *      @return                 An error code
-        *      @param[in]      ticks   The number of ticks (in milliseconds)
+        *      @param[in]      ticks   The number of ticks
         *      @exception      E_SUCCESS                       The method is successful.
         *      @exception      E_OUT_OF_RANGE          The value of the argument is outside the valid range defined by the method.
-        *                                                                       Either the arguments are greater than the value returned by GetMaxValue() or
+        *                                                                      Either the arguments are greater than the value returned by GetMaxValue() or
         *                                                                      are less than the value returned by GetMinValue(), or
-        *                                                                       the arguments contain invalid values.
+        *                                                                      the arguments contain invalid values.
         *                                                                      For example, day is 31 when month is 2.
         */
        result SetValue(long long ticks);
@@ -344,7 +343,7 @@ public:
        result AddSeconds(int seconds);
 
        /**
-        *      Adds the specified number of milliseconds to the instance of %DateTime.
+        *      Adds a specified number of milliseconds to the instance of %DateTime.
         *
         *      @since 2.1
         *
@@ -358,7 +357,7 @@ public:
        result AddMilliseconds(long long milliseconds);
 
        /**
-        *      Adds the specified number of ticks to the instance of %DateTime.
+        *      Adds a specified number of ticks to the instance of %DateTime.
         *
         *      @since 2.1
         *
@@ -423,7 +422,7 @@ public:
         *      @since 2.0
         *
         *      @return         @c true if the specified instance of Object is equivalent to the current instance of %DateTime, @n
-                       else @c false
+        *               else @c false
         *      @param[in]      obj The object to compare with the current instance of %DateTime
         *      @see                    Tizen::Base::Object::GetHashCode()
         */
@@ -450,7 +449,7 @@ public:
        TimeSpan GetTimeOfDay(void) const;
 
        /**
-        *      Gets the number of days in the specified month of the specified year.
+        *      Gets the number of @c days in the specified @c month of the specified @c year.
         *
         *      @since 2.0
         *
@@ -505,7 +504,9 @@ public:
         *                                                                          or is less than the value returned by GetMinValue(). @n
         *                                                                           2) The specified string contains an invalid value.
         *                                                                          For example, day is 31 when the month is 2.
-        * @remarks             The format of the string is "mm/dd/yyyy hh:mm:ss.mmm".
+        * @remarks
+        *                              - The format of the string is "mm/dd/yyyy hh:mm:ss".
+        *                              - This method guarantees that the original value of out-parameter is not changed when the method returns error.
         */
        static result Parse(const String& str, DateTime& dt);
 
@@ -583,11 +584,11 @@ public:
 
        /**
         *      Gets the tick of the current instance of %DateTime.
-        *      The tick value represents dates and times with long long ranging from January 1, 1 A.D. 00:00:00.000 am.
+        *      The tick value of type @c long @c long represents dates and times ranging from January 1, 1 A.D. 00:00:00.000 am.
         *
         *      @since  2.1
         *
-        *      @return         An long long value indicating the tick of the current instance of %DateTime
+        *      @return         A @c long @c long value indicating the tick of the current instance of %DateTime
         */
        long long GetTicks(void) const;
 
@@ -630,7 +631,7 @@ public:
        bool IsLeapYear(void) const;
 
        /**
-        *      Checks whether the specified year is a leap year.
+        *      Checks whether the specified @c year is a leap year.
         *
         *      @since 2.0
         *