capi: improve documentation.

Change-Id: I2f630318886f7f17746186dabed397d91a6c760f

diff --git a/src/include/efl/mobile/c/ui_application.h b/src/include/efl/mobile/c/ui_application.h
index 0f1dce8..7e4cbbc 100644 (file)
--- a/src/include/efl/mobile/c/ui_application.h
+++ b/src/include/efl/mobile/c/ui_application.h
@@ -29,6 +29,9 @@ typedef bool (*ui_application_event_cb)(void *user_data, void *event_info);
 
 /**
  * @brief Enumeration for ui_application event type.
+ * @remarks PRE events are designed for overriding the default behavior of the events.
+ *          Normally, ui_application triggers ui_viewmgr actions on those event time.
+ *          To ignore them, you can use PRE event callbacks.
  * @since_tizen 3.0
  */
 typedef enum {
@@ -38,11 +41,11 @@ typedef enum {
        UI_APPLICATION_EVENT_RESUME,          /**< App resume */
        UI_APPLICATION_EVENT_CONTROL,         /**< App control */
 
-       UI_APPLICATION_EVENT_CREATE_PRE,      /**< App create pre */
-       UI_APPLICATION_EVENT_TERMINATE_PRE,   /**< App terminate pre */
-       UI_APPLICATION_EVENT_PAUSE_PRE,       /**< App pause pre */
-       UI_APPLICATION_EVENT_RESUME_PRE,      /**< App resume pre */
-       UI_APPLICATION_EVENT_CONTROL_PRE      /**< App control pre */
+       UI_APPLICATION_EVENT_CREATE_PRE,      /**< Prior to App create. ui_application initializes viewmgr on App create. */
+       UI_APPLICATION_EVENT_TERMINATE_PRE,   /**< Prior to App terminate. ui_application releases viewmgr on App terminate. */
+       UI_APPLICATION_EVENT_PAUSE_PRE,       /**< Prior to App pause. ui_application deactivates of viewmgr on App pause. */
+       UI_APPLICATION_EVENT_RESUME_PRE,      /**< Prior to App resume. ui_application activates of viewmgr on App resume. */
+       UI_APPLICATION_EVENT_CONTROL_PRE      /**< Prior to App control. ui_application activates of viewmgr on App control. */
 } ui_application_event_type_e;
 
 /**
@@ -73,12 +76,13 @@ EAPI int ui_application_init();
 
 /**
  * @brief Runs ui_application. This triggers application main loop.
- * @remarks This is wrapping ui_app_main() function.
+ * @remarks This wraps ui_app_main() function. You don't need to call it manually.
  * @since_tizen 3.0
  *
  * @param[in] argc The argument count
  * @param[in] argv The argument vector
  * @param[in] events Event callback list
+ * @param[in] count Event callback count
  * @param[in] user_data User data for event callbacks
  *
  * @return @c 0 on success, otherwise a negative error value
@@ -90,6 +94,8 @@ EAPI int ui_application_init();
  *
  * @pre Call ui_application_init() before calling this function.
  *
+ * @warning Don't call ui_app_main() additionally.
+ *
  * @see ui_application_event_s
  * @see ui_app_main()
  * @see ui_application_init()
@@ -99,6 +105,7 @@ EAPI int ui_application_run(int argc, char **argv, ui_application_event_s *event
 
 /**
  * @brief Deinitializes ui_application.
+ * @remarks This wraps ui_app_exit() function. You don't need to call it manually.
  * @since_tizen 3.0
  *
  * @return @c 0 on success, otherwise a negative error value
@@ -106,6 +113,8 @@ EAPI int ui_application_run(int argc, char **argv, ui_application_event_s *event
  *
  * @pre Call ui_application_init() before calling this function.
  *
+ * @warning Don't call ui_app_exit() additionally.
+ *
  * @see ui_application_init()
  * @see ui_application_run()
  */

diff --git a/src/include/efl/mobile/c/ui_view.h b/src/include/efl/mobile/c/ui_view.h
index 44e961a..20c8a6a 100644 (file)
--- a/src/include/efl/mobile/c/ui_view.h
+++ b/src/include/efl/mobile/c/ui_view.h
@@ -136,6 +136,7 @@ EAPI Eo *ui_view_unset_content(ui_view *view);
 /**
  * @brief Sets callback functions for handling view events.
  * @since_tizen 3.0
+ * @remarks To unset the events, you can pass @c NULL to @a event_cb.
  *
  * @param[in] view An ui_view instance
  * @param[in] event_type ui_view event type