Modify api documentation

Changes:
 - Adds a remark section for memory management.

Change-Id: I60794891b5943cb56c906a6dbfbd5bcfb56e504e
Signed-off-by: Changgyu Choi <changyu.choi@samsung.com>

diff --git a/include/service_app.h b/include/service_app.h
index ebd0ed4..2d84c3b 100644 (file)
--- a/include/service_app.h
+++ b/include/service_app.h
@@ -85,6 +85,7 @@ typedef struct {
  * @brief Adds the system event handler.
  * @since_tizen 2.3
  * @remarks The service application can handle low memory event, low battery event, language setting changed event and region format changed event.
+ * @remarks The @a handler should be released using service_app_remove_event_handler().
  * @param[out] handler The event handler
  * @param[in] event_type The system event type
  * @param[in] callback The callback function
@@ -94,6 +95,27 @@ typedef struct {
  * @retval #APP_ERROR_NONE Successful
  * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #APP_ERROR_OUT_OF_MEMORY Out of memory
+ * @par Example
+ * @code
+#include <service_app.h>
+
+static void
+service_app_low_battery(app_event_info_h event_info, void *user_data)
+{
+}
+...
+int main()
+{
+  int r;
+  app_event_handler_h handler = NULL;
+
+  r = service_app_add_event_handler(&handler, APP_EVENT_LOW_BATTERY, service_app_low_battery, NULL);
+  ...
+  r = service_app_remove_event_handler(handler);
+
+  return 0;
+}
+ * @endcode
  * @see app_event_type_e
  * @see app_event_cb()
  * @see service_app_remove_event_handler()