Update documents from LB

Change-Id: Ic52197f77bd1ce28894c9601c634ec610f84d79e
Signed-off-by: Sunwook Bae <sunwook45.bae@samsung.com>

diff --git a/inc/FCntDownloadManager.h b/inc/FCntDownloadManager.h
index 5f6c37e..329e8cf 100644 (file)
--- a/inc/FCntDownloadManager.h
+++ b/inc/FCntDownloadManager.h
@@ -205,7 +205,7 @@ public:
 
        /**
        * Gets the download state of the given request ID. @n
-       * If there is no download request for the request ID, DOWNLOAD_STATE_NONE will be returned.
+       * If there is no download request for the request ID, @c DOWNLOAD_STATE_NONE is returned.
        *
        * @since 2.0
        *

diff --git a/inc/FCntDownloadRequest.h b/inc/FCntDownloadRequest.h
index 87a2351..9140d1a 100644 (file)
--- a/inc/FCntDownloadRequest.h
+++ b/inc/FCntDownloadRequest.h
@@ -158,97 +158,119 @@ public:
        Tizen::Base::String GetFileName(void) const;
 
        /**
-       * Sets to show the download notification by the system or not. @n
-       * If true, the system posts notifications about this download request through the Tizen::Shell::NotificationManager. @n
-       * By default, this value sets to true.
+       * Determines whether the system should show the download notification or not. @n
+       * If @c true, the system posts notifications about this download request through the Tizen::Shell::NotificationManager. @n
+       * By default, this value sets to @c true.
+       *
        * @since 2.1
-       * @param[in] enable whether the system should show a notification for this download request
+       *
+       * @param[in] enable Set to @c true if the system shows a notification for this download request, @n
+       *                                       else @c false
        * @see Tizen::Shell::NotificationManager
        */
        void SetNotification(bool enable);
 
        /**
-       * Sets the extra data which is delivered to the application when the notification message is selected. @n
+       * Sets an extra data that is delivered to the application when the notification message is selected. @n
        * The extra data will be passed to the application through the
-       * Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived().
+       * Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived() method.
+       *
        * @since 2.1
+       *
        * @return An error code
-       * @param[in] pExtraData A pointer to an argument map of the Tizen::Base::String key and Tizen::Base::String value pair
+       * @param[in] pExtraData A pointer to an argument map of the Tizen::Base::String key and the Tizen::Base::String value pair
        * @exception E_SUCCESS The method is successful.
-       * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
-       * - The argument is null. @n
-       * - The argument is not a map of Tizen::Base::String key and Tizen::Base::String value pair.
+       * @exception E_INVALID_ARG Either of the following conditions has occurred:
+       * - The argument is @c null.
+       * - The argument is not a map of the Tizen::Base::String key and the Tizen::Base::String value pair.
        * @see Tizen::Shell::NotificationManager
        * @see Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived()
        */
        result SetNotificationExtraData(const Tizen::Base::Collection::IMap *pExtraData);
 
        /**
-       * Sets the allowed network type. By default, all network types are allowed.
+       * Sets an allowed network type. @n
+       * By default, all network types are allowed.
+       *
        * @since 2.1
+       *
        * @param[in] type The download network type
        */
        void SetNetworkType(DownloadNetworkType type);
 
        /**
        * Checks whether the system should show a notification for this download request.
+       *
        * @since 2.1
+       *
        * @return @c true if the system should show a notification for this download request, @n
        * else @c false
        */
        bool IsNotificationEnabled(void) const;
 
        /**
-       * Gets the extra data which is delivered to the application when the notification message is seleted.
+       * Gets an extra data that is delivered to the application when the notification message is selected.
+       *
        * @since 2.1
-       * @return The extra data map which consists of the Tizen::Base::String key and Tizen::Base::String value pair
+       *
+       * @return The extra data map that consists of the Tizen::Base::String key and the Tizen::Base::String value pair
        */
        const Tizen::Base::Collection::IMap* GetNotificationExtraData(void) const;
 
        /**
-       * Gets the allowed network type.
+       * Gets an allowed network type.
+       *
        * @since 2.1
-       * @return network type
+       *
+       * @return The network type
        */
        DownloadNetworkType GetNetworkType(void) const;
 
        /**
        * Adds an HTTP header field.
+       *
        * @since 2.1
+       *
        * @return An error code
        * @param[in] field The HTTP header field
        * @param[in] value The value of the header field
        * @exception E_SUCCESS The method is successful.
-       * @exception E_INVALID_ARG The field is empty or already exist.
+       * @exception E_INVALID_ARG Either the field is empty or it already exists.
        */
        result AddRequestHeader(const Tizen::Base::String& field, const Tizen::Base::String& value);
 
        /**
        * Sets an HTTP header field.
+       *
        * @since 2.1
+       *
        * @return An error code
        * @param[in] field The HTTP header field
        * @param[in] value The value of the header field
        * @exception E_SUCCESS The method is successful.
-       * @exception E_INVALID_ARG The field is empty or does not exist.
+       * @exception E_INVALID_ARG Either the field is empty or it does not exist.
        */
        result SetRequestHeader(const Tizen::Base::String& field, const Tizen::Base::String& value);
 
        /**
        * Removes an HTTP header field.
+       *
        * @since 2.1
+       *
        * @return An error code
        * @param[in] field The HTTP header field
        * @exception E_SUCCESS The method is successful.
-       * @exception E_INVALID_ARG The field is empty or does not exist.
+       * @exception E_INVALID_ARG Either the field is empty or it does not exist.
        */
        result RemoveRequestHeader(const Tizen::Base::String& field);
 
        /**
-       * Gets the value of the HTTP header field.
+       * Gets the value of an HTTP header field.
+       *
        * @since 2.1
-       * @return The value of HTTP header field if successful, @n
-       * else null if there is no HTTP header field
+       *
+       * @return The value of the HTTP header field if successful, @n
+       * else @c null if there is no HTTP header field
        * @param[in] field The HTTP header field
        */
        Tizen::Base::String* GetRequestHeaderN(const Tizen::Base::String& field);