[doc] Doxygen update. 25/75225/4
authorWoochan Lee <wc0917.lee@samsung.com>
Fri, 17 Jun 2016 06:01:26 +0000 (15:01 +0900)
committerWoochan Lee <wc0917.lee@samsung.com>
Fri, 17 Jun 2016 06:04:35 +0000 (15:04 +0900)
Change-Id: I4ad01edb5fbbdd3b0c7efe8627d55bb1f26b0660

src/include/efl/mobile/c/ui_application.h
src/include/efl/mobile/c/ui_menu.h
src/include/efl/mobile/c/ui_mobile_viewmanager.h
src/include/efl/mobile/c/ui_popup.h
src/include/efl/mobile/c/ui_standard_view.h
src/include/efl/mobile/c/ui_view.h
src/include/efl/mobile/c/ui_viewmgr.h

index 762a497f94d6c81df31485c8751c97311612aa6e..5a0a5bb951058d586d1b50597df6e4315503d7f4 100644 (file)
@@ -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_ */
index 8c38eebc6a26438befde82b2822f35c96bf3fabb..d57431b0df4ef62b673500f6d22ce31bd0624f8b 100644 (file)
@@ -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_ */
index f65c1dfa48c28e8c4b0cb1f4ce91667331414718..02e1dea63302c4be5e1334733cd69226e9a26789 100644 (file)
 #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>
index da0b062c7f6cecf18aada6e7ca9c0d20f34ba02d..4dca6f3440cf4f70e4076a997cfa24c826f3e830 100644 (file)
@@ -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_ */
index 04628961f9b40b262f21f1f5def9bbbd6f479e5e..d1b18bb8b0dfb7a106f4f091f342b6d6cdea7f40 100644 (file)
@@ -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_ */
index 9e88547ac5d846350a02df3c2b49767d46534415..e8ed76970ad2aea8193cb00454959f5784e0ec29 100644 (file)
@@ -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_ */
index 14083fae3ad138a615d08a596fa425435f54d392..3677e91e774f12e4fad5f8e77e57e6b246dd3a82 100644 (file)
@@ -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_ */