From: Woochan Lee <wc0917.lee@samsung.com>
Date: Thu, 29 Sep 2016 08:47:03 +0000 (+0900)
Subject: Doxygen update.
X-Git-Tag: submit/tizen/20160930.094404^2~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F79%2F90279%2F1;p=platform%2Fcore%2Fuifw%2Fui-viewmgr.git

Doxygen update.

Change-Id: Id622594769877808cbdda003af10b10d5466f244
---

diff --git a/doc/ui_viewmgr_doc.h b/doc/ui_viewmgr_doc.h
index 1a13c2e..18cd93b 100644
--- a/doc/ui_viewmgr_doc.h
+++ b/doc/ui_viewmgr_doc.h
@@ -1,12 +1,12 @@
 /**
  * @defgroup CAPI_UI_VIEWMGR_MODULE UI View Manager
  * @ingroup CAPI_UI_FRAMEWORK
- * @breif This module provides functionalities for applications ui view management.
+ * @breif This module provides functionalities for applications view management.
  * @section UI_VIEWMGR_GROUP_HEADER Required Header
  *   \#include <ui_viewmanager.h>
  *
  * @section CAPI_UI_VIEWMGR_MODULE_OVERVIEW Overview
- * UI View Manager provides functionalities for applications ui view management.
+ * UI View Manager provides functionalities for applications view management.
  * The view management provides interfaces for view life-cycle, view switching including transition effects and it provides also convenient types of view forms, and application basic infrastructure for each profiles.
  *
  */
diff --git a/src/include/efl/mobile/c/ui_application.h b/src/include/efl/mobile/c/ui_application.h
index fb1e513..16eb7c2 100644
--- a/src/include/efl/mobile/c/ui_application.h
+++ b/src/include/efl/mobile/c/ui_application.h
@@ -5,37 +5,55 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup CAPI_UI_APPLICATION UI Application
+ * @ingroup CAPI_UI_VIEWMGR_MODULE
+ * @brief This module provides functionalities about ui_application.
+ * @{
+ */
+
+/**
+ *  @brief ui_application's event callback function signature.
+ *
+ *  @param[in] user_data The user data to be passed to the given @a event_callback functions
+ *  @param[in] event_info Event Infomation data. (It can casts to app_control_h in app_control())
+ *
+ *  @return This is reserved
+ *
+ *  @see ui_application_event_type_e
+ *  @see ui_application_event_s
+ *  @see ui_application_run()
+ */
 typedef bool (*ui_application_event_cb)(void *user_data, void *event_info);
 
+/**
+ *  @brief Enumeration for ui_application event type.
+ */
 typedef enum {
-	UI_APPLICATION_EVENT_CREATE = 0,
-	UI_APPLICATION_EVENT_TERMINATE,
-	UI_APPLICATION_EVENT_PAUSE ,
-	UI_APPLICATION_EVENT_RESUME,
-	UI_APPLICATION_EVENT_CONTROL,
+	UI_APPLICATION_EVENT_CREATE = 0,      ///<App create
+	UI_APPLICATION_EVENT_TERMINATE,       ///<App terminate
+	UI_APPLICATION_EVENT_PAUSE ,          ///<App pause
+	UI_APPLICATION_EVENT_RESUME,          ///<App resume
+	UI_APPLICATION_EVENT_CONTROL,         ///<App control
 
-	UI_APPLICATION_EVENT_CREATE_PRE,
-	UI_APPLICATION_EVENT_TERMINATE_PRE,
-	UI_APPLICATION_EVENT_PAUSE_PRE,
-	UI_APPLICATION_EVENT_RESUME_PRE,
-	UI_APPLICATION_EVENT_CONTROL_PRE,
+	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_LAST
 } ui_application_event_type_e;
 
-typedef struct
-{
-	ui_application_event_type_e event_type;
-	ui_application_event_cb event_cb;
-
-} ui_application_event_s;
 
 /**
- * @defgroup CAPI_UI_APPLICATION UI Application
- * @ingroup CAPI_UI_VIEWMGR_MODULE
- * @brief This module provides functionalities about ui_application.
- * @{
+ *  @brief Struct for ui_application event.
  */
+typedef struct
+{
+	ui_application_event_type_e event_type;  ///<Type of events
+	ui_application_event_cb event_cb;        ///<Callback function
+} ui_application_event_s;
 
 /**
  *  @brief Initialize ui_application.
@@ -43,7 +61,7 @@ typedef struct
  *  @since_tizen 3.0
  *  @remarks Before exit application, call ui_application_term().
  *
- *  @param[in] pkg The name of package.
+ *  @param[in] pkg The name of package
  *  @param[in] locale_dir The path of locale directory
  *
  *  @return @c true if it succeeds, @c false otherwise
@@ -54,19 +72,20 @@ typedef struct
 EAPI bool ui_application_init(const char *pkg, const char *locale_dir);
 
 /**
- *  @brief Run ui_application. This triggers application main loops.
+ *  @brief Run ui_application. This triggers application main loop.
  *  @remarks This is wrapping ui_app_main() function.
  *  @since_tizen 3.0
  *
  *  @param[in] argc The argument count
  *  @param[in] argv The argument vector
- *  @param[in] events Event callback list.
+ *  @param[in] events Event callback list
  *  @param[in] user_data User data for event callbacks
  *
  *  @return @c true if it succeeds, @c false otherwise
  *
  *  @pre Call ui_application_init() before calling this function.
  *
+ *  @see ui_application_event_s
  *  @see ui_app_main()
  *  @see ui_application_init()
  *  @see ui_application_term()
diff --git a/src/include/efl/mobile/c/ui_popup.h b/src/include/efl/mobile/c/ui_popup.h
index 73bb85a..d3f683b 100644
--- a/src/include/efl/mobile/c/ui_popup.h
+++ b/src/include/efl/mobile/c/ui_popup.h
@@ -15,7 +15,7 @@ extern "C" {
 /**
  *  @brief A constructor for an ui_popup.
  *  @since_tizen 3.0
- *  @remakrs The instance of ui_popup is subordinated to the given @a ui_view. If the given @a ui_view is hidden or deactivated, this ui_popup will be also do
+ *  @remarks The instance of ui_popup is subordinated to the given @a ui_view. If the given @a ui_view is hidden or deactivated, this ui_popup will be also do
  *           same followed to its ui_view behaviors. The instance of ui_popup will be destroyed automatically when the ui_view is destroyed.
  *
  *  @param[in] view An instance of ui_view
diff --git a/src/include/efl/mobile/c/ui_standard_view.h b/src/include/efl/mobile/c/ui_standard_view.h
index 70c0f8c..faf0ab8 100644
--- a/src/include/efl/mobile/c/ui_standard_view.h
+++ b/src/include/efl/mobile/c/ui_standard_view.h
@@ -15,7 +15,7 @@ extern "C" {
 /**
  *  @brief A constructor for an ui_standard_view.
  *  @since_tizen 3.0
- *  @remarks if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_view_get_by_name().
+ *  @remarks if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_get_view_by_name().
  *
  *  @param[in] name view name
  *
diff --git a/src/include/efl/mobile/c/ui_view.h b/src/include/efl/mobile/c/ui_view.h
index 6409826..539f232 100644
--- a/src/include/efl/mobile/c/ui_view.h
+++ b/src/include/efl/mobile/c/ui_view.h
@@ -13,8 +13,7 @@ extern "C" {
  */
 
 /**
- *  @brief ui_view's rotate event callback function signature.
- *  @since_tizen 3.0
+ *  @brief ui_view's event callback function signature.
  *
  *  @param[in] view An ui_view instance
  *  @param[in] degree Current view's degree
@@ -22,44 +21,43 @@ extern "C" {
  *
  *  @return This is reserved
  *
- *  @see ui_view_event_callback_s
- *  @see ui_view_set_event_callbacks
+ *  @see ui_view_event_type_e
+ *  @see ui_view_set_event_cb
  */
 typedef bool (*ui_view_event_cb)(ui_view *view, void *user_data);
 
 /**
  *  @brief Enumeration for ui_view event type.
- *  @since_tizen 3.0
  */
 typedef enum
 {
-	UI_VIEW_EVENT_LOAD = 0,
-	UI_VIEW_EVENT_UNLOAD,
-	UI_VIEW_EVENT_PAUSE,
-	UI_VIEW_EVENT_RESUME,
-	UI_VIEW_EVENT_ACTIVATE,
-	UI_VIEW_EVENT_DEACTIVATE,
-	UI_VIEW_EVENT_DESTROY,
+	UI_VIEW_EVENT_LOAD = 0,          ///< Load
+	UI_VIEW_EVENT_UNLOAD,            ///< Unload
+	UI_VIEW_EVENT_PAUSE,             ///< Pause
+	UI_VIEW_EVENT_RESUME,            ///< Resume
+	UI_VIEW_EVENT_ACTIVATE,          ///< Activate
+	UI_VIEW_EVENT_DEACTIVATE,        ///< Deactivate
+	UI_VIEW_EVENT_DESTROY,           ///< Destroy
 
-	UI_VIEW_EVENT_LOAD_POST,
-	UI_VIEW_EVENT_UNLOAD_POST,
-	UI_VIEW_EVENT_PAUSE_POST,
-	UI_VIEW_EVENT_RESUME_POST,
-	UI_VIEW_EVENT_ACTIVATE_POST,
-	UI_VIEW_EVENT_DEACTIVATE_POST,
-	UI_VIEW_EVENT_DESTROY_POST,
+	UI_VIEW_EVENT_LOAD_POST,         ///< Load post
+	UI_VIEW_EVENT_UNLOAD_POST,       ///< Unload post
+	UI_VIEW_EVENT_PAUSE_POST,        ///< Pause post
+	UI_VIEW_EVENT_RESUME_POST,       ///< Resume post
+	UI_VIEW_EVENT_ACTIVATE_POST,     ///< Activate post
+	UI_VIEW_EVENT_DEACTIVATE_POST,   ///< Deactivate post
+	UI_VIEW_EVENT_DESTROY_POST,      ///< Destroy post
 
-	UI_VIEW_EVENT_ROTATE,
-	UI_VIEW_EVENT_PORTRAIT,
-	UI_VIEW_EVENT_LANDSCAPE,
-	UI_VIEW_EVENT_BACK,
-	UI_VIEW_EVENT_MENU,
+	UI_VIEW_EVENT_ROTATE,            ///< Rotate
+	UI_VIEW_EVENT_PORTRAIT,          ///< Portrait
+	UI_VIEW_EVENT_LANDSCAPE,         ///< Landscape
+	UI_VIEW_EVENT_BACK,              ///< Back
+	UI_VIEW_EVENT_MENU,              ///< Menu
 
-	UI_VIEW_EVENT_ROTATE_POST,
-	UI_VIEW_EVENT_PORTRAIT_POST,
-	UI_VIEW_EVENT_LANDSCAPE_POST,
-	UI_VIEW_EVENT_BACK_POST,
-	UI_VIEW_EVENT_MENU_POST,
+	UI_VIEW_EVENT_ROTATE_POST,       ///< Rotate post
+	UI_VIEW_EVENT_PORTRAIT_POST,     ///< Portrait post
+	UI_VIEW_EVENT_LANDSCAPE_POST,    ///< Landscape post
+	UI_VIEW_EVENT_BACK_POST,         ///< Back post
+	UI_VIEW_EVENT_MENU_POST,         ///< Menu post
 
 	UI_VIEW_EVENT_LAST
 } ui_view_event_type_e;
@@ -67,7 +65,7 @@ typedef enum
 /**
  *  @brief A constructor for an ui_view.
  *  @since_tizen 3.0
- *  @remarks if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_view_get_by_name().
+ *  @remarks if you don't set a view name, you could not look up the view with it's name. @see ui_viewmgr_get_view_by_name().
  *
  *  @param[in] name view name
  *
@@ -277,7 +275,7 @@ EAPI const char *ui_view_get_transition_style(ui_view *view);
  *
  *  @param[in] view An ui_view instance
  *
- *  @return The ui_memnu that connected with given @a view
+ *  @return The ui_menu that connected with given @a view
  */
 EAPI ui_menu *ui_view_get_menu(ui_view *view);
 
diff --git a/src/include/efl/mobile/c/ui_viewmgr.h b/src/include/efl/mobile/c/ui_viewmgr.h
index d936b10..8849a7b 100644
--- a/src/include/efl/mobile/c/ui_viewmgr.h
+++ b/src/include/efl/mobile/c/ui_viewmgr.h
@@ -25,9 +25,9 @@ extern "C" {
  *  @return @a view, @c NULL when it fails to push a @a view
  *
  *  @see ui_viewmgr_activate()
- *  @see ui_viewmgr_view_push_insert_before()
- *  @see ui_viewmgr_view_push_insert_after()
- *  @see ui_viewmgr_view_pop()
+ *  @see ui_viewmgr_push_view_insert_before()
+ *  @see ui_viewmgr_push_view_insert_after()
+ *  @see ui_viewmgr_pop_view()
  */
 EAPI ui_view *ui_viewmgr_push_view(ui_view *view);
 
@@ -40,7 +40,7 @@ EAPI ui_view *ui_viewmgr_push_view(ui_view *view);
  *
  *  @return @c true on success or @c false otherwise
  *
- *  @see ui_viewmgr_view_push_insert_after()
+ *  @see ui_viewmgr_push_view_insert_after()
  */
 EAPI bool ui_viewmgr_push_view_insert_before(ui_view *view, ui_view *before);
 
@@ -53,7 +53,7 @@ EAPI bool ui_viewmgr_push_view_insert_before(ui_view *view, ui_view *before);
  *
  *  @return @c true on success or @c false otherwise
  *
- *  @see ui_viewmgr_view_push_insert_before()
+ *  @see ui_viewmgr_push_view_insert_before()
  */
 EAPI bool ui_viewmgr_push_view_insert_after(ui_view *view, ui_view *after);
 
@@ -68,7 +68,7 @@ EAPI bool ui_viewmgr_push_view_insert_after(ui_view *view, ui_view *after);
  *  @return @c true on success or @c false otherwise
  *
  *  @see ui_viewmgr_deactivate()
- *  @see ui_viewmgr_view_push()
+ *  @see ui_viewmgr_push_view()
  */
 EAPI bool ui_viewmgr_pop_view(void);
 
@@ -123,8 +123,8 @@ EAPI ui_view *ui_viewmgr_get_last_view(void);
  *  @return The view which index is matched with @a idx
  *          If there were no views with index @a idx, @c NULL will be returned
  *
- *  @see ui_viewmgr_view_index_get()
- *  @see ui_viewmgr_view_count_get()
+ *  @see ui_viewmgr_get_view_index()
+ *  @see ui_viewmgr_get_view_count()
  */
 EAPI ui_view *ui_viewmgr_get_view_by_idx(int idx);
 
diff --git a/src/include/interface/UiIfaceTypes.h b/src/include/interface/UiIfaceTypes.h
index 1976934..a940e16 100644
--- a/src/include/interface/UiIfaceTypes.h
+++ b/src/include/interface/UiIfaceTypes.h
@@ -19,7 +19,6 @@
 
 /**
  *  @brief Possible values for indicator state.
- *  @since_tizen 3.0
  */
 enum UiViewIndicator
 {
@@ -35,7 +34,6 @@ typedef enum UiViewIndicator ui_view_indicator;
 
 /**
  *  @brief Possible values for view state.
- *  @since_tizen 3.0
  */
 enum UiViewState
 {
@@ -51,7 +49,6 @@ typedef enum UiViewState ui_view_state;
 
 /**
  *  @breif Possible values for view orientation mode.
- *  @since_tizen 3.0
  */
 enum UiViewOrientationMode
 {