fix description of ContactAppLaunchData

Change-Id: I8c0bdc3557b4ec593933b8ae6acd599517aa5bf3
Signed-off-by: Gwangbok Kim <gwangbok.kim@samsung.com>

diff --git a/inc/FSclContactAppLaunchData.h b/inc/FSclContactAppLaunchData.h
index 05b9049..941f76b 100644 (file)
--- a/inc/FSclContactAppLaunchData.h
+++ b/inc/FSclContactAppLaunchData.h
@@ -41,14 +41,14 @@ namespace Tizen { namespace Social
 
 /**
  * @class      ContactAppLaunchData
- * @brief      This class provides the information needed to launch an application from a contact.
+ * @brief      This class provides the information required to launch an application from a contact.
  *
  * @since      2.1
  *
  * @final      This class is not intended for extension.
  *
- * The %ContactAppLaunchData class represent the information needed to launch an application from a contact.
- * The information consists of application id, operation id, mime, uri, display text, and extra data.
+ * The %ContactAppLaunchData class provides the information required to launch an application from a contact.
+ * This information consists of application ID, operation ID, MIME type, URI, display text, and extra data.
  */
 
 class _OSP_EXPORT_ ContactAppLaunchData
@@ -80,7 +80,7 @@ public:
        virtual ~ContactAppLaunchData(void);
 
        /**
-        * Checks whether the value of the specified instance is equal to the value of the current instance of Tizen::Base::Object.
+        * Checks whether the value of a specified instance is equal to the value of the current instance of Tizen::Base::Object.
         *
         * @since       2.1
         *
@@ -100,113 +100,113 @@ public:
        virtual int GetHashCode(void) const;
 
        /**
-        * Gets the display text.
+        * Gets the display text that describes the data of the contact app launch.
         *
         * @since       2.1
         *
-        * @return      The text which describes this contact app launch data
+        * @return      The text that describes the data of the contact app launch
         */
        Tizen::Base::String GetDisplayText(void) const;
 
        /**
-        * Gets the application ID.
+        * Gets an application ID.
         *
         * @since       2.1
         *
-        * @return      The application ID
+        * @return      An application ID
         */
        Tizen::Base::String GetAppId(void) const;
 
        /**
-        * Gets the operation ID.
+        * Gets an operation ID.
         *
         * @since       2.1
         *
-        * @return      The operation ID
+        * @return      An operation ID
         */
        Tizen::Base::String GetOperationId(void) const;
 
        /**
-        * Gets the uri.
+        * Gets the URI of an application.
         *
         * @since       2.1
         *
-        * @return      The uri
+        * @return      The URI of an application
         */
        Tizen::Base::String GetUri(void) const;
 
        /**
-        * Gets the mime.
+        * Gets the MIME type of an application.
         *
         * @since       2.1
         *
-        * @return      The mime
+        * @return      The MIME type of an application
         */
        Tizen::Base::String GetMime(void) const;
 
        /**
-        * Gets the extra data.
+        * Gets the extra data for a map.
         *
         * @since       2.1
         *
         * @return      The key-value map of the extended data where the key and value are of type Tizen::Base::String, @n
-        *                      else and empty map if there is no extra data, or null if an exception occurs.
+        *                      else an empty map if there is no extra data, or @c null if an exception occurs
         * @remarks     The specific error code can be accessed using the GetlastResult() method.
         */
        Tizen::Base::Collection::IMap* GetExtraDataN(void) const;
 
        /**
-        * Sets the display text.
+        * Sets the display text that describes the data of the contact app launch.
         *
         * @since               2.1
         *
-        * @param[in]   displayText             The text which describes this contact app launch data
+        * @param[in]   displayText             The text that describes the data of the contact app launch
         */
        void SetDisplayText(const Tizen::Base::String& displayText);
 
        /**
-        * Sets the application ID.
+        * Sets an application ID.
         *
         * @since               2.1
         *
-        * @param[in]   appId           The application ID
+        * @param[in]   appId           The application ID to set
         */
        void SetAppId(const Tizen::Base::String& appId);
 
        /**
-        * Sets the operation ID.
+        * Sets an operation ID.
         *
         * @since               2.1
         *
-        * @param[in]   operationId             The operation ID
+        * @param[in]   operationId             The operation ID to set
         */
        void SetOperationId(const Tizen::Base::String& operationId);
 
        /**
-        * Sets the uri.
+        * Sets the URI of an application.
         *
         * @since               2.1
         *
-        * @param[in]   uri             The uri
+        * @param[in]   uri             The URI of an application to set
         */
        void SetUri(const Tizen::Base::String& uri);
 
        /**
-        * Sets the mime.
+        * Sets the MIME type of an application.
         *
         * @since       2.1
         *
-        * @param[in]   mime    The mime
+        * @param[in]   mime    The MIME type of an application to set
         */
        void SetMime(const Tizen::Base::String& mime);
 
        /**
-        * Sets the extra data to be delivered to the application.
+        * Sets the extra data to be delivered to an application.
         *
         * @since       2.1
         *
-        * @param[in]   pExtraData              A pointer to an argument map of key and value pair where the key is of type Tizen::Base::String and the value is of type Tizen::Base::String
-        *                                                                                              If null is passed the current extra data is removed.
+        * @param[in]   pExtraData              A pointer to an argument map of key and value pair where the key and value is of type Tizen::Base::String @n
+        *                                                                                              If @c null is passed, the current extra data is removed.
         */
        result SetExtraData(const Tizen::Base::Collection::IMap* pExtraData);
 
@@ -228,11 +228,11 @@ private:
 }; // ContactAppLaunchData
 
 /**
- * Compares the specified two instances of %ContactAppLaunchData.
+ * Compares the two specified instances of %ContactAppLaunchData for equality.
  *
  * @since      2.1
  *
- * @return             @c true if the data of the specified two instances are equal, @n
+ * @return             @c true if the data of the two specified instances are equal, @n
  *                             else @c false
  * @param[in]  lhs             An instance of %ContactAppLaunchData
  * @param[in]  rhs             An instance of %ContactAppLaunchData
@@ -240,11 +240,11 @@ private:
 _OSP_EXPORT_ bool operator ==(const ContactAppLaunchData& lhs, const ContactAppLaunchData& rhs);
 
 /**
- * Compares the specified two instances of %ContactAppLaunchData for inequality.
+ * Compares the two specified instances of %ContactAppLaunchData for inequality.
  *
  * @since      2.1
  *
- * @return             @c true if the data of the specified two instances are not equal, @n
+ * @return             @c true if the data of the two specified instances are not equal, @n
  *                             else @c false
  * @param[in]  lhs             An instance of %ContactAppLaunchData
  * @param[in]  rhs             An instance of %ContactAppLaunchData