From: Myung Jin Kim Date: Thu, 28 Mar 2013 14:37:45 +0000 (+0900) Subject: apply header doxygen update X-Git-Tag: accepted/tizen_2.1/20130425.033138~630 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=16619bb1608318e7263148dccbeaebddb8316fa3;p=framework%2Fosp%2Fuifw.git apply header doxygen update Change-Id: I239f40749832bde310e75cd684d33c96ada3435e --- diff --git a/inc/FUiCtrlButton.h b/inc/FUiCtrlButton.h index 1ec7b85..bade9b6 100644 --- a/inc/FUiCtrlButton.h +++ b/inc/FUiCtrlButton.h @@ -199,7 +199,7 @@ public: * @param[in] rect An instance of the Rectangle class @n * This instance represents the x and y coordinates of the top-left corner @n * of the created window along with its width and height. @n - * @param[in] text The text to be displayed on the button + * @param[in] text The text to display on the button * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_SYSTEM A system error has occurred. @@ -219,7 +219,7 @@ public: * @param[in] rect An instance of the Rectangle class @n * This instance represents the x and y coordinates of the top-left corner @n * of the created window along with its width and height. @n - * @param[in] text The text to be displayed on the button + * @param[in] text The text to display on the button * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_SYSTEM A system error has occurred. @@ -236,7 +236,7 @@ public: * * @since 2.0 * - * @param[in] listener The event listener to be added + * @param[in] listener The event listener to add */ void AddActionEventListener(Tizen::Ui::IActionEventListener& listener); @@ -246,7 +246,7 @@ public: * * @since 2.0 * - * @param[in] listener The event listener to be removed + * @param[in] listener The event listener to remove */ void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener); @@ -331,7 +331,7 @@ public: * * @since 2.0 * - * @param[in] color The text color to be set + * @param[in] color The text color to set */ virtual void SetTextColor(const Tizen::Graphics::Color& color); @@ -350,7 +350,7 @@ public: * * @since 2.0 * - * @param[in] color The color to be set + * @param[in] color The color to set */ void SetPressedTextColor(const Tizen::Graphics::Color& color); @@ -369,7 +369,7 @@ public: * * @since 2.0 * - * @param[in] color The color to be set + * @param[in] color The color to set */ void SetDisabledTextColor(const Tizen::Graphics::Color& color); @@ -387,7 +387,7 @@ public: * * @since 2.0 * - * @param[in] color The color to be set + * @param[in] color The color to set * @remarks While navigating the user interface using the directional keys, the focused UI control is highlighted. */ void SetHighlightedTextColor(const Tizen::Graphics::Color& color); @@ -407,8 +407,8 @@ public: * * @since 2.0 * - * @param[in] position The location of a bitmap where it is to be displayed on the button - * @param[in] bitmap The bitmap of to be set + * @param[in] position The location of a bitmap where it is to display on the button + * @param[in] bitmap The bitmap to set */ void SetNormalBitmap(const Tizen::Graphics::Point& position, const Tizen::Graphics::Bitmap& bitmap); @@ -417,8 +417,8 @@ public: * * @since 2.1 * - * @param[in] position The location of a bitmap where it is to be displayed on the button - * @param[in] bitmap The bitmap of to be set + * @param[in] position The location of a bitmap where it is to display on the button + * @param[in] bitmap The bitmap to set */ void SetNormalBitmap(const Tizen::Graphics::FloatPoint& position, const Tizen::Graphics::Bitmap& bitmap); @@ -447,8 +447,8 @@ public: * * @since 2.0 * - * @param[in] position The location of a bitmap where it is to be displayed on the Button control - * @param[in] bitmap The bitmap to be set + * @param[in] position The location of a bitmap where it is to display on the Button control + * @param[in] bitmap The bitmap to set */ void SetPressedBitmap(const Tizen::Graphics::Point& position, const Tizen::Graphics::Bitmap& bitmap); @@ -457,8 +457,8 @@ public: * * @since 2.1 * - * @param[in] position The location of a bitmap where it is to be displayed on the Button control - * @param[in] bitmap The bitmap to be set + * @param[in] position The location of a bitmap where it is to display on the Button control + * @param[in] bitmap The bitmap to set */ void SetPressedBitmap(const Tizen::Graphics::FloatPoint& position, const Tizen::Graphics::Bitmap& bitmap); diff --git a/inc/FUiCtrlButtonItem.h b/inc/FUiCtrlButtonItem.h index 766c2f5..ff24eaf 100644 --- a/inc/FUiCtrlButtonItem.h +++ b/inc/FUiCtrlButtonItem.h @@ -164,7 +164,7 @@ public: * * @return An error code * @param[in] status The item status - * @param[in] pBitmap The background bitmap image to be set, @n + * @param[in] pBitmap The background bitmap image to set, @n * else @c null if no bitmap image is displayed * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @@ -180,12 +180,12 @@ public: * * @return An error code * @param[in] status The item status - * @param[in] pIcon The icon to be set, @n + * @param[in] pIcon The icon to set, @n * else @c null if no icon is displayed * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. - * @remarks If the style of %ButtonItem is BUTTON_ITEM_STYLE_TEXT, the method returns E_INVALID_OPERATION. @n - * If an icon is not set for a state, the icon for BUTTON_ITEM_STATUS_NORMAL is used. + * @remarks If the style of %ButtonItem is @c BUTTON_ITEM_STYLE_TEXT, the method returns @c E_INVALID_OPERATION. @n + * If an icon is not set for a state, the icon for @c BUTTON_ITEM_STATUS_NORMAL is used. */ result SetIcon(ButtonItemStatus status, const Tizen::Graphics::Bitmap* pIcon); @@ -196,10 +196,10 @@ public: * @since 2.0 * * @return An error code - * @param[in] text The text to be set + * @param[in] text The text to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * The style of %ButtonItem is BUTTON_ITEM_STYLE_ICON. + * The style of %ButtonItem is @c BUTTON_ITEM_STYLE_ICON. * @remarks If the text cannot be displayed in a line, then the text is automatically displayed in two lines and the ellipsis is applied if the text * is longer than two lines. @n * Use @htmlonly '\n' @endhtmlonly to denote the end of the first line. diff --git a/inc/FUiCtrlCheckButton.h b/inc/FUiCtrlCheckButton.h index 0d71a09..0905d93 100644 --- a/inc/FUiCtrlCheckButton.h +++ b/inc/FUiCtrlCheckButton.h @@ -60,13 +60,13 @@ enum CheckButtonStatus enum CheckButtonStyle { CHECK_BUTTON_STYLE_MARK, /**< The mark style for multiple selection */ - CHECK_BUTTON_STYLE_MARK_WITH_DIVIDER, /**< @if OSPDEPREC @deprecated This enumeration field is deprecated because the use of the divider style is no longer recommended @n + CHECK_BUTTON_STYLE_MARK_WITH_DIVIDER, /**< @if OSPDEPREC @deprecated This enum value is deprecated because the use of the divider style is no longer recommended @n Instead of using the divider style, use the detailed button style. @endif */ - CHECK_BUTTON_STYLE_ONOFF, /**< @if OSPDEPREC @deprecated This enumeration field is deprecated because the use of the on-off style is no longer recommended @n + CHECK_BUTTON_STYLE_ONOFF, /**< @if OSPDEPREC @deprecated This enum value is deprecated because the use of the on-off style is no longer recommended @n Instead of using the on-off style, use the on-off sliding style @endif*/ - CHECK_BUTTON_STYLE_ONOFF_WITH_DIVIDER, /**< @if OSPDEPREC @deprecated This enumeration field is deprecated because the use of the on-off style is no longer recommended @endif */ + CHECK_BUTTON_STYLE_ONOFF_WITH_DIVIDER, /**< @if OSPDEPREC @deprecated This enum value is deprecated because the use of the on-off style is no longer recommended @endif */ CHECK_BUTTON_STYLE_RADIO, /**< The radio style for single selection */ - CHECK_BUTTON_STYLE_RADIO_WITH_DIVIDER, /**< @if OSPDEPREC @deprecated This enumeration field is deprecated because the use of the divider style is no longer recommended @n + CHECK_BUTTON_STYLE_RADIO_WITH_DIVIDER, /**< @if OSPDEPREC @deprecated This enum value is deprecated because the use of the divider style is no longer recommended @n Instead of using the divider style, use the detailed button style @endif*/ CHECK_BUTTON_STYLE_ONOFF_SLIDING, /**< The slider style on/off */ CHECK_BUTTON_STYLE_MARK_WITH_DETAILED_BUTTON, /**< The mark style with detail button */ @@ -269,7 +269,7 @@ public: * * @since 2.0 * - * @param[in] listener The event listener to be added + * @param[in] listener The event listener to add */ void AddActionEventListener(Tizen::Ui::IActionEventListener& listener); @@ -279,7 +279,7 @@ public: * * @since 2.0 * - * @param[in] listener The event listener to be removed + * @param[in] listener The event listener to remove */ void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener); @@ -380,7 +380,7 @@ public: * * @since 2.0 * @return An error code - * @param[in] title The title text to be set + * @param[in] title The title text to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ @@ -400,7 +400,7 @@ public: * * @since 2.0 * - * @param[in] color The text color to be set + * @param[in] color The text color to set */ void SetTextColor(const Tizen::Graphics::Color& color); @@ -419,7 +419,7 @@ public: * * @since 2.0 * - * @param[in] color The text color to be set + * @param[in] color The text color to set */ void SetTitleTextColor(const Tizen::Graphics::Color& color); @@ -437,7 +437,7 @@ public: * * @since 2.0 * @return An error code - * @param[in] color The color to be set + * @param[in] color The color to set * @param[in] status The status * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.@n @@ -465,7 +465,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] color The text color to be set + * @param[in] color The text color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ @@ -512,7 +512,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] color The text color to be set + * @param[in] color The text color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ @@ -560,7 +560,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] color The text color to be set + * @param[in] color The text color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ diff --git a/inc/FUiCtrlFooter.h b/inc/FUiCtrlFooter.h index 9738a3b..e623dab 100644 --- a/inc/FUiCtrlFooter.h +++ b/inc/FUiCtrlFooter.h @@ -139,7 +139,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] item The footer item to be added + * @param[in] item The footer item to add * @exception E_SUCCESS The method is successful. * @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit. * @exception E_INVALID_ARG A specified input parameter is invalid. @n @@ -159,7 +159,7 @@ public: * * @return An error code * @param[in] itemIndex The index where the item must be inserted - * @param[in] item The footer item object to be inserted + * @param[in] item The footer item object to insert * @exception E_SUCCESS The method is successful. * @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit. * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure. @n @@ -351,7 +351,7 @@ public: * @return The selected item index,@n * else @c -1 if an error occurs * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Footer control is @c FOOTER_STYLE_BUTTON_TEXT, @n + * @exception E_UNSUPPORTED_OPERATION The operation is not supported when the style of the %Footer control is @c FOOTER_STYLE_BUTTON_TEXT, @n * @c FOOTER_STYLE_BUTTON_ICON or @c FOOTER_STYLE_BUTTON_ICON_TEXT. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -390,7 +390,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] position The position of the button item to be removed + * @param[in] position The position of the button item to remove * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @remarks If no button item is set at the specified position, the method will return @c E_SUCCESS. @@ -430,7 +430,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] itemIndex The index of the item to be removed + * @param[in] itemIndex The index of the item to remove * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure. @n * The index is greater than or equal to the number of elements or less than @c 0. @@ -459,13 +459,13 @@ public: * * @return An error code * @param[in] position The position at which to set the specified button item. - * @param[in] button The button item to be set + * @param[in] button The button item to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. @n * The specified item is not constructed. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.@n * There are more than 2 footer items. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Footer control is @c FOOTER_STYLE_TAB. + * @exception E_UNSUPPORTED_OPERATION The operation is not supported when the style of the %Footer control is @c FOOTER_STYLE_TAB. * @exception E_SYSTEM A system error has occurred. * @remarks If there is an existing button item at the specified position, it is replaced with the new item.@n * However, the contents of the specified item are copied to the %Footer control. @@ -480,7 +480,7 @@ public: * * @return An error code * @param[in] status The status of the button item - * @param[in] color The button item color to be set + * @param[in] color The button item color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @see GetButtonColor() @@ -528,7 +528,7 @@ public: * * @return An error code * @param[in] status The status of the button item - * @param[in] color The button item text color to be set + * @param[in] color The button item text color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @see GetButtonTextColor() @@ -614,7 +614,7 @@ public: * * @return An error code * @param[in] status The item status - * @param[in] color The item color to be set + * @param[in] color The item color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @see GetItemColor() @@ -682,7 +682,7 @@ public: * * @return An error code * @param[in] status The item status - * @param[in] color The item text color to be set + * @param[in] color The item text color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ @@ -695,13 +695,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] itemIndex The index of the item to be selected + * @param[in] itemIndex The index of the item to select * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The specified index is out of the range of the data structure. @n * The specified index is either greater than or equal to the number of items or is less than zero. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n * The item at the specified index is disabled. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Footer control is @c FOOTER_STYLE_BUTTON_TEXT, @n + * @exception E_UNSUPPORTED_OPERATION The operation is not supported if the %Footer control style is @c FOOTER_STYLE_BUTTON_TEXT, @n * @c FOOTER_STYLE_BUTTON_ICON or @c FOOTER_STYLE_BUTTON_ICON_TEXT. * @exception E_SYSTEM A system error has occurred. */ @@ -714,7 +714,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] color The footer color to be set + * @param[in] color The footer color to set * @exception E_SUCCESS The method is successful. */ result SetColor(const Tizen::Graphics::Color& color); @@ -743,9 +743,7 @@ public: * @param[in] enable Set to @c true to enable the edit mode, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Footer control is @n - * @c FOOTER_STYLE_BUTTON_TEXT, @c FOOTER_STYLE_BUTTON_ICON, @c FOOTER_STYLE_BUTTON_ICON_TEXT, @n - * @c FOOTER_STYLE_SEGMENTED_TEXT, @c FOOTER_STYLE_SEGMENTED_ICON or @c FOOTER_STYLE_SEGMENTED_ICON_TEXT. + * @exception E_UNSUPPORTED_OPERATION The operation is supported when the style of the %Footer control style is @c FOOTER_STYLE_TAB. */ result SetTabEditModeEnabled(bool enable); @@ -756,7 +754,7 @@ public: * * @since 2.0 * - * @param[in] listener The event listener to be added + * @param[in] listener The event listener to add * @remarks When the user collapses the tab style %Footer control which is in the expanded mode by pressing the more button, OnActionPerformed() is called for the currently selected tab item. */ void AddActionEventListener(Tizen::Ui::IActionEventListener& listener); @@ -768,7 +766,7 @@ public: * * @since 2.0 * - * @param[in] listener The event listener to be removed + * @param[in] listener The event listener to remove */ void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener); diff --git a/inc/FUiCtrlFooterItem.h b/inc/FUiCtrlFooterItem.h index 2df4503..d37b20f 100644 --- a/inc/FUiCtrlFooterItem.h +++ b/inc/FUiCtrlFooterItem.h @@ -170,7 +170,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] text The text to be set + * @param[in] text The text to set * @exception E_SUCCESS The method is successful. * @remarks If the text cannot be displayed in a line, then the text is automatically displayed in two lines and the ellipsis is applied if the text * is longer than two lines. @n diff --git a/inc/FUiCtrlHeader.h b/inc/FUiCtrlHeader.h index 360d84e..833aec1 100644 --- a/inc/FUiCtrlHeader.h +++ b/inc/FUiCtrlHeader.h @@ -155,7 +155,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] item The HeaderItem object to be added + * @param[in] item The HeaderItem object to add * @exception E_SUCCESS The method is successful. * @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit. * @exception E_INVALID_ARG A specified input parameter is invalid. @n @@ -174,7 +174,7 @@ public: * * @return An error code * @param[in] itemIndex The index where the item should be inserted - * @param[in] item The HeaderItem object to be inserted + * @param[in] item The HeaderItem object to insert * @exception E_SUCCESS The method is successful. * @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit. * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or the index is greater than or equal to the number of elements or less than @c 0. @@ -350,8 +350,8 @@ public: * @return The selected item index, @n * else @c -1 if an error occurs * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Header control is @c HEADER_STYLE_TITLE, @n - * @c HEADER_STYLE_TITLE_BUTTON or @c HEADER_STYLE_BUTTON. + * @exception E_UNSUPPORTED_OPERATION This operation is supported when the style of the %Header control is @c HEADER_STYLE_SEGMENTED, @n + * @c HEADER_STYLE_SEGMENTED_WITH_TITLE, @c HEADER_STYLE_TAB or @c HEADER_STYLE_TAB_WITH_TITLE. * @remarks The specific error code can be accessed using the GetLastResult() method. */ int GetSelectedItemIndex(void) const; @@ -481,7 +481,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] itemIndex The index of the item to be removed + * @param[in] itemIndex The index of the item to remove * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure. @n * The index is greater than or equal to the number of elements or less than @c 0. @@ -524,7 +524,7 @@ public: * * @return An error code * @param[in] position The position at which to set the specified button item - * @param[in] button The button item to be set + * @param[in] button The button item to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. @n * The specified item is not constructed. @@ -542,7 +542,7 @@ public: * * @return An error code * @param[in] status The status of the button item - * @param[in] color The button item color to be set + * @param[in] color The button item color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @see GetButtonColor() @@ -574,7 +574,7 @@ public: * * @return An error code * @param[in] status The status of the button item - * @param[in] color The button item text color to be set + * @param[in] color The button item text color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ @@ -620,7 +620,7 @@ public: * * @return An error code * @param[in] itemIndex The index at which to set the specified item - * @param[in] item The item to be set + * @param[in] item The item to set * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure. @n * The index is greater than or equal to the number of elements or less than @c 0. @@ -642,7 +642,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure. @n * The index is greater than or equal to the number of elements or less than @c 0. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Header control is @c HEADER_STYLE_TITLE. + * @exception E_UNSUPPORTED_OPERATION The operation is not supported when the style of the %Header control is @c HEADER_STYLE_TITLE. * @exception E_SYSTEM A system error has occurred. */ result SetItemBadgeIcon(int itemIndex, const Tizen::Graphics::Bitmap* pBadgeIcon); @@ -660,7 +660,7 @@ public: * @exception E_INVALID_ARG The specified @c number must be in the range defined by @c 0 and @c 99999. * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure. @n * The index is greater than or equal to the number of elements or less than @c 0. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Header control is @c HEADER_STYLE_TITLE. + * @exception E_UNSUPPORTED_OPERATION The operation is not supported when the style of the %Header control is @c HEADER_STYLE_TITLE. * @exception E_SYSTEM A system error has occurred. * @remarks To remove the numbered badge icon from an item, pass @c 0 as the value of @c number. */ @@ -674,7 +674,7 @@ public: * * @return An error code * @param[in] status The item status - * @param[in] color The item color to be set + * @param[in] color The item color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @see GetItemColor() @@ -688,7 +688,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] itemIndex The index of the item to be set + * @param[in] itemIndex The index of the item to set * @param[in] enable Set to @c true to enable the item state, @n * else @c false * @exception E_SUCCESS The method is successful. @@ -708,7 +708,7 @@ public: * * @return An error code * @param[in] status The item status - * @param[in] color The item text color to be set + * @param[in] color The item text color to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ @@ -721,13 +721,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] itemIndex The index of the item to be selected + * @param[in] itemIndex The index of the item to select * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure. @n * The index is greater than or equal to the number of elements or less than @c 0. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n * The item at the specified index is disabled. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Header control is @c HEADER_STYLE_TITLE, @n + * @exception E_UNSUPPORTED_OPERATION The operation is not supported when the %Header control style is @c HEADER_STYLE_TITLE, @n * @c HEADER_STYLE_TITLE_BUTTON or @c HEADER_STYLE_BUTTON. * @exception E_SYSTEM A system error has occurred. */ @@ -752,7 +752,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] style The header style to be set + * @param[in] style The header style to set * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @remarks All items and buttons will be removed if the style is changed. @@ -766,11 +766,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] pIcon The title icon to be set @n + * @param[in] pIcon The title icon to set @n * Set to @c null to remove the title icon. * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Header control is @c HEADER_STYLE_TITLE_BUTTON, @n - * @c HEADER_STYLE_SEGMENTED, @c HEADER_STYLE_TAB or @c HEADER_STYLE_BUTTON. + * @exception E_UNSUPPORTED_OPERATION The operation is supported when the %Header control style is @c HEADER_STYLE_TITLE, @n + * @c HEADER_STYLE_SEGMENTED_WITH_TITLE or @c HEADER_STYLE_TAB_WITH_TITLE. * @exception E_SYSTEM A system error has occurred. */ result SetTitleIcon(const Tizen::Graphics::Bitmap* pIcon); @@ -782,10 +782,10 @@ public: * @since 2.0 * * @return An error code - * @param[in] text The text to be set + * @param[in] text The text to set * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Header control is @c HEADER_STYLE_TITLE_BUTTON, @n - * @c HEADER_STYLE_SEGMENTED, @c HEADER_STYLE_TAB or @c HEADER_STYLE_BUTTON. + * @exception E_UNSUPPORTED_OPERATION The operation is supported when the %Header control style is @c HEADER_STYLE_TITLE, @n + * @c HEADER_STYLE_SEGMENTED_WITH_TITLE or @c HEADER_STYLE_TAB_WITH_TITLE. * @exception E_SYSTEM A system error has occurred. * @remarks If the text cannot be displayed in a line, then the ellipsis is applied at the end. @n * When the title icon is set along with the title text, the title retains the left alignment. @@ -799,10 +799,10 @@ public: * @since 2.0 * * @return An error code - * @param[in] color The title text color to be set + * @param[in] color The title text color to set * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Header control is @c HEADER_STYLE_TITLE_BUTTON, @n - * @c HEADER_STYLE_SEGMENTED, @c HEADER_STYLE_TAB or @c HEADER_STYLE_BUTTON. + * @exception E_UNSUPPORTED_OPERATION The operation is supported when the %Header control style is @c HEADER_STYLE_TITLE, @n + * @c HEADER_STYLE_SEGMENTED_WITH_TITLE or @c HEADER_STYLE_TAB_WITH_TITLE. * @exception E_SYSTEM A system error has occurred. */ result SetTitleTextColor(const Tizen::Graphics::Color& color); @@ -814,7 +814,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] text The text to be set + * @param[in] text The text to set * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_OPERATION The current state of the instance does not support the execution of the specified operation. @n * The style of the %Header control is not @c HEADER_STYLE_TITLE. @@ -831,7 +831,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] color The description text color to be set + * @param[in] color The description text color to set * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_OPERATION The current state of the instance does not support the execution of the specified operation. @n * The style of the %Header control is not @c HEADER_STYLE_TITLE. @@ -864,7 +864,7 @@ public: * * @since 2.0 * - * @param[in] listener The event listener to be added + * @param[in] listener The event listener to add */ void AddActionEventListener(Tizen::Ui::IActionEventListener& listener); @@ -875,7 +875,7 @@ public: * * @since 2.0 * - * @param[in] listener The event listener to be removed + * @param[in] listener The event listener to remove */ void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener); @@ -900,8 +900,8 @@ public: * @param[in] enable Set to @c true to enable the edit mode, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Header control is @c HEADER_STYLE_TITLE, @n - * @c HEADER_STYLE_TITLE_BUTTON, @c HEADER_STYLE_SEGMENTED, @c HEADER_STYLE_SEGMENTED_WITH_TITLE or @c HEADER_STYLE_BUTTON. + * @exception E_UNSUPPORTED_OPERATION The operation is supported when the style of the %Header control style is @c HEADER_STYLE_TAB @n + * or @c HEADER_STYLE_TAB_WITH_TITLE. */ result SetTabEditModeEnabled(bool enable); @@ -915,9 +915,8 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n * There are more than 2 header items. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported when the style of the %Header control is @n - * @c HEADER_STYLE_TITLE, @c HEADER_STYLE_TITLE_BUTTON, @c HEADER_STYLE_SEGMENTED, @n - * @c HEADER_STYLE_SEGMENTED_WITH_TITLE, @c HEADER_STYLE_TAB or @c HEADER_STYLE_TAB_WITH_TITLE. + * @exception E_UNSUPPORTED_OPERATION The operation is supported when the style of the %Header control is @c HEADER_STYLE_BUTTON. @n + * This device does not support the software back button. * @remarks When the back button is pressed, OnFormBackRequested() of IFormBackEventListener is called. @n * If the right button is already set, then the button is replaced with the back button. */ diff --git a/inc/FUiCtrlHeaderItem.h b/inc/FUiCtrlHeaderItem.h index 531c115..2cad651 100644 --- a/inc/FUiCtrlHeaderItem.h +++ b/inc/FUiCtrlHeaderItem.h @@ -140,7 +140,7 @@ public: * @return An error code * @param[in] status The item status * @param[in] pBitmap The background bitmap to set, @n - * else @c null if no bitmap is to be displayed + * else @c null if no bitmap is displayed * @exception E_SUCCESS The method is successful. * @remarks If the size of the bitmap is greater than the size of the item, the bitmap is scaled down. */ @@ -154,8 +154,8 @@ public: * * @return An error code * @param[in] status The status of the header item - * @param[in] pIcon The icon to be set, @n - * else @c null if no icon is to be set + * @param[in] pIcon The icon to set, @n + * else @c null if no icon is set * @exception E_SUCCESS The method is successful. * @remarks If the size of the bitmap is greater than the default size, the bitmap is scaled down. @n * The bitmap specified for the @c HEADER_ITEM_STATUS_NORMAL will be applied for all other statuses unless different bitmaps are explicitly @@ -172,7 +172,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] text The text to be set + * @param[in] text The text to set * @exception E_SUCCESS The method is successful. * @remarks If the text cannot be displayed in a line, then the text is automatically displayed in two lines and the ellipsis is applied if the text * is longer than two lines. @n diff --git a/inc/FUiCtrlLabel.h b/inc/FUiCtrlLabel.h index 6c6f50d..e64c61f 100644 --- a/inc/FUiCtrlLabel.h +++ b/inc/FUiCtrlLabel.h @@ -254,7 +254,7 @@ public: * * @since 2.0 * - * @param[in] color The color to be set + * @param[in] color The color to set */ virtual void SetTextColor(const Tizen::Graphics::Color& color); diff --git a/inc/FUiCtrlRadioGroup.h b/inc/FUiCtrlRadioGroup.h index 5dada93..a19a355 100644 --- a/inc/FUiCtrlRadioGroup.h +++ b/inc/FUiCtrlRadioGroup.h @@ -204,11 +204,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] checkButton The %CheckButton instance to be added + * @param[in] checkButton The %CheckButton instance to add * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_SYSTEM A system error has occurred. - * @remarks Only CheckButtons whose style is CHECK_BUTTON_STYLE_RADIO or CHECK_BUTTON_STYLE_RADIO_WITH_DIVIDER can be added to %RadioGroup. + * @remarks Only CheckButtons whose style is @c CHECK_BUTTON_STYLE_RADIO or @c CHECK_BUTTON_STYLE_RADIO_WITH_DIVIDER can be added to %RadioGroup. */ result Add(const CheckButton& checkButton); @@ -218,12 +218,12 @@ public: * @since 2.1 * * @return An error code - * @param[in] pCheckButton The %CheckButton instance to be added + * @param[in] pCheckButton The %CheckButton instance to add * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @n * The specified @c pCheckButton is @c null. * @exception E_SYSTEM A system error has occurred. - * @remarks Only CheckButtons whose style is CHECK_BUTTON_STYLE_RADIO or CHECK_BUTTON_STYLE_RADIO_WITH_DIVIDER can be added to %RadioGroup. + * @remarks Only CheckButtons whose style is @c CHECK_BUTTON_STYLE_RADIO or @c CHECK_BUTTON_STYLE_RADIO_WITH_DIVIDER can be added to %RadioGroup. */ result Add(CheckButton* pCheckButton); @@ -235,7 +235,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] checkButton The %CheckButton instance to be removed + * @param[in] checkButton The %CheckButton instance to remove * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The object is not found. * @exception E_SYSTEM A system error has occurred. @@ -249,7 +249,7 @@ public: * @since 2.1 * * @return An error code - * @param[in] pCheckButton The %CheckButton instance to be removed + * @param[in] pCheckButton The %CheckButton instance to remove * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The object is not found. * @exception E_SYSTEM A system error has occurred. @@ -274,7 +274,7 @@ public: * @deprecated This API is deprecated. * @since 2.0 * - * @param[in] checkButton The check button to be selected + * @param[in] checkButton The check button to select */ void SetSelectedItem(const CheckButton& checkButton); @@ -283,7 +283,7 @@ public: * * @since 2.1 * - * @param[in] pCheckButton The check button to be selected + * @param[in] pCheckButton The check button to select * @exception E_INVALID_ARG The specified @c pCheckButton is @c null. */ void SetSelectedItem(CheckButton* pCheckButton);