Init Tizen 2.2.1

[framework/osp/social.git] / inc / FSclCalendar.h

diff --git a/inc/FSclCalendar.h b/inc/FSclCalendar.h
index 50405c7..237142e 100644 (file)
--- a/inc/FSclCalendar.h
+++ b/inc/FSclCalendar.h
@@ -44,7 +44,7 @@ namespace Tizen { namespace Social
  * @final      This class is not intended for extension.
  *
  * The %Calendar class represents calendar information. @n
- * Multiple calendars can be created, each of which can have its own events and to-dos. An event or to-do can be retrieved using the respective calendar ID.
+ * Multiple calendars can be created, each of which can have their own events and to-dos. An event or to-do can be retrieved using the respective calendar ID.
  */
 class _OSP_EXPORT_ Calendar
        : public Record
@@ -55,7 +55,7 @@ public:
         *
         * @since       2.0
         *
-        * @param[in]   itemType                        The calendar item type to specify which kind of item the calendar can contain
+        * @param[in]   itemType        The calendar item type to specify which kind of item the calendar can contain
         */
        explicit Calendar(CalendarItemType itemType);
 
@@ -64,7 +64,7 @@ public:
         *
         * @since       2.0
         *
-        * @param[in]   rhs             An instance of %Calendar
+        * @param[in]   rhs             An instance of %Calendar to copy
         */
        Calendar(const Calendar& rhs);
 
@@ -76,13 +76,13 @@ public:
        virtual ~Calendar(void);
 
        /**
-        * Compares the input Tizen::Base::Object with the calling %Calendar instance.
+        * Compares the specified Tizen::Base::Object with the current %Calendar instance.
         *
         * @since       2.0
         *
-        * @return              @c true if the input object equals the calling %Calendar instance, @n
+        * @return              @c true if the specified object equals the current %Calendar instance, @n
         *                              else @c false
-        * @param[in]   rhs     The object instance to compare with the calling object
+        * @param[in]   rhs     The object instance to compare with the current object
         * @see                 GetHashCode()
         */
        virtual bool Equals(const Tizen::Base::Object& rhs) const;
@@ -125,14 +125,14 @@ public:
 
        /**
         * Gets the calendar color. @n
-        * If the color has not been set, all color components are set with 0x0 and E_DATE_NOT_FOUND exception is returned.
+        * If the color has not been set, all color components are set with 0x0 and @c E_DATE_NOT_FOUND exception is returned.
         *
         * @since       2.0
         *
-        * @param[out]          r               The red component
-        * @param[out]          g               The green component
-        * @param[out]          b               The blue component
-        * @exception           E_SUCCESS                                       The method is successful.
+        * @param[out]          r                                               The red component
+        * @param[out]          g                                               The green component
+        * @param[out]          b                                               The blue component
+        * @exception           E_SUCCESS                               The method is successful.
         * @exception           E_DATA_NOT_FOUND                The color has not been set.
         */
        result GetColor(byte& r, byte& g, byte& b) const;
@@ -142,7 +142,7 @@ public:
         *
         * @since       2.0
         *
-        * @param[in]   name                                    The calendar name
+        * @param[in]   name    The calendar name
         */
        void SetName(const Tizen::Base::String& name);
 
@@ -169,7 +169,7 @@ public:
         *
         * @since       2.0
         *
-        * @param[in]   rhs             An instance of %Calendar
+        * @param[in]   rhs             An instance of %Calendar to copy
         */
        Calendar& operator =(const Calendar& rhs);