Modify api documentation

Changes:
 - Adds a remark section for memory management.

Change-Id: I89a42cca67f22e1156321f72008df7412f262045
Signed-off-by: jusung son <jusung07.son@samsung.com>

diff --git a/include/app_event.h b/include/app_event.h
index 6c1aa73a2cd83fb7a11c52c6773d12242aba54fb..48f0608237dde94efdf07767ebe94e3464b649c3 100644 (file)
--- a/include/app_event.h
+++ b/include/app_event.h
@@ -997,6 +997,7 @@ typedef enum {
  *
  * @since_tizen 2.4
  * @remarks If you want to add the privileged event, you MUST declare right privilege first. Unless that, this function returns #EVENT_ERROR_PERMISSION_DENIED. The privileged events are commented on remarks of it's definitions.
+ * @remarks The @a event_handler should be released using event_remove_event_handler().
  * @param[in] event_name The interested event name
  * @param[in] callback The event callback called when the event occurs
  * @param[in] user_data The user data for passing to callback
@@ -1008,6 +1009,26 @@ typedef enum {
  * @retval #EVENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #EVENT_ERROR_IO_ERROR Adding handler failed
  * @retval #EVENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @par Example
+ * @code
+#include <app_event.h>
+static void low_battery_cb(const char *event_name, bundle *event_data, void *user_data)
+{
+}
+...
+int main()
+{
+  int r;
+  event_handler_h handler = NULL;
+
+  r = event_add_event_handler(SYSTEM_EVENT_LOW_MEMORY, low_battery_cb, NULL, &handler);
+  ...
+  r = event_remove_event_handler(handler);
+
+  return 0;
+}
+ * @endcode
+ * @see event_remove_event_handler()
  */
 int event_add_event_handler(const char *event_name, event_cb callback, void *user_data, event_handler_h *event_handler);