add api parameter in/out syntax.
Change-Id: I407cad6307aeb599331b1278d070aff7cebcd783
/**
* @brief Check the menu key event occurs or not.
*
+ * @param[in] view event view.
+ * @param[in] ev event information.
+ *
* @note This is checking H/W key is menu or not.
*/
virtual void extendEventProc(UiBaseView *view, Evas_Event_Key_Down *ev) {}
/**
* @brief This is a constructor for initializing overlay.
*
- * @param view The instance of UiBaseView.
+ * @param[in] view The instance of UiBaseView.
*/
explicit UiBaseOverlay(UiBaseView *view);
/**
* @brief This is a constructor for initializing this view resources.
*
- * @param name view name.
+ * @param[in] name view name.
*/
explicit UiBaseView(const char *name = nullptr);
/**
* @brief This is for replacing or setting a content of the view.
*
- * @param content a new content. It allows @c nullptr for canceling the previous content.
+ * @param[in] content a new content. It allows @c nullptr for canceling the previous content.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Set the indicator mode.
*
+ * @param[in] indicator indicator mode.
+ *
* @return @c 0 on success, otherwise a negative error value.
+ *
* @retval #TIZEN_ERROR_NONE Successful
* @retval #TIZEN_ERROR_INVALID_PARAMETER @a indicator is not valid.
* @retval #TIZEN_ERROR_NOT_PERMITTED Current view manager system is not set up.
* @note Set an array of rotation values.
* For instance, {0, 90, 180, 270}. These rotation values depends on the system support.
*
- * @param rotations The array of rotation values.
- * @param count The number of arrays of rotations.
+ * @param[in] rotations The array of rotation values.
+ * @param[in] count The number of arrays of rotations.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
*
* @note It makes view content event freeze during effect showing.
*
- * @param block @c true, when blocking is enabled, otherwise @c false.
+ * @param[in] block @c true, when blocking is enabled, otherwise @c false.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
*
* @note This state will be called when view rotation changed.
*
- * @param degree The current degree of view.
+ * @param[in] degree The current degree of view.
*
* @see onPortrait()
* @see onLandscpae()
* view transition effect. If you want push view instantly without any transition, you could use insert_view_before() or insert_view_after().
* If you want to pop the current view, the please use pop_view().
*
- * @param view A view to insert in the viewmgr view list.
+ * @param[in] view A view to insert in the viewmgr view list.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is not valid.
/**
* @brief Insert a view in this viewmgr view list. Specifically, insert a given @a view right before of the given view, @before.
*
- * @param view A view to insert in the viewmgr view list.
- * @param before A view that will be just inserted after @a view. If you pass @c nullptr, @a view will be inserted at the front of the view list.
+ * @param[in] view A view to insert in the viewmgr view list.
+ * @param[in] before A view that will be just inserted after @a view. If you pass @c nullptr, @a view will be inserted at the front of the view list.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Insert a view in this viewmgr view list. Specifically, insert a given @a view right after of the given view, @after.
*
- * @param view A view to insert in the viewmgr view list.
- * @param after A view that will be just inserted before the @a view. If you pass @c nullptr, @a view will be inserted at the end of the view list.
+ * @param[in] view A view to insert in the viewmgr view list.
+ * @param[in] after A view that will be just inserted before the @a view. If you pass @c nullptr, @a view will be inserted at the end of the view list.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Return a view which is matched with the index @a idx.
*
- * @param idx A index of the view which you are looking for.
+ * @param[in] idx A index of the view which you are looking for.
*
* @return The view which index is matched with @a idx.
* If there were no views with index @a idx, @c nullptr will be returned.
*
* @note Every view have their names as their own identifiers.
*
- * @param name The name of the view which you are looking for.
+ * @param[in] name The name of the view which you are looking for.
*
* @return The view which name is matched with @a name.
* If there were no views name matched, @c nullptr will be returned.
/**
* @brief Set indicator of the view.
*
- * @param indicator The mode to set, one of #UiViewIndicator.
+ * @param[in] indicator The mode to set, one of #UiViewIndicator.
*/
void setIndicator(UiViewIndicator indicator);
/**
* @brief This is a constructor for initializing viewmgr.
*
- * @param pkg The name of package.
- * @param key_listener The instance of UiBaseKeyListener.
+ * @param[in] pkg The name of package.
+ * @param[in] key_listener The instance of UiBaseKeyListener.
*/
UiBaseViewmgr(const char *pkg, UiBaseKeyListener *keyListener);
/**
* @brief This is a constructor for initializing viewmgr.
*
- * @param pkg The name of package.
+ * @param[in] pkg The name of package.
*/
explicit UiBaseViewmgr(const char *pkg);
/**
* @brief This is a constructor for initializing UiApp.
*
- * @param pkg The name of package.
- * @param loale_dir The path of locale directory.
+ * @param[in] pkg The name of package.
+ * @param[in] loale_dir The path of locale directory.
*/
UiApp(const char *pkg, const char *locale_dir);
/**
* @brief This is a constructor for initializing this UiKeyListener.
*
- * @param The instance of UiViewmgr.
+ * @param[in] The instance of UiViewmgr.
*/
explicit UiKeyListener(UiViewmgr *viewmgr);
/**
* @brief Check the menu key event occurs or not.
*
+ * @param[in] view event view.
+ * @param[in] ev event information.
+ *
* @note This is checking H/W key is menu or not.
*/
virtual void extendEventProc(UiBaseView *view, Evas_Event_Key_Down *ev) override;
/**
* @brief This is for replacing or setting a content of the menu.
*
- * @param ctxpopup ctxpopup object. It allows @c nullptr for canceling the previous content.
+ * @param[in] ctxpopup ctxpopup object. It allows @c nullptr for canceling the previous content.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief This is a constructor for initializing this menu.
*
- * @param The instance of UiView.
+ * @param[in] The instance of UiView.
*/
explicit UiMenu(UiView *view);
/**
* @brief This is a constructor for initializing this popup.
*
- * @param The instance of UiView.
+ * @param[in] The instance of UiView.
*/
explicit UiPopup(UiView *view);
/**
* @brief This is for replacing or setting a content of the popup.
*
- * @param popup popup object. It allows @c nullptr for canceling the previous content.
+ * @param[in] popup popup object. It allows @c nullptr for canceling the previous content.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief A constructor for an UiStandardView.
*
- * @param name view name.
+ * @param[in] name view name.
*/
explicit UiStandardView(const char *name = nullptr);
/**
* @brief Replace or set a content of the view.
*
- * @param content a new content. It allows @c nullptr for canceling the previous content.
- * @param title title_label The label in the title area. The name of the title label part is "elm.text.title"
+ * @param[in] content a new content. It allows @c nullptr for canceling the previous content.
+ * @param[in] title title_label The label in the title area. The name of the title label part is "elm.text.title"
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Set a title badge text.
*
- * @param text The label in the title badge area.
+ * @param[in] text The label in the title badge area.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Set a subtitle text.
*
- * @param text The label in the subtitle area.
+ * @param[in] text The label in the subtitle area.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Set a title_left_btn.
*
- * @param title_left_btn The button in the left part of title area.
+ * @param[in] title_left_btn The button in the left part of title area.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Set a title_right_btn.
*
- * @param title_right_btn The button in the right part of title area.
+ * @param[in] title_right_btn The button in the right part of title area.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Set a title text.
*
- * @param text The label in the title area.
+ * @param[in] text The label in the title area.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Set a toolbar below title.
*
- * @param toolbar Toolbar object.
+ * @param[in] toolbar Toolbar object.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Control the title visible state.
*
- * @param visible title state set as visible if the given param is @c true, otherwise title area set as invisible.
- * @param anim title area will be shown with animation if the given param is @c true, otherwise title area will be shown without animation.
+ * @param[in] visible title state set as visible if the given param is @c true, otherwise title area set as invisible.
+ * @param[in] anim title area will be shown with animation if the given param is @c true, otherwise title area will be shown without animation.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
* @note This interface is designed for toggling touch event on view transition.
* UiIfaceViewmgr will call this interface for notifying event blocking toggling on transition time.
*
+ * @param[in] block block status.
+ *
* @return @c 0 on success, otherwise a negative error value.
+ *
* @retval #TIZEN_ERROR_NONE Successful
* @retval #TIZEN_ERROR_NOT_SUPPORTED The system doesn't support event blocking feature.
*/
/**
* @brief This is a constructor for initializing this view resources.
*
- * @param name view name.
+ * @param[in] name view name.
*
* @warning if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_view_get_by_name()
*/
/**
* @brief The H/W menu key event occurs on view.
*
- * @param menu menu instance, This is made by key listener when menu key occured.
+ * @param[in] menu menu instance, This is made by key listener when menu key occured.
*/
virtual void onMenu(UiMenu *menu);
*
* @note This state will be called when view rotation changed.
*
- * @param degree Current view's degree.
+ * @param[in] degree Current view's degree.
*
* @see onPortrait()
* @see onLandscpae()
/**
* @brief Push given popup instance in the internal popup stack.
*
- * @param popup UiPopup instance
+ * @param[in] popup UiPopup instance
*/
void _connectPopup(UiPopup *popup);
/**
* @brief pop given popup instance in the internal popup stack.
*
- * @param popup UiPopup instance
+ * @param[in] popup UiPopup instance
*/
void _disconnectPopup(UiPopup *popup);
/**
* @brief This is a constructor for initializing viewmgr.
*
- * @param pkg The name of package.
+ * @param[in] pkg The name of package.
*/
explicit UiViewmgr(const char *pkg);
/**
* @brief This is a constructor for initializing UiIfaceApp.
*
- * @param pkg The name of package.
- * @param loale_dir The path of locale directory.
- * @param viewmgr instance of ui_viewmgr.
+ * @param[in] pkg The name of package.
+ * @param[in] loale_dir The path of locale directory.
+ * @param[in] viewmgr instance of ui_viewmgr.
*/
UiIfaceApp(const char *pkg, const char *locale_dir, UiIfaceViewmgr *viewmgr);
* APP_EVENT_DEVICE_ORIENTATION_CHANGED, APP_EVENT_LANGUAGE_CHANGED, APP_EVENT_REGION_FORMAT_CHANGED.
* Application can add those events using wrapping functions by viewmgr supported.
*
+ * @param[in] argc process argument count
+ * @param[in] argv process argument list
+ *
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
* @retval #TIZEN_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Calling when gets a launch request event.
*
- * @param app_control_h The instance of app_control_h.
+ * @param[in] app_control_h The instance of app_control_h.
*/
virtual void onControl(app_control_h app_control);
/**
* @brief Calling when device low battery.
*
- * @param app_event_info_h The instance of app_event_info_h.
+ * @param[in] app_event_info_h The instance of app_event_info_h.
*/
virtual void onLowBattery(app_event_info_h event_info);
/**
* @brief Calling when device low memory.
*
- * @param app_event_info_h The instance of app_event_info_h.
+ * @param[in] app_event_info_h The instance of app_event_info_h.
*/
virtual void onLowMemory(app_event_info_h event_info);
/**
* @brief Calling when device region changed.
*
- * @param app_event_info_h The instance of app_event_info_h.
+ * @param[in] app_event_info_h The instance of app_event_info_h.
*/
virtual void onRegionChanged(app_event_info_h event_info);
/**
* @brief Calling when device orient changed.
*
- * @param app_event_info_h The instance of app_event_info_h.
+ * @param[in] app_event_info_h The instance of app_event_info_h.
*/
virtual void onOrientChanged(app_event_info_h event_info);
/**
* @brief Calling when language changed.
*
- * @param app_event_info_h The instance of app_event_info_h.
+ * @param[in] app_event_info_h The instance of app_event_info_h.
*/
virtual void onLangChanged(app_event_info_h event_info);
* @note @a content is a logical object that represents a view in your framework. The actual type of the content could be translated to any certain types.
* For instance, the type could be Eo * in EFL and Layer * in Dali.
*
- * @param content a new content. It allows @c nullptr for canceling the previous content.
+ * @param[in] content a new content. It allows @c nullptr for canceling the previous content.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief This is a constructor for initializing overlay.
*
- * @param view The instance of UiIfaceView.
+ * @param[in] view The instance of UiIfaceView.
*/
explicit UiIfaceOverlay(UiIfaceView *view);
*
* @note This state will be called when view rotation changed.
*
- * @param degree Current view's degree.
+ * @param[in] degree Current view's degree.
*
* @see on_portrait()
* @see on_landscpae()
/**
* @brief This is a constructor for initializing this view resources.
*
- * @param name view name.
+ * @param[in] name view name.
*
* @warning if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_view_get_by_name()
*/
* The actual behaviors with this transition style is up to your frameworks. Default value of the style is nullptr.
* and "none" represents none transition. If you don't like give any transition effects to this view, you can pass "none" as @a style.
*
- * @param style a transition style name. A default value is "default"
+ * @param[in] style a transition style name. A default value is "default"
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Set content removable.
*
- * @param removable if @a removable is @c true, content of this view will be removed on unload state. @c false otherwise.
+ * @param[in] removable if @a removable is @c true, content of this view will be removed on unload state. @c false otherwise.
*
* @warning You should not remove a view content manually on unload status if removable content is set.
*/
/**
* @brief Set the indicator mode of the view.
*
- * @param indicator The mode to set, one of #UiViewIndicator.
+ * @param[in] indicator The mode to set, one of #UiViewIndicator.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
* @note Set an array of rotation values.
* For instance, {0, 90, 180, 270}. These rotation values depends on the system support.
*
- * @param rotations The array of rotation values.
- * @param count The number of arrays of rotations.
+ * @param[in] rotations The array of rotation values.
+ * @param[in] count The number of arrays of rotations.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Get the array of view's available rotations.
*
- * @param count The number of arrays of rotations.
+ * @param[out] count The number of arrays of rotations.
*
* @return The array of rotation values.
*
* @note @a content is a logical object that represents a view in your framework. The actual type of the content could be translated to any certain types.
* For instance, the type could be Eo * in EFL and Layer * in Dali.
*
- * @param content a new content. It allows @c nullptr for canceling the previous content.
+ * @param[in] content a new content. It allows @c nullptr for canceling the previous content.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
* @note This interface is designed for toggling touch event on view transition.
* UiIfaceViewmgr will call this interface for notifying event blocking toggling on transition time.
*
- * @param block @c true, when blocking is enabled, otherwise @c false.
+ * @param[in] block @c true, when blocking is enabled, otherwise @c false.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Region Changed Event
*
+ * @param[in] region region name
+ *
* @note This event function is responsible for refreshing the display into the new time zone.
*/
virtual void onRegionChanged(const char *region);
/**
* @brief Language Changed Event
*
+ * @param[in] language language name
+ *
* @note This event function is responsible for refreshing the display into the new language.
*/
virtual void onLanguageChanged(const char *language);
/**
* @brief Connect with given viewmgr.
*
- * @param viewmgr The instance of viewmgr.
+ * @param[in] viewmgr The instance of viewmgr.
*
* @see _getViewmgr()
*/
* @brief Return a view index(page) number of the given view.
* You could use this function to query the given @a view list order.
*
- * @param view A view to query the index.
+ * @param[in] view A view to query the index.
*
* @return An index of the given @a view on success, otherwise, -1.
*
/**
* @brief This function is designed for finishing process of push transition.
*
- * @param view A view which is finished pushing.
+ * @param[in] view A view which is finished pushing.
*
* @warning This function must be called when push transition is finished.
*/
*
* @note If a new view is pushed.
*
- * @param view A view which is finished popping.
+ * @param[in] view A view which is finished popping.
*
* @warning This function must be called when push transition is finished.
*/
* or use the view transition style function.
* If you want to pop the current view, the please use pop_view().
*
- * @param view A view to insert at the end of viewmgr view list.
+ * @param[in] view A view to insert at the end of viewmgr view list.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is not valid.
/**
* @brief Insert a view in this viewmgr view list. Specifically, insert a given @a view right before of the given view, @before.
*
- * @param view A view to insert in the viewmgr view list.
- * @param before A view that will be just inserted after @a view. If you pass @c nullptr, @a view will be inserted at the front of the view list.
+ * @param[in] view A view to insert in the viewmgr view list.
+ * @param[in] before A view that will be just inserted after @a view. If you pass @c nullptr, @a view will be inserted at the front of the view list.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Insert a view in this viewmgr view list. Specifically, insert a given @a view right after of the given view, @after.
*
- * @param view A view to insert in the viewmgr view list.
- * @param after A view that will be just inserted before the @a view. If you pass @c nullptr, @a view will be inserted at the end of the view list.
+ * @param[in] view A view to insert in the viewmgr view list.
+ * @param[in] after A view that will be just inserted before the @a view. If you pass @c nullptr, @a view will be inserted at the end of the view list.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Remove the given view from this viewmgr view list.
*
- * @param view A view to remove from the viewmgr view list.
+ * @param[in] view A view to remove from the viewmgr view list.
*
* @return @c 0 on success, otherwise a negative error value.
* @retval #TIZEN_ERROR_NONE Successful
/**
* @brief Return a view which is matched with the index @a idx.
*
- * @param idx A index of the view which you are looking for.
+ * @param[in] idx A index of the view which you are looking for.
*
* @return The view which index is matched with @a idx.
* If there were no views with index @a idx, @c nullptr will be returned.
*
* @note Every view have their names as their own identifiers.
*
- * @param name The name of the view which you are looking for.
+ * @param[in] name The name of the view which you are looking for.
*
* @return The view which name is matched with @a name.
* If there were no views name matched, @c nullptr will be returned.
projects / platform / core / uifw / ui-viewmgr.git / commitdiff