cpp: updated doc.

Change-Id: I5eecb3acd79f5cb7a2580207787b914689755e85

diff --git a/src/include/efl/mobile/ui_app.h b/src/include/efl/mobile/ui_app.h
index b09de41210682ea65f59603e0279ea65d905fb20..2e9276b5c09eb7e3af3d70d6b3d955a2efcfe36e 100644 (file)
--- a/src/include/efl/mobile/ui_app.h
+++ b/src/include/efl/mobile/ui_app.h
@@ -22,6 +22,17 @@ namespace efl_viewmanager
 
 class ui_viewmgr;
 
+/*
+ *  @class ui_iface_app
+ *
+ *  @ingroup ui_viewmanager
+ *
+ *  @brief ui_iface_app is designed for wrapping the application instance. This class hides unnecessary application settings but expose only basic functions
+ *         such as initialization and run. Basically, it works on the application life-cycle. It has application life-cycle event interfaces such as create(),
+ *         pause(), resume(), terminate(), etc so that users can handle those events for the their application concept. Also, It provides system event
+ *         interfaces such as low_baterry(), low_meomory(), lang_changed(), region_changed() and so on. ui_iface_app create an unique ui_viewmgr instance
+ *         internally, and manage its life.
+*/
 class ui_app : public ui_iface_app
 {
 public:

diff --git a/src/include/interface/ui_iface_app.h b/src/include/interface/ui_iface_app.h
index b73319380c208236088d1928da29333d6de83984..b214fd97351be507432d2c9714aeb19b62f917d6 100644 (file)
--- a/src/include/interface/ui_iface_app.h
+++ b/src/include/interface/ui_iface_app.h
@@ -21,6 +21,17 @@ namespace ui_viewmanager {
 
 class ui_iface_viewmgr;
 
+/**
+ *  @class ui_iface_app
+ *
+ *  @ingroup ui_viewmanager
+ *
+ *  @brief ui_iface_app is designed for wrapping the application instance. This class hides unnecessary application settings but expose only basic functions
+ *         such as initialization and run. Basically, it works on the application life-cycle. It has application life-cycle event interfaces such as create(),
+ *         pause(), resume(), terminate(), etc so that users can handle those events for the their application concept. Also, It provides system event
+ *         interfaces such as low_baterry(), low_meomory(), lang_changed(), region_changed() and so on. ui_iface_app create an unique ui_viewmgr instance
+ *         internally, and manage its life.
+ */
 class ui_iface_app
 {
 public:

diff --git a/src/include/interface/ui_iface_view.h b/src/include/interface/ui_iface_view.h
index ba43284cd2fd523519a6f0c94d38b7b15c8b11d8..a3ca8d191ca8d7f9feb289be2a584e40da603853 100644 (file)
--- a/src/include/interface/ui_iface_view.h
+++ b/src/include/interface/ui_iface_view.h
@@ -215,29 +215,26 @@ protected:
        /**
         *  @brief View deactivate state.
         *
-        *  @note Get ready for unload. Hide transition may be triggered at this point. Deactivate state is triggered on this scenario if this view is still
-        *        visible but it shouldn't be interactive with users. In the most cases, when a view is going to be popped or destroyed, on_deactivate() will be
-        *        triggered. Also, when a new view is pushed, so if it becomes invisible state by other views, on_deactivate() will be triggered also. Some
-        *        UI controls such as a Popup or a Menu popup usually blocks views. For those scenario, this blocked views would be deactivated again,
-        *        But it would be still visible in some way (ie,half transparency).
+        *  @note Get ready for unload. Hide transition may be triggered at this point. If the system blocks application running in some cases such as phone call,
+        *        system notification, application switching ..., Deactivate state will be triggered. Also, when a view is going to be popped or destroyed,
+        *        on_deactivate() will be triggered. Lastly, when a new view is pushed, so if it becomes invisible state by other views, on_deactivate() will be
+        *        triggered also.
         */
        virtual void on_deactivate();
 
        /**
         *  @brief View pause state.
         *
-        *  @note If the system blocks application running in some cases such as phone call, system notification, application switching ..., this Pause will be
-        *        triggered. Other than that, when application window turns to deactivate (@see ui_iface_viewmgr::deactivate()), on_pause() will be called also.
-        *        However, If the view is already deactivated or under the unload state, the pause won't be called.
+        *  @note Some UI controls such as Popup or a Menu popup usually blocks views. For those scenarios, this blocked view would be paused and shouldn't be
+        *        interactive with users. However, still it would be visible in some way (ie, half transparency). For this, this Pause will be triggered.
+        *        If the view is already deactivated or under the unload state, the pause won't be called.
         */
        virtual void on_pause();
 
        /**
         *  @brief View resume state.
         *
-        *  @note When a view is returns to the activate state from pause state, this on_resume() will be triggered. Other than that, when the system
-        *        allows application to turn to activate or when the window turns to activate (@see ui_iface_viewmgr::activate()), on_resume() will be triggered
-        *        for the paused views.
+        *  @note When a view is returns to the activate state from pause state, this on_resume() will be triggered. For instance, a Popup is dismissed.
         */
        virtual void on_resume();
 

diff --git a/src/include/interface/ui_iface_viewmanager.h b/src/include/interface/ui_iface_viewmanager.h
index a6ecb9319c8f32a6c52f0567c6b4217db15c8dfe..1646599f499f34344d04352f91209f5b717e4201 100644 (file)
--- a/src/include/interface/ui_iface_viewmanager.h
+++ b/src/include/interface/ui_iface_viewmanager.h
@@ -24,11 +24,11 @@
  */
 enum ui_view_indicator
 {
-       UI_VIEW_INDICATOR_DEFAULT = 0, ///<Opaque indicator
-       UI_VIEW_INDICATOR_OPTIMAL,     ///<Transparent indicator
-       UI_VIEW_INDICATOR_OVERLAP,     ///<Overlap indicator
-       UI_VIEW_INDICATOR_HIDE,        ///<Indicator hide
-       UI_VIEW_INDICATOR_SHOW,        ///<Indicator show
+       UI_VIEW_INDICATOR_DEFAULT = 0, ///< Opaque indicator
+       UI_VIEW_INDICATOR_OPTIMAL,     ///< Transparent indicator
+       UI_VIEW_INDICATOR_OVERLAP,     ///< Overlap indicator
+       UI_VIEW_INDICATOR_HIDE,        ///< Indicator hide
+       UI_VIEW_INDICATOR_SHOW,        ///< Indicator show
        UI_VIEW_INDICATOR_LAST
 };