From: Woochan Lee <wc0917.lee@samsung.com>
Date: Fri, 17 Jun 2016 06:01:26 +0000 (+0900)
Subject: [doc] Doxygen update.
X-Git-Tag: submit/tizen/20160617.075742~2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=28439c11e0a95f75292f88cc86f197f39bf38a27;p=platform%2Fcore%2Fuifw%2Fui-viewmgr.git

[doc] Doxygen update.

Change-Id: I4ad01edb5fbbdd3b0c7efe8627d55bb1f26b0660
---

diff --git a/src/include/efl/mobile/c/ui_application.h b/src/include/efl/mobile/c/ui_application.h
index 762a497..5a0a5bb 100644
--- a/src/include/efl/mobile/c/ui_application.h
+++ b/src/include/efl/mobile/c/ui_application.h
@@ -5,6 +5,13 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup CAPI_UI_VIEWMGR_APPLICATION ui_application
+ * @ingroup CAPI_UI_VIEWMGR
+ * @brief This module provides functionalities about ui_application.
+ * @{
+ */
+
 /**
  *  @brief Initialize ui_application.
  *
@@ -48,4 +55,8 @@ bool ui_application_term(void);
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* _UI_APPLICATION_CAPI_H_ */
diff --git a/src/include/efl/mobile/c/ui_menu.h b/src/include/efl/mobile/c/ui_menu.h
index 8c38eeb..d57431b 100644
--- a/src/include/efl/mobile/c/ui_menu.h
+++ b/src/include/efl/mobile/c/ui_menu.h
@@ -5,6 +5,13 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup CAPI_UI_VIEWMGR_MENU ui_menu
+ * @ingroup CAPI_UI_VIEWMGR
+ * @brief This module provides functionalities about ui_menu.
+ * @{
+ */
+
 /**
  *  @brief Replace or set a content of an ui_menu.
  *
@@ -110,4 +117,8 @@ ui_view *ui_menu_view_get(ui_menu *menu);
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* _UI_MENU_CAPI_H_ */
diff --git a/src/include/efl/mobile/c/ui_mobile_viewmanager.h b/src/include/efl/mobile/c/ui_mobile_viewmanager.h
index f65c1df..02e1dea 100644
--- a/src/include/efl/mobile/c/ui_mobile_viewmanager.h
+++ b/src/include/efl/mobile/c/ui_mobile_viewmanager.h
@@ -17,6 +17,23 @@
 #ifndef _UI_MOBILE_VIEWMANAGER_CAPI_H_
 #define _UI_MOBILE_VIEWMANAGER_CAPI_H_
 
+/**
+ * @internal
+ * @defgroup CAPI_UI_VIEWMGR ui-viewmgr
+ * @brief This module provides functionalities to manage view of application's.
+ * @section UI_VIEWMGR_GROUP_HEADER Required Header
+ *   \#include <ui_viewmanager.h>
+ *
+ * @section CAPI_UI_VIEWMGR_MODULE_OVERVIEW Overview
+ * ui-viewmgr provides functionalities to manage view of application's.
+ * It includes below features.
+ * 1. View Life-cycle events.
+ * 2. Support view managing methods.
+ * 3. H/W key event support by each view.
+ * 4. Considered overlay controls as view.(ex.Popup, ctxpoup)
+ * 5. Support profile specific UX.
+ */
+
 #include <Elementary.h>
 #include <app.h>
 #include <dlog.h>
diff --git a/src/include/efl/mobile/c/ui_popup.h b/src/include/efl/mobile/c/ui_popup.h
index da0b062..4dca6f3 100644
--- a/src/include/efl/mobile/c/ui_popup.h
+++ b/src/include/efl/mobile/c/ui_popup.h
@@ -5,6 +5,13 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup CAPI_UI_VIEWMGR_POPUP ui_popup
+ * @ingroup CAPI_UI_VIEWMGR
+ * @brief This module provides functionalities about ui_popup.
+ * @{
+ */
+
 /**
  *  @brief A constructor for an ui_popup.
  *
@@ -137,4 +144,8 @@ ui_view *ui_popup_view_get(ui_popup *popup);
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* _UI_POPUP_CAPI_H_ */
diff --git a/src/include/efl/mobile/c/ui_standard_view.h b/src/include/efl/mobile/c/ui_standard_view.h
index 0462896..d1b18bb 100644
--- a/src/include/efl/mobile/c/ui_standard_view.h
+++ b/src/include/efl/mobile/c/ui_standard_view.h
@@ -5,6 +5,13 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup CAPI_UI_VIEWMGR_STANDARD_VIEW ui_standard_view
+ * @ingroup CAPI_UI_VIEWMGR
+ * @brief This module provides functionalities about ui_standard_view.
+ * @{
+ */
+
 /**
  *  @brief A constructor for an ui_standard_view.
  *
@@ -177,4 +184,8 @@ bool ui_standard_view_title_visible_set(ui_view *view, bool visible, bool anim);
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* _UI_STANDARD_VIEW_CAPI_H_ */
diff --git a/src/include/efl/mobile/c/ui_view.h b/src/include/efl/mobile/c/ui_view.h
index 9e88547..e8ed769 100644
--- a/src/include/efl/mobile/c/ui_view.h
+++ b/src/include/efl/mobile/c/ui_view.h
@@ -5,6 +5,12 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup CAPI_UI_VIEWMGR_VIEW ui_view
+ * @ingroup CAPI_UI_VIEWMGR
+ * @brief This module provides functionalities about ui_view.
+ * @{
+ */
 
 /**
  *  @brief ui_view's lifecycle callback function signature.
@@ -276,4 +282,8 @@ bool ui_view_destroy(ui_view *view);
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* _UI_VIEW_CAPI_H_ */
diff --git a/src/include/efl/mobile/c/ui_viewmgr.h b/src/include/efl/mobile/c/ui_viewmgr.h
index 14083fa..3677e91 100644
--- a/src/include/efl/mobile/c/ui_viewmgr.h
+++ b/src/include/efl/mobile/c/ui_viewmgr.h
@@ -5,6 +5,13 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup CAPI_UI_VIEWMGR_VIEWMGR ui_viewmgr
+ * @ingroup CAPI_UI_VIEWMGR
+ * @brief This module provides functionalities about ui_viewmgr.
+ * @{
+ */
+
 /**
  *  @brief Push a new view into given @p viewmgr. This function is used for when application switches a current view to a new one.
  *
@@ -209,4 +216,8 @@ ui_viewmgr *ui_viewmgr_viewmgr_get();
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* _UI_VIEWMGR_CAPI_H_ */