Doxygen update. 42/90442/1
authorWoochan Lee <wc0917.lee@samsung.com>
Fri, 30 Sep 2016 05:31:43 +0000 (14:31 +0900)
committerWoochan Lee <wc0917.lee@samsung.com>
Fri, 30 Sep 2016 05:33:54 +0000 (14:33 +0900)
Add since_tizen marking on enum, type.
+s after verb.

Change-Id: I8e6baeef11b7347f7b8b8b54162a22156cae970c

src/include/efl/mobile/c/ui_application.h
src/include/efl/mobile/c/ui_menu.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
src/include/interface/UiIfaceTypes.h

index 16eb7c2b0ce9cd74e21a692e2edda935021f80a5..c488ef5a8de4e5e720373d6b66e4cc82e896ef64 100644 (file)
@@ -13,10 +13,11 @@ extern "C" {
  */
 
 /**
- *  @brief ui_application's event callback function signature.
+ *  @brief The ui_application event callback function signature.
+ *  @since_tizen 3.0
  *
  *  @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())
+ *  @param[in] event_info Event Information data. (It can casts to app_control_h in app_control())
  *
  *  @return This is reserved
  *
@@ -28,19 +29,20 @@ typedef bool (*ui_application_event_cb)(void *user_data, void *event_info);
 
 /**
  *  @brief Enumeration for ui_application event type.
+ *  @since_tizen 3.0
  */
 typedef enum {
-       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 = 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,      ///<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,      /**< 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;
@@ -48,6 +50,7 @@ typedef enum {
 
 /**
  *  @brief Struct for ui_application event.
+ *  @since_tizen 3.0
  */
 typedef struct
 {
@@ -56,7 +59,7 @@ typedef struct
 } ui_application_event_s;
 
 /**
- *  @brief Initialize ui_application.
+ *  @brief Initializes ui_application.
  *  @details This function initializes ui_application and ui_viewmgr.
  *  @since_tizen 3.0
  *  @remarks Before exit application, call ui_application_term().
@@ -72,7 +75,7 @@ typedef struct
 EAPI bool ui_application_init(const char *pkg, const char *locale_dir);
 
 /**
- *  @brief Run ui_application. This triggers application main loop.
+ *  @brief Runs ui_application. This triggers application main loop.
  *  @remarks This is wrapping ui_app_main() function.
  *  @since_tizen 3.0
  *
@@ -93,7 +96,7 @@ EAPI bool ui_application_init(const char *pkg, const char *locale_dir);
 EAPI bool ui_application_run(int argc, char **argv, ui_application_event_s *events, void *user_data);
 
 /**
- *  @brief This is ui_application destructor.
+ *  @brief Deinitializes ui_application.
  *  @since_tizen 3.0
  *
  *  @return @c true if it succeeds, @c false otherwise
index cfba0de48904545a3f92fec918ce21835dead914..ee74e6038131ed4c1f7845ff97bd933702b3d6bf 100644 (file)
@@ -13,7 +13,7 @@ extern "C" {
  */
 
 /**
- *  @brief Replace or set a content of an ui_menu.
+ *  @brief Replaces or set a content of an ui_menu.
  *  @since_tizen 3.0
  *
  *  @param[in] menu An ui_menu object
@@ -27,7 +27,7 @@ extern "C" {
 EAPI bool ui_menu_set_content(ui_menu *menu, Elm_Ctxpopup *ctxpopup);
 
 /**
- *  @brief Return an ui_menu content.
+ *  @brief Returns an ui_menu content.
  *  @since_tizen 3.0
  *
  *  @param[in] menu An ui_menu instance
@@ -40,7 +40,7 @@ EAPI bool ui_menu_set_content(ui_menu *menu, Elm_Ctxpopup *ctxpopup);
 EAPI Elm_Ctxpopup *ui_menu_get_content(ui_menu *menu);
 
 /**
- *  @brief Unset an ui_menu content.
+ *  @brief Unsets an ui_menu content.
  *  @since_tizen 3.0
  *
  *  @param[in] menu An ui_menu instance
@@ -53,7 +53,7 @@ EAPI Elm_Ctxpopup *ui_menu_get_content(ui_menu *menu);
 EAPI Elm_Ctxpopup *ui_menu_unset_content(ui_menu *menu);
 
 /**
- *  @brief Activate an ui_menu.
+ *  @brief Activates an ui_menu.
  *  @details It makes ui_menu state as show.
  *  @since_tizen 3.0
  *
@@ -66,7 +66,7 @@ EAPI Elm_Ctxpopup *ui_menu_unset_content(ui_menu *menu);
 EAPI bool ui_menu_activate(ui_menu *menu);
 
 /**
- *  @brief Deactivate an ui_menu.
+ *  @brief Deactivates an ui_menu.
  *  @details It makes ui_menu state as hide.
  *  @since_tizen 3.0
  *
@@ -79,7 +79,7 @@ EAPI bool ui_menu_activate(ui_menu *menu);
 EAPI bool ui_menu_deactivate(ui_menu *menu);
 
 /**
- *  @brief Return the active status of ui_menu.
+ *  @brief Returns the active status of ui_menu.
  *  @since_tizen 3.0
  *
  *  @param[in] menu An ui_menu instance
@@ -92,7 +92,7 @@ EAPI bool ui_menu_deactivate(ui_menu *menu);
 EAPI bool ui_menu_get_activated(ui_menu *menu);
 
 /**
- *  @brief Get a base object of an ui_menu.
+ *  @brief Gets a base object of an ui_menu.
  *  @details Normally, A base object can be used for a parent of ui_menu content.
  *  @since_tizen 3.0
  *
@@ -103,7 +103,7 @@ EAPI bool ui_menu_get_activated(ui_menu *menu);
 EAPI Eo *ui_menu_get_base(ui_menu *menu);
 
 /**
- *  @brief Get a current ui_menu's degree.
+ *  @brief Gets a current ui_menu's degree.
  *  @since_tizen 3.0
  *
  *  @param[in] menu An ui_menu instance
@@ -113,7 +113,7 @@ EAPI Eo *ui_menu_get_base(ui_menu *menu);
 EAPI int ui_menu_get_degree(ui_menu *menu);
 
 /**
- *  @brief Return a view which is matched with this ui_menu.
+ *  @brief Returns a view which is matched with this ui_menu.
  *  @since_tizen 3.0
  *
  *  @param[in] menu An ui_menu instance
index d3f683bd316adc81f8388bf7fd8dd7da30691df5..a79327657844e2ed9bdb6cfd44246e0ae5db05fe 100644 (file)
@@ -13,7 +13,7 @@ extern "C" {
  */
 
 /**
- *  @brief A constructor for an ui_popup.
+ *  @brief Creates an ui_popup.
  *  @since_tizen 3.0
  *  @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.
@@ -27,7 +27,7 @@ extern "C" {
 EAPI ui_popup *ui_popup_create(ui_view *view);
 
 /**
- *  @brief A destructor for an ui_popup.
+ *  @brief Destroys an ui_popup.
  *  @details destroy an @a given ui_popup instance.
  *  @since_tizen 3.0
  *
@@ -38,7 +38,7 @@ EAPI ui_popup *ui_popup_create(ui_view *view);
 EAPI void ui_popup_destroy(ui_popup *popup);
 
 /**
- *  @brief Replace or set a content of an ui_popup.
+ *  @brief Replaces or set a content of an ui_popup.
  *  @since_tizen 3.0
  *
  *  @param[in] popup An ui_popup instance
@@ -52,7 +52,7 @@ EAPI void ui_popup_destroy(ui_popup *popup);
 EAPI bool ui_popup_set_content(ui_popup *popup, Elm_Popup *content);
 
 /**
- *  @brief Return a content object of ui_popup.
+ *  @brief Returns a content object of ui_popup.
  *  @since_tizen 3.0
  *
  *  @param[in] popup An ui_popup instance
@@ -65,7 +65,7 @@ EAPI bool ui_popup_set_content(ui_popup *popup, Elm_Popup *content);
 EAPI Elm_Popup *ui_popup_get_content(ui_popup *popup);
 
 /**
- *  @brief Unset an ui_popup content.
+ *  @brief Unsets an ui_popup content.
  *  @since_tizen 3.0
  *
  *  @param[in] popup An ui_popup instance
@@ -78,7 +78,7 @@ EAPI Elm_Popup *ui_popup_get_content(ui_popup *popup);
 EAPI Elm_Popup *ui_popup_unset_content(ui_popup *popup);
 
 /**
- *  @brief Activate an ui_popup.
+ *  @brief Activates an ui_popup.
  *  @details It makes ui_popup state as show.
  *  @since_tizen 3.0
  *
@@ -92,7 +92,7 @@ EAPI Elm_Popup *ui_popup_unset_content(ui_popup *popup);
 EAPI bool ui_popup_activate(ui_popup *popup);
 
 /**
- *  @brief Deactivate an ui_popup.
+ *  @brief Deactivates an ui_popup.
  *  @details It makes ui_popup state as hide.
  *  @since_tizen 3.0
  *
@@ -106,7 +106,7 @@ EAPI bool ui_popup_activate(ui_popup *popup);
 EAPI bool ui_popup_deactivate(ui_popup *popup);
 
 /**
- *  @brief Return the active status of ui_popup.
+ *  @brief Returns the active status of ui_popup.
  *  @since_tizen 3.0
  *
  *  @param[in] popup An ui_popup instance
@@ -119,7 +119,7 @@ EAPI bool ui_popup_deactivate(ui_popup *popup);
 EAPI bool ui_popup_get_activated(ui_popup *popup);
 
 /**
- *  @brief Get a base object of an ui_popup.
+ *  @brief Gets a base object of an ui_popup.
  *  @details Normally, A base object can be used for a parent of ui_popup content.
  *  @since_tizen 3.0
  *
@@ -131,7 +131,7 @@ EAPI bool ui_popup_get_activated(ui_popup *popup);
 EAPI Eo *ui_popup_get_base(ui_popup *popup);
 
 /**
- *  @brief Get current ui_popup's degree.
+ *  @brief Gets current ui_popup's degree.
  *  @since_tizen 3.0
  *
  *  @param[in] popup An ui_popup instance
@@ -141,7 +141,7 @@ EAPI Eo *ui_popup_get_base(ui_popup *popup);
 EAPI int ui_popup_get_degree(ui_popup *popup);
 
 /**
- *  @brief Return a view which is matched with the ui_popup.
+ *  @brief Returns a view which is matched with the ui_popup.
  *  @since_tizen 3.0
  *
  *  @param[in] popup An ui_popup instance
index faf0ab89373f12ed2945a0fc358e2c1f44e29201..a9370912e8133429e5ffd54e9c13d256deea4a82 100644 (file)
@@ -13,7 +13,7 @@ extern "C" {
  */
 
 /**
- *  @brief A constructor for an ui_standard_view.
+ *  @brief Creates 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_get_view_by_name().
  *
@@ -26,7 +26,7 @@ extern "C" {
 EAPI ui_standard_view *ui_standard_view_create(const char *name);
 
 /**
- *  @brief Set a title text.
+ *  @brief Sets a title text.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -39,7 +39,7 @@ EAPI ui_standard_view *ui_standard_view_create(const char *name);
 EAPI bool ui_standard_view_set_title(ui_standard_view *view, const char *text);
 
 /**
- *  @brief Set a subtitle text.
+ *  @brief Sets a subtitle text.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -52,7 +52,7 @@ EAPI bool ui_standard_view_set_title(ui_standard_view *view, const char *text);
 EAPI bool ui_standard_view_set_sub_title(ui_standard_view *view, const char *text);
 
 /**
- *  @brief Set a title badge text.
+ *  @brief Sets a title badge text.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -65,7 +65,7 @@ EAPI bool ui_standard_view_set_sub_title(ui_standard_view *view, const char *tex
 EAPI bool ui_standard_view_set_title_badge(ui_standard_view *view, const char *badge_text);
 
 /**
- *  @brief Set a title_right_btn.
+ *  @brief Sets a title_right_btn.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -79,7 +79,7 @@ EAPI bool ui_standard_view_set_title_badge(ui_standard_view *view, const char *b
 EAPI bool ui_standard_view_set_title_right_btn(ui_standard_view *view, Elm_Button *title_right_btn);
 
 /**
- *  @brief Return a title right button of the view.
+ *  @brief Returns a title right button of the view.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -92,7 +92,7 @@ EAPI bool ui_standard_view_set_title_right_btn(ui_standard_view *view, Elm_Butto
 EAPI Elm_Button *ui_standard_view_get_title_right_btn(ui_standard_view *view);
 
 /**
- *  @brief Unset a title right button of title area.
+ *  @brief Unsets a title right button of title area.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -105,7 +105,7 @@ EAPI Elm_Button *ui_standard_view_get_title_right_btn(ui_standard_view *view);
 EAPI Elm_Button *ui_standard_view_unset_title_right_btn(ui_standard_view *view);
 
 /**
- *  @brief Set a title_left_btn.
+ *  @brief Sets a title_left_btn.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -119,7 +119,7 @@ EAPI Elm_Button *ui_standard_view_unset_title_right_btn(ui_standard_view *view);
 EAPI bool ui_standard_view_set_title_left_btn(ui_standard_view *view, Elm_Button *title_left_btn);
 
 /**
- *  @brief Return a title left button of the view.
+ *  @brief Returns a title left button of the view.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -132,7 +132,7 @@ EAPI bool ui_standard_view_set_title_left_btn(ui_standard_view *view, Elm_Button
 EAPI Elm_Button *ui_standard_view_get_title_left_btn(ui_standard_view *view);
 
 /**
- *  @brief Unset a title right button of title area.
+ *  @brief Unsets a title right button of title area.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -145,7 +145,7 @@ EAPI Elm_Button *ui_standard_view_get_title_left_btn(ui_standard_view *view);
 EAPI Elm_Button *ui_standard_view_unset_title_left_btn(ui_standard_view *view);
 
 /**
- *  @brief Set a toolbar below title.
+ *  @brief Sets a toolbar below title.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -159,7 +159,7 @@ EAPI Elm_Button *ui_standard_view_unset_title_left_btn(ui_standard_view *view);
 EAPI bool ui_standard_view_set_toolbar(ui_standard_view *view, Elm_Toolbar *toolbar);
 
 /**
- *  @brief Return a toolbar of the view.
+ *  @brief Returns a toolbar of the view.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -172,7 +172,7 @@ EAPI bool ui_standard_view_set_toolbar(ui_standard_view *view, Elm_Toolbar *tool
 EAPI Elm_Toolbar *ui_standard_view_get_toolbar(ui_standard_view *view);
 
 /**
- *  @brief Unset a toolbar.
+ *  @brief Unsets a toolbar.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
@@ -185,7 +185,7 @@ EAPI Elm_Toolbar *ui_standard_view_get_toolbar(ui_standard_view *view);
 EAPI Elm_Toolbar *ui_standard_view_unset_toolbar(ui_standard_view *view);
 
 /**
- *  @brief Control the title visible state.
+ *  @brief Controls the title visible state.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_standard_view instance
index 539f232e98a01f06c82ff6827edb2a67deae4e08..6443c4a383e45f2907f390491d5450d95c7b8604 100644 (file)
@@ -13,7 +13,8 @@ extern "C" {
  */
 
 /**
- *  @brief ui_view's event callback function signature.
+ *  @brief The ui_view event callback function signature.
+ *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
  *  @param[in] degree Current view's degree
@@ -28,6 +29,7 @@ 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
 {
@@ -63,7 +65,7 @@ typedef enum
 } ui_view_event_type_e;
 
 /**
- *  @brief A constructor for an ui_view.
+ *  @brief Creates an ui_view.
  *  @since_tizen 3.0
  *  @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().
  *
@@ -76,7 +78,7 @@ typedef enum
 EAPI ui_view *ui_view_create(const char *name);
 
 /**
- *  @brief Replace or set a content of ui_view.
+ *  @brief Replaces or set a content of ui_view.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -90,7 +92,7 @@ EAPI ui_view *ui_view_create(const char *name);
 EAPI bool ui_view_set_content(ui_view *view, Eo *content);
 
 /**
- *  @brief Return a content of this view.
+ *  @brief Returns a content of this view.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -103,7 +105,7 @@ EAPI bool ui_view_set_content(ui_view *view, Eo *content);
 EAPI Eo *ui_view_get_content(ui_view *view);
 
 /**
- *  @brief Unset a ui_view content.
+ *  @brief Unsets a ui_view content.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -116,11 +118,11 @@ EAPI Eo *ui_view_get_content(ui_view *view);
 EAPI Eo *ui_view_unset_content(ui_view *view);
 
 /**
- *  @brief Set callback functions for handling view events.
+ *  @brief Sets callback functions for handling view events.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
- *  @param[in] event_type ui_view event tupe
+ *  @param[in] event_type ui_view event type
  *  @param[in] event_cb The set of callback functions to handle view events
  *  @param[in] user_data The user data to be passed to the given @a event_callback functions
  *
@@ -131,7 +133,7 @@ EAPI Eo *ui_view_unset_content(ui_view *view);
 EAPI bool ui_view_set_event_cb(ui_view *view, ui_view_event_type_e event_type, ui_view_event_cb event_cb, void *user_data);
 
 /**
- *  @brief Get a base object of ui_view.
+ *  @brief Gets a base object of ui_view.
  *  @since_tizen 3.0
  *  @remarks Normally, this base object can be used for a parent of a view content.
  *
@@ -142,7 +144,7 @@ EAPI bool ui_view_set_event_cb(ui_view *view, ui_view_event_type_e event_type, u
 EAPI Eo* ui_view_get_base(ui_view *view);
 
 /**
- *  @brief Set the indicator mode of a ui_view.
+ *  @brief Sets the indicator mode of a ui_view.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -154,7 +156,7 @@ EAPI Eo* ui_view_get_base(ui_view *view);
 EAPI void ui_view_set_indicator(ui_view *view, ui_view_indicator indicator);
 
 /**
- *  @brief Return the indicator mode of this view.
+ *  @brief Returns the indicator mode of this view.
  *  @since_tizen 3.0
  *
  *  @param view An ui_view instance
@@ -166,7 +168,7 @@ EAPI void ui_view_set_indicator(ui_view *view, ui_view_indicator indicator);
 EAPI ui_view_indicator ui_view_get_indicator(ui_view *view);
 
 /**
- *  @breif Set the array of view's available rotations.
+ *  @breif Sets the array of view's available rotations.
  *  @since_tizen 3.0
  *  @remarks Set an array of rotation values.
  *           For instance, {0, 90, 180, 270}. These rotation values depends on the system support.
@@ -181,7 +183,7 @@ EAPI ui_view_indicator ui_view_get_indicator(ui_view *view);
 EAPI bool ui_view_set_available_rotations(ui_view *view, const int *rotations, unsigned int count);
 
 /**
- *  @brief Get the array of view's available rotations.
+ *  @brief Gets the array of view's available rotations.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -194,7 +196,7 @@ EAPI bool ui_view_set_available_rotations(ui_view *view, const int *rotations, u
 EAPI const int *ui_view_get_available_rotations(ui_view *view, unsigned int *count);
 
 /**
- *  @brief Set content removable.
+ *  @brief Sets content removable.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -207,7 +209,7 @@ EAPI const int *ui_view_get_available_rotations(ui_view *view, unsigned int *cou
 EAPI void ui_view_set_removable_content(ui_view *view, bool remove);
 
 /**
- *  @brief Return a state of removable content.
+ *  @brief Returns a state of removable content.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -219,7 +221,7 @@ EAPI void ui_view_set_removable_content(ui_view *view, bool remove);
 EAPI bool ui_view_get_removable_content(ui_view *view);
 
 /**
- *  @brief Get the current view's degree.
+ *  @brief Gets the current view's degree.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -229,7 +231,7 @@ EAPI bool ui_view_get_removable_content(ui_view *view);
 EAPI int ui_view_get_degree(ui_view *view);
 
 /**
- *  @brief Get current view's orientation mode.
+ *  @brief Gets current view's orientation mode.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -241,7 +243,7 @@ EAPI int ui_view_get_degree(ui_view *view);
 EAPI ui_view_orientation_mode ui_view_get_orientation_mode(ui_view *view);
 
 /**
- *  @brief Set transition style of a view.
+ *  @brief Sets transition style of a view.
  *  @since_tizen 3.0
  *
  *  @remarks @a style is reserved for supporting various kinds of view transition effects.
@@ -258,7 +260,7 @@ EAPI ui_view_orientation_mode ui_view_get_orientation_mode(ui_view *view);
 EAPI bool ui_view_set_transition_style(ui_view *view, const char *style);
 
 /**
- *  @brief Return a style name of this view.
+ *  @brief Returns a style name of this view.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -270,7 +272,7 @@ EAPI bool ui_view_set_transition_style(ui_view *view, const char *style);
 EAPI const char *ui_view_get_transition_style(ui_view *view);
 
 /**
- *  @brief Get a ui_menu instance.
+ *  @brief Gets a ui_menu instance.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -280,7 +282,7 @@ EAPI const char *ui_view_get_transition_style(ui_view *view);
 EAPI ui_menu *ui_view_get_menu(ui_view *view);
 
 /**
- *  @brief Return a name of this view.
+ *  @brief Returns a name of this view.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -290,7 +292,7 @@ EAPI ui_menu *ui_view_get_menu(ui_view *view);
 EAPI const char *ui_view_get_name(ui_view *view);
 
 /**
- *  @brief Return a state of this view.
+ *  @brief Returns a state of this view.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
@@ -302,7 +304,7 @@ EAPI const char *ui_view_get_name(ui_view *view);
 EAPI ui_view_state ui_view_get_state(ui_view *view);
 
 /**
- *  @brief A destructor for an ui_view.
+ *  @brief Destroys an ui_view.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view instance
index 8849a7b6f04a9e05e3825789632649da41b19a18..32d9b54558943542b3369c0459e445b4a4891831 100644 (file)
@@ -13,7 +13,7 @@ extern "C" {
  */
 
 /**
- *  @brief Push a new view into ui_viewmgr. This function is used for when application switches a current view to a new one.
+ *  @brief Pushs a new view into ui_viewmgr. This function is used for when application switches a current view to a new one.
  *  @details Normally, the current view will be hidden by a new view. In default, when user calls this API, view will be switched to @a view instantly,
  *           only when ui_viewmgr state is activated. Otherwise, the @a view will be shown later when ui_viewmgr is activated. ui_viewmgr_view_push() is designed
  *           for providing view transition effect. If you want push view instantly without any transition, you could use ui_viewmgr_view_push_insert_before() or
@@ -32,7 +32,7 @@ extern "C" {
 EAPI ui_view *ui_viewmgr_push_view(ui_view *view);
 
 /**
- *  @brief Insert a view in the ui_viewmgr view list. Specifically, insert a given @a view right before of the given view, @before.
+ *  @brief Inserts a view in the ui_viewmgr view list. Specifically, insert a given @a view right before of the given view, @before.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view to insert in the ui_viewmgr view list
@@ -45,7 +45,7 @@ EAPI ui_view *ui_viewmgr_push_view(ui_view *view);
 EAPI bool ui_viewmgr_push_view_insert_before(ui_view *view, ui_view *before);
 
 /**
- *  @brief Insert a view in the ui_viewmgr view list. Specifically, insert a given @a view right after of the given view, @after.
+ *  @brief Inserts a view in the ui_viewmgr view list. Specifically, insert a given @a view right after of the given view, @after.
  *  @since_tizen 3.0
  *
  *  @param[in] view An ui_view to insert in the ui_viewmgr view list
@@ -58,7 +58,7 @@ EAPI bool ui_viewmgr_push_view_insert_before(ui_view *view, ui_view *before);
 EAPI bool ui_viewmgr_push_view_insert_after(ui_view *view, ui_view *after);
 
 /**
- *  @brief Pop the top(last) view from the ui_viewmgr view list.
+ *  @brief Pops the top(last) view from the ui_viewmgr view list.
  *         This function is used when application switches the current view back to the previous view.
  *         The top view will be removed from the view stack and then it will be deleted by the given ui_viewmgr.
  *  @since_tizen 3.0
@@ -73,7 +73,7 @@ EAPI bool ui_viewmgr_push_view_insert_after(ui_view *view, ui_view *after);
 EAPI bool ui_viewmgr_pop_view(void);
 
 /**
- *  @brief Activate this view manager.
+ *  @brief Activates this view manager.
  *  @since_tizen 3.0
  *  @remarks ui_viewmgr window and views will be shown once this function is called. Usually this should be called after applications set their all views
  *           on initialization time.
@@ -85,7 +85,7 @@ EAPI bool ui_viewmgr_pop_view(void);
 EAPI bool ui_viewmgr_activate(void);
 
 /**
- *  @brief Deactivate this view manager.
+ *  @brief Deactivates this view manager.
  *
  *  @remarks ui_viewmgr window and views will be hidden once this function is called. this behavior is up ui system, but usually it hides(unmap)
  *           current window in order that application go background.
@@ -97,7 +97,7 @@ EAPI bool ui_viewmgr_activate(void);
 EAPI bool ui_viewmgr_deactivate(void);
 
 /**
- *  @brief Get a window object of ui_viewmgr.
+ *  @brief Gets a window object of ui_viewmgr.
  *  @since_tizen 3.0
  *
  *  @return The window object of ui_viewmgr
@@ -105,7 +105,7 @@ EAPI bool ui_viewmgr_deactivate(void);
 EAPI Elm_Win *ui_viewmgr_get_window(void);
 
 /**
- *  @brief Return a last(top) view.
+ *  @brief Returns a last(top) view.
  *  @since_tizen 3.0
  *
  *  @return The view which is last view of the ui_viewmgr view list
@@ -113,7 +113,7 @@ EAPI Elm_Win *ui_viewmgr_get_window(void);
 EAPI ui_view *ui_viewmgr_get_last_view(void);
 
 /**
- *  @brief Return a view which is matched with the index @a idx.
+ *  @brief Returns a view which is matched with the index @a idx.
  *  @since_tizen 3.0
  *  @remarks You could use the index as the page numbers of the views.
  *           the index number of views are variable since the view list is variable.
@@ -129,7 +129,7 @@ EAPI ui_view *ui_viewmgr_get_last_view(void);
 EAPI ui_view *ui_viewmgr_get_view_by_idx(int idx);
 
 /**
- *  @brief Return a view which is matched with the @a name.
+ *  @brief Returns a view which is matched with the @a name.
  *  @since_tizen 3.0
  *  @remarks Every view have their names as their own identifiers.
  *
@@ -144,7 +144,7 @@ EAPI ui_view *ui_viewmgr_get_view_by_idx(int idx);
 EAPI ui_view *ui_viewmgr_get_view_by_name(const char *name);
 
 /**
- *  @brief Get a base object of a ui_viewmgr.
+ *  @brief Gets a base object of a ui_viewmgr.
  *  @since_tizen 3.0
  *  @remarks Normally, a base object can be used for adding additional objects.
  *
@@ -153,7 +153,7 @@ EAPI ui_view *ui_viewmgr_get_view_by_name(const char *name);
 EAPI Eo *ui_viewmgr_get_base(void);
 
 /**
- *  @brief Return a view index(page) number of the given view.
+ *  @brief Returns a view index(page) number of the given view.
  *         You could use this function to query the given @a view list order.
  *  @since_tizen 3.0
  *  @remarks The index number of views are variable since the view list is variable
@@ -165,7 +165,7 @@ EAPI Eo *ui_viewmgr_get_base(void);
 EAPI int ui_viewmgr_get_view_index(const ui_view *view);
 
 /**
- *  @brief Return the number of views which of ui_viewmgr.
+ *  @brief Returns the number of views which of ui_viewmgr.
  *  @since_tizen 3.0
  *
  *  @return the count of views
@@ -173,7 +173,7 @@ EAPI int ui_viewmgr_get_view_index(const ui_view *view);
 EAPI int ui_viewmgr_get_view_count(void);
 
 /**
- *  @brief Return whether soft back key is required or not.
+ *  @brief Returns whether soft back key is required or not.
  *  @since_tizen 3.0
  *
  *  @return @c true if soft key is required, @c false otherwise
index a940e16e9a47f57e44055b3747ea0908a542efa6..68f8707b50da91d17b01daf025916d3eec9f6d2b 100644 (file)
 
 /**
  *  @brief Possible values for indicator state.
+ *  @since_tizen 3.0
  */
 enum UiViewIndicator
 {
-       UI_VIEW_INDICATOR_UNKNOWN = 0, ///< Unknown state (Exceptional case)
-       UI_VIEW_INDICATOR_DEFAULT,     ///< 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_UNKNOWN = 0, /**< Unknown state (Exceptional case) */
+       UI_VIEW_INDICATOR_DEFAULT,     /**< 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
 };
 typedef enum UiViewIndicator ui_view_indicator;
 
 /**
  *  @brief Possible values for view state.
+ *  @since_tizen 3.0
  */
 enum UiViewState
 {
-       UI_VIEW_STATE_UNKNOWN = 0,     ///< Unknown state (Exceptional case)
-       UI_VIEW_STATE_LOAD,            ///< Load state
-       UI_VIEW_STATE_UNLOAD,          ///< Unload state
-       UI_VIEW_STATE_ACTIVATE,        ///< Activate state
-       UI_VIEW_STATE_DEACTIVATE,      ///< Deactivate state
-       UI_VIEW_STATE_PAUSE,           ///< Pause state
+       UI_VIEW_STATE_UNKNOWN = 0,     /**< Unknown state (Exceptional case) */
+       UI_VIEW_STATE_LOAD,            /**< Load state */
+       UI_VIEW_STATE_UNLOAD,          /**< Unload state */
+       UI_VIEW_STATE_ACTIVATE,        /**< Activate state */
+       UI_VIEW_STATE_DEACTIVATE,      /**< Deactivate state */
+       UI_VIEW_STATE_PAUSE,           /**< Pause state */
        UI_VIEW_STATE_LAST
 };
 typedef enum UiViewState ui_view_state;
 
 /**
  *  @breif Possible values for view orientation mode.
+ *  @since_tizen 3.0
  */
 enum UiViewOrientationMode
 {
-       UI_VIEW_ORIENTATION_MODE_UNKOWN = 0,  ///< Unknown state (Exceptional case)
-       UI_VIEW_ORIENTATION_MODE_PORTRAIT,    ///< Portrait state
-       UI_VIEW_ORIENTATION_MODE_LANDSCAPE,   ///< Landscape state
+       UI_VIEW_ORIENTATION_MODE_UNKOWN = 0,  /**< Unknown state (Exceptional case) */
+       UI_VIEW_ORIENTATION_MODE_PORTRAIT,    /**< Portrait state */
+       UI_VIEW_ORIENTATION_MODE_LANDSCAPE,   /**< Landscape state */
        UI_VIEW_ORIENTATION_MODE_LAST,
 };
 typedef enum UiViewOrientationMode ui_view_orientation_mode;