doxygen: update API documentation 78/311578/2 tizen
authorSeonah Moon <seonah1.moon@samsung.com>
Wed, 22 May 2024 11:57:13 +0000 (20:57 +0900)
committerSeonah Moon <seonah1.moon@samsung.com>
Thu, 23 May 2024 01:43:56 +0000 (10:43 +0900)
- Describe how to release memory
- Add sample code

Change-Id: Ifa6aa5712756eed6c8000f999584b776dfa08a0f

include/download.h

index bb82dcf..00a4c70 100755 (executable)
@@ -1181,8 +1181,8 @@ int download_set_notification_app_control(int download_id, download_notification
  * @brief Gets the app control handle (used previously to register notification messages) which is set by download_set_notification_app_control().
  *
  * @details When the notification message is clicked, the action is decided by the app control handle.
- *
  * @since_tizen 2.3
+ * @remarks The @a handle should be released using app_control_destroy().
  * @privlevel public
  * @privilege %http://tizen.org/privilege/download
  *
@@ -1204,6 +1204,17 @@ int download_set_notification_app_control(int download_id, download_notification
  * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED     Not supported
  *
  * @see download_set_notification_app_control()
+ *
+ * @code
+ * #include <download.h>
+ * #include <app_control.h>
+ * ...
+ * int ret = download_get_notification_app_control(id, DOWNLOAD_NOTIFICATION_APP_CONTROL_TYPE_COMPLETE, &handle);
+ * ...
+ *
+ * ret = app_control_destroy(handle);
+ *
+ * @endcode
  */
 int download_get_notification_app_control(int download_id, download_notification_app_control_type_e type, app_control_h *handle);