Update doxygen for app_control_set_defapp func

[platform/core/api/application.git] / include / app_event.h

diff --git a/include/app_event.h b/include/app_event.h
index 80c1a31..1ef7462 100644 (file)
--- a/include/app_event.h
+++ b/include/app_event.h
@@ -55,8 +55,7 @@ typedef void (*event_cb)(const char *event_name, bundle *event_data, void *user_
  * @brief Enumeration for Event Error.
  * @since_tizen 2.4
  */
-typedef enum
-{
+typedef enum {
        EVENT_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
        EVENT_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
        EVENT_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
@@ -79,29 +78,39 @@ typedef enum
  * @see EVENT_VAL_BATTERY_CHARGER_DISCONNECTED
  * @see EVENT_VAL_BATTERY_CHARGER_CONNECTED
  * @see EVENT_VAL_BATTERY_CHARGER_CHARGING
+ * @see EVENT_VAL_BATTERY_CHARGER_DISCHARGING
  */
 #define EVENT_KEY_BATTERY_CHARGER_STATUS "battery_charger_status"
 
 /**
  * @brief Definition for value of EVENT_KEY_BATTERY_CHARGER_STATUS.
  * @since_tizen 2.4
+ * @remarks charger disconnected
  */
 #define EVENT_VAL_BATTERY_CHARGER_DISCONNECTED "disconnected"
 
 /**
  * @brief Definition for value of EVENT_KEY_BATTERY_CHARGER_STATUS.
  * @since_tizen 2.4
- * @remarks Connected but not-available.
+ * @remarks charger connected
  */
 #define EVENT_VAL_BATTERY_CHARGER_CONNECTED "connected"
 
 /**
  * @brief Definition for value of EVENT_KEY_BATTERY_CHARGER_STATUS.
  * @since_tizen 2.4
+ * @remarks charging is enabled
  */
 #define EVENT_VAL_BATTERY_CHARGER_CHARGING "charging"
 
 /**
+ * @brief Definition for value of EVENT_KEY_BATTERY_CHARGER_STATUS.
+ * @since_tizen 2.4
+ * @remarks charging is disabled
+ */
+#define EVENT_VAL_BATTERY_CHARGER_DISCHARGING "discharging"
+
+/**
  * @brief Definition for system-event of battery : level status.
  * @since_tizen 2.4
  * @see EVENT_KEY_BATTERY_LEVEL_STATUS
@@ -152,7 +161,6 @@ typedef enum
 /**
  * @brief Definition for system-event of usb : status of usb connection.
  * @since_tizen 2.4
- * @remarks If there is earlier occurrence regarding this event, you will receive the event as soon as you register event handler for this event. You can use this earlier event-data as initial value.
  * @see EVENT_KEY_USB_STATUS
  */
 #define SYSTEM_EVENT_USB_STATUS "tizen.system.event.usb_status"
@@ -496,10 +504,10 @@ typedef enum
  * @see EVENT_KEY_MSG_TYPE
  * @see EVENT_KEY_MSG_ID
  */
-#define SYSTEM_EVENT_INCOMMING_MSG "tizen.system.event.incoming_msg"
+#define SYSTEM_EVENT_INCOMING_MSG "tizen.system.event.incoming_msg"
 
 /**
- * @brief Definition for key of SYSTEM_EVENT_INCOMMING_MSG.
+ * @brief Definition for key of SYSTEM_EVENT_INCOMING_MSG.
  * @since_tizen 2.4
  * @see EVENT_VAL_SMS
  * @see EVENT_VAL_PUSH
@@ -526,7 +534,7 @@ typedef enum
 #define EVENT_VAL_CB "cb"
 
 /**
- * @brief Definition for key of SYSTEM_EVENT_INCOMMING_MSG.
+ * @brief Definition for key of SYSTEM_EVENT_INCOMING_MSG.
  * @since_tizen 2.4
  * @remarks The value of this key is a string of unsigned int value : new message id.
  */
@@ -779,6 +787,8 @@ typedef enum
  * @retval #EVENT_ERROR_NONE Successful
  * @retval #EVENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #EVENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #EVENT_ERROR_IO_ERROR Adding handler failed
+ * @retval #EVENT_ERROR_OUT_OF_MEMORY Out of memory
  */
 int event_add_event_handler(const char *event_name, event_cb callback, void *user_data,
        event_handler_h *event_handler);