From 8e7355f34716923596ae5f6342670dbfdf3c6af3 Mon Sep 17 00:00:00 2001 From: cheoleun moon Date: Wed, 13 Dec 2023 15:44:00 +0900 Subject: [PATCH] Fix API reference Change-Id: Ia5a5abdbde4a3b20b5327dc6217c9cbb5e6a550e Signed-off-by: cheoleun moon --- include/download.h | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/include/download.h b/include/download.h index bfa465b..bb82dcf 100755 --- a/include/download.h +++ b/include/download.h @@ -67,7 +67,7 @@ typedef enum { DOWNLOAD_ERROR_RESPONSE_TIMEOUT = TIZEN_ERROR_DOWNLOAD | 0x33, /**< No call to start API for some time although the download is created*/ DOWNLOAD_ERROR_SYSTEM_DOWN = TIZEN_ERROR_DOWNLOAD | 0x34, /**< No response from client after rebooting download daemon*/ DOWNLOAD_ERROR_ID_NOT_FOUND = TIZEN_ERROR_DOWNLOAD | 0x35, /**< Download ID does not exist in download service module*/ - DOWNLOAD_ERROR_INVALID_NETWORK_TYPE = TIZEN_ERROR_DOWNLOAD | 0x36, /**< Network bonding is set but network type is not set as DOWNLOAD_NETWORK_ALL*/ + DOWNLOAD_ERROR_INVALID_NETWORK_TYPE = TIZEN_ERROR_DOWNLOAD | 0x36, /**< Network bonding is set but network type is not set as #DOWNLOAD_NETWORK_ALL*/ DOWNLOAD_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA, /**< No data because the set API is not called */ DOWNLOAD_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR , /**< Internal I/O error */ } download_error_e; @@ -414,7 +414,7 @@ int download_get_destination(int download_id, char **path); * * @param[in] download_id The download ID * @param[in] file_name The file name for the downloaded file \n - * If @a name is @c NULL it clears the previous value. + * If @a file_name is @c NULL it clears the previous value. * * @return @c 0 on success, * otherwise a negative error value @@ -657,7 +657,7 @@ int download_get_http_header_field(int download_id, const char *field, char **va * @privlevel public * @privilege %http://tizen.org/privilege/download * - * @remarks You must release @a value using free(). + * @remarks You must release @a fields using free(). * * @param[in] download_id The download ID * @param[out] fields The array of the HTTP header fields @@ -963,6 +963,8 @@ int download_get_state(int download_id, download_state_e *state); * @privlevel public * @privilege %http://tizen.org/privilege/download * + * @remarks The @a temp_path should be released using free(). + * * @param[in] download_id The download ID * @param[out] temp_path The full path of temporary file * @@ -1029,6 +1031,8 @@ int download_set_temp_file_path(int download_id, char *path); * @privlevel public * @privilege %http://tizen.org/privilege/download * + * @remarks The @a content_name should be released using free(). + * * @param[in] download_id The download ID * @param[out] content_name The content name for displaying to user * @@ -1242,6 +1246,8 @@ int download_set_notification_title(int download_id, const char *title); * @privlevel public * @privilege %http://tizen.org/privilege/download * + * @remarks The @a title should be released using free(). + * * @param[in] download_id The download ID * @param[out] title The title for displaying to user * @@ -1300,6 +1306,8 @@ int download_set_notification_description(int download_id, const char *descripti * @privlevel public * @privilege %http://tizen.org/privilege/download * + * @remarks The @a description should be released using free(). + * * @param[in] download_id The download ID * @param[out] description The description for displaying to user * @@ -1393,6 +1401,7 @@ int download_get_notification_type(int download_id, download_notification_type_e * * @remarks The etag value is available or not depending on the web server. \n * After download is started, it can get the etag value. + * @remarks The @a etag should be released using free(). * * @param[in] download_id The download ID * @param[out] etag The etag value -- 2.7.4