From 622f51ac84c76412c03cd52c4a316718b614faed Mon Sep 17 00:00:00 2001 From: Hermet Park Date: Tue, 22 Nov 2016 16:07:37 +0900 Subject: [PATCH] Fix all doc errors. Change-Id: I3698d8e38a185c397334d96b5358b55dce4cf8db --- src/include/efl/mobile/c/ui_application.h | 1 - src/include/efl/mobile/c/ui_menu.h | 2 +- src/include/efl/mobile/c/ui_standard_view.h | 2 +- src/include/efl/mobile/c/ui_view.h | 7 ++++--- src/include/efl/mobile/c/ui_viewmgr.h | 4 ++-- src/lib/efl/mobile/c/ui_view.cpp | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/include/efl/mobile/c/ui_application.h b/src/include/efl/mobile/c/ui_application.h index 7e4cbbc..35b7568 100644 --- a/src/include/efl/mobile/c/ui_application.h +++ b/src/include/efl/mobile/c/ui_application.h @@ -88,7 +88,6 @@ EAPI int ui_application_init(); * @return @c 0 on success, otherwise a negative error value * @retval #UI_VIEWMGR_ERROR_NONE Successful * @retval #UI_VIEWMGR_ERROR_INVALID_PARAMETER Invalid parameters - * @retval #UI_VIEWMGR_ERROR_APPLICATION The application is illegally launched, not launched by the launch system. * @retval #UI_VIEWMGR_ERROR_ALREADY_IN_PROGRESS The main loop already starts * @retval #UI_VIEWMGR_ERROR_NOT_PERMITTED If Initialization was not performed yet * diff --git a/src/include/efl/mobile/c/ui_menu.h b/src/include/efl/mobile/c/ui_menu.h index 21234ed..c003878 100644 --- a/src/include/efl/mobile/c/ui_menu.h +++ b/src/include/efl/mobile/c/ui_menu.h @@ -17,7 +17,7 @@ extern "C" { * @since_tizen 3.0 * * @param[in] menu An ui_menu object - * @param[in] ctxpopup ctxpopup object. It allows @c NULL for canceling the previous content + * @param[in] content ctxpopup object. It allows @c NULL for canceling the previous content * * @return @c 0 on success, otherwise a negative error value * @retval #UI_VIEWMGR_ERROR_NONE Successful diff --git a/src/include/efl/mobile/c/ui_standard_view.h b/src/include/efl/mobile/c/ui_standard_view.h index b4a8f63..5af5fe8 100644 --- a/src/include/efl/mobile/c/ui_standard_view.h +++ b/src/include/efl/mobile/c/ui_standard_view.h @@ -68,7 +68,7 @@ EAPI int ui_standard_view_set_sub_title(ui_standard_view *view, const char *text * @since_tizen 3.0 * * @param[in] view An ui_standard_view instance - * @param[in] text The label in the title badge area + * @param[in] badge_text The label in the title badge area * * @return @c 0 on success, otherwise a negative error value * @retval #UI_VIEWMGR_ERROR_NONE Successful diff --git a/src/include/efl/mobile/c/ui_view.h b/src/include/efl/mobile/c/ui_view.h index 20c8a6a..077c037 100644 --- a/src/include/efl/mobile/c/ui_view.h +++ b/src/include/efl/mobile/c/ui_view.h @@ -208,6 +208,7 @@ EAPI ui_view_indicator ui_view_get_indicator(const ui_view *view); * @remarks Set an array of rotation values. * For instance, {0, 90, 180, 270}. These rotation values depends on the system support. * + * @param[in] view An ui_view instance * @param[in] rotations The array of rotation values * @param[in] count The number of arrays of rotations * @@ -255,7 +256,7 @@ EAPI const int *ui_view_get_available_rotations(const ui_view *view, unsigned in * * @see ui_view_get_removable_content() */ -EAPI int ui_view_set_removable_content(ui_view *view, bool remove); +EAPI int ui_view_set_removable_content(ui_view *view, bool removable); /** * @brief Returns a state of removable content. @@ -355,7 +356,7 @@ EAPI const char *ui_view_get_transition_style(const ui_view *view); * @exception #UI_VIEWMGR_ERROR_NONE Successfully added * @exception #UI_VIEWMGR_ERROR_INVALID_PARAMETER @a view is invalid * - * @get_last_result() + * @see get_last_result() */ EAPI ui_menu *ui_view_get_menu(const ui_view *view); @@ -371,7 +372,7 @@ EAPI ui_menu *ui_view_get_menu(const ui_view *view); * @exception #UI_VIEWMGR_ERROR_NONE Successfully added * @exception #UI_VIEWMGR_ERROR_INVALID_PARAMETER @a view is invalid * - * @get_last_result() + * @see get_last_result() */ EAPI const char *ui_view_get_name(const ui_view *view); diff --git a/src/include/efl/mobile/c/ui_viewmgr.h b/src/include/efl/mobile/c/ui_viewmgr.h index 70ec532..5eac1f7 100644 --- a/src/include/efl/mobile/c/ui_viewmgr.h +++ b/src/include/efl/mobile/c/ui_viewmgr.h @@ -35,7 +35,7 @@ extern "C" { EAPI int ui_viewmgr_push_view(ui_view *view); /** - * @brief Inserts 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, @a before. * @since_tizen 3.0 * * @param[in] view An ui_view to insert in the ui_viewmgr view list @@ -51,7 +51,7 @@ EAPI int ui_viewmgr_push_view(ui_view *view); EAPI int ui_viewmgr_insert_view_before(ui_view *view, ui_view *before); /** - * @brief Inserts 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, @a after. * @since_tizen 3.0 * * @param[in] view An ui_view to insert in the ui_viewmgr view list diff --git a/src/lib/efl/mobile/c/ui_view.cpp b/src/lib/efl/mobile/c/ui_view.cpp index b9c4209..2f3730b 100644 --- a/src/lib/efl/mobile/c/ui_view.cpp +++ b/src/lib/efl/mobile/c/ui_view.cpp @@ -282,12 +282,12 @@ EAPI ui_view_indicator ui_view_get_indicator(const ui_view *view) return view->getIndicator(); } -EAPI int ui_view_set_removable_content(ui_view *view, bool remove) +EAPI int ui_view_set_removable_content(ui_view *view, bool removable) { int ret = validate_view(view); if (ret != UI_VIEWMGR_ERROR_NONE) return ret; - view->setRemovableContent(remove); + view->setRemovableContent(removable); return UI_VIEWMGR_ERROR_NONE; } -- 2.34.1