Add doxygen tag for defined event

Change-Id: I62ff5449040b898e74c3487c7fa79340ffdf964b
Signed-off-by: SukHyung, Kang <shine.kang@samsung.com>

diff --git a/widget_viewer_evas/include/widget_viewer_evas.h b/widget_viewer_evas/include/widget_viewer_evas.h
index 78d85874f46130c2fbf7184a5c0fbe227555d54c..1a77b75c161beb0df7497a74a6290f11bf9e1dcf 100644 (file)
--- a/widget_viewer_evas/include/widget_viewer_evas.h
+++ b/widget_viewer_evas/include/widget_viewer_evas.h
@@ -49,33 +49,92 @@ extern "C" {
 
 
 /**
- * @brief Event names for smart callback of widget events. You can listen some events from widget by calling evas_object_smart_callback_add.
+ * @brief Widget event for smart callback when widget creation is aborted. You can listen some events from widget by calling evas_object_smart_callback_add.
  * @since_tizen 2.3.1
  * @see #widget_evas_event_info_s
  * @see evas_object_smart_callback_add
  */
-#define WIDGET_SMART_SIGNAL_WIDGET_CREATE_ABORTED   "widget,create,aborted" /**< Widget creation is aborted */
-#define WIDGET_SMART_SIGNAL_WIDGET_CREATED          "widget,created" /**< Widget is created */
-#define WIDGET_SMART_SIGNAL_WIDGET_RESIZE_ABORTED   "widget,resize,aborted" /**< Resizing widget is aborted */
-#define WIDGET_SMART_SIGNAL_WIDGET_RESIZED          "widget,resized" /**< Widget is resized */
-#define WIDGET_SMART_SIGNAL_WIDGET_FAULTED          "widget,faulted" /**< Widget has faulted */
-#define WIDGET_SMART_SIGNAL_UPDATED                 "updated" /**< Widget content is updated */
-#define WIDGET_SMART_SIGNAL_EXTRA_INFO_UPDATED      "info,updated" /**< Widget extra info is updated */
-#define WIDGET_SMART_SIGNAL_PROVIDER_DISCONNECTED   "provider,disconnected" /**< Provider is disconnected */
-#define WIDGET_SMART_SIGNAL_CONTROL_SCROLLER        "control,scroller" /**< Control Scroller */
-#define WIDGET_SMART_SIGNAL_WIDGET_DELETED          "widget,deleted" /**< Widget is deleted */
-#define WIDGET_SMART_SIGNAL_PERIOD_CHANGED          "widget,period,changed" /**< Period is changed */
+#define WIDGET_SMART_SIGNAL_WIDGET_CREATE_ABORTED   "widget,create,aborted"
 
 /**
- * @internal
- * @brief Reason of faults
+ * @brief Widget event for smart callback when widget is created. You can listen some events from widget by calling evas_object_smart_callback_add.
  * @since_tizen 2.3.1
+ * @see #widget_evas_event_info_s
+ * @see evas_object_smart_callback_add
+ */
+#define WIDGET_SMART_SIGNAL_WIDGET_CREATED          "widget,created"
+
+/**
+ * @brief Widget event for smart callback when resizing widget is aborted. You can listen some events from widget by calling evas_object_smart_callback_add.
+ * @since_tizen 2.3.1
+ * @see #widget_evas_event_info_s
+ * @see evas_object_smart_callback_add
+ */
+#define WIDGET_SMART_SIGNAL_WIDGET_RESIZE_ABORTED   "widget,resize,aborted"
+
+/**
+ * @brief Widget event for smart callback when widget is resized. You can listen some events from widget by calling evas_object_smart_callback_add.
+ * @since_tizen 2.3.1
+ * @see #widget_evas_event_info_s
+ * @see evas_object_smart_callback_add
+ */
+#define WIDGET_SMART_SIGNAL_WIDGET_RESIZED          "widget,resized"
+
+/**
+ * @brief Widget event for smart callback when widget has faulted. You can listen some events from widget by calling evas_object_smart_callback_add.
+ * @since_tizen 2.3.1
+ * @see #widget_evas_event_info_s
+ * @see evas_object_smart_callback_add
+ */
+#define WIDGET_SMART_SIGNAL_WIDGET_FAULTED          "widget,faulted"
+
+/**
+ * @brief Widget event for smart callback when widget content is updated. You can listen some events from widget by calling evas_object_smart_callback_add.
+ * @since_tizen 2.3.1
+ * @see #widget_evas_event_info_s
+ * @see evas_object_smart_callback_add
+ */
+#define WIDGET_SMART_SIGNAL_UPDATED                 "updated"
+
+/**
+ * @brief Widget event for smart callback when widget extra info is updated. You can listen some events from widget by calling evas_object_smart_callback_add.
+ * @since_tizen 2.3.1
+ * @see #widget_evas_event_info_s
+ * @see evas_object_smart_callback_add
+ */
+#define WIDGET_SMART_SIGNAL_EXTRA_INFO_UPDATED      "info,updated"
+
+/**
+ * @brief Widget event for smart callback when provider is disconnected. You can listen some events from widget by calling evas_object_smart_callback_add.
+ * @since_tizen 2.3.1
+ * @see #widget_evas_event_info_s
+ * @see evas_object_smart_callback_add
+ */
+#define WIDGET_SMART_SIGNAL_PROVIDER_DISCONNECTED   "provider,disconnected"
+
+/**
+ * @brief Widget event for smart callback when contorl scroller. You can listen some events from widget by calling evas_object_smart_callback_add.
+ * @since_tizen 2.3.1
+ * @see #widget_evas_event_info_s
+ * @see evas_object_smart_callback_add
+ */
+#define WIDGET_SMART_SIGNAL_CONTROL_SCROLLER        "control,scroller"
+
+/**
+ * @brief Widget event for smart callback when widget is deleted. You can listen some events from widget by calling evas_object_smart_callback_add.
+ * @since_tizen 2.3.1
+ * @see #widget_evas_event_info_s
+ * @see evas_object_smart_callback_add
+ */
+#define WIDGET_SMART_SIGNAL_WIDGET_DELETED          "widget,deleted"
+
+/**
+ * @brief Widget event for smart callback when period is changed. You can listen some events from widget by calling evas_object_smart_callback_add.
+ * @since_tizen 2.3.1
+ * @see #widget_evas_event_info_s
+ * @see evas_object_smart_callback_add
  */
-typedef enum widget_fault_type {
-       WIDGET_FAULT_DEACTIVATED,                     /**< widget is deactivated by its fault operation */
-       WIDGET_FAULT_PROVIDER_DISCONNECTED,           /**< Provider is disconnected */
-       WIDGET_FAULT_MAX = 0xFF                       /**< To specify the size of this enumeration type, some compiler enjoy of this kind of notation */
-} widget_fault_type_e;
+#define WIDGET_SMART_SIGNAL_PERIOD_CHANGED          "widget,period,changed"
 
 /**
  * @brief Data structure which will be sent as a parameter of smart callback for signals WIDGET_SMART_SIGNAL_XXX.

diff --git a/widget_viewer_evas/src/widget_viewer_evas.c b/widget_viewer_evas/src/widget_viewer_evas.c
index e7e5d6c5ae318d869d62f26a72cf426d486228eb..f79fa5d177b8c5f6a9de29e9aec3a101bcd1882a 100644 (file)
--- a/widget_viewer_evas/src/widget_viewer_evas.c
+++ b/widget_viewer_evas/src/widget_viewer_evas.c
@@ -178,6 +178,12 @@ struct widget_info {
        int no_response_count;
 };
 
+typedef enum widget_fault_type {
+      WIDGET_FAULT_DEACTIVATED,
+      WIDGET_FAULT_PROVIDER_DISCONNECTED,
+      WIDGET_FAULT_MAX = 0xFF
+} widget_fault_type_e;
+
 static void __flush_event_queue(struct widget_info *info);
 static int __default_delayed_resuming_time = 100;
 static bool __is_delayed_resuming_mode;