From 168d06a60c31602ba371286e8e836ade70e15d9b Mon Sep 17 00:00:00 2001 From: Minkyoung Kang Date: Wed, 10 Apr 2013 13:24:26 +0900 Subject: [PATCH] remove Doxygen warning Change-Id: I6e5a2eb6c82ab19b23eeedcdc83ede7d81e01f74 --- inc/FGrpCanvasCommon.h | 2 +- inc/FGrpGlPlayer.h | 6 +- inc/FUiCompositeMode.h | 15 ++--- inc/FUiContainer.h | 3 +- inc/FUiControl.h | 4 +- inc/FUiControls.h | 132 ++++---------------------------------- inc/FUiCtrlCustomList.h | 2 +- inc/FUiCtrlCustomListItemFormat.h | 4 +- inc/FUiCtrlExpandableList.h | 1 + inc/FUiCtrlGroupContainer.h | 2 +- inc/FUiCtrlGroupedTableView.h | 2 +- inc/FUiCtrlIconListTypes.h | 2 +- inc/FUiCtrlListContextItem.h | 4 +- inc/FUiCtrlListTypes.h | 2 +- inc/FUiCtrlProgress.h | 2 +- inc/FUiCtrlProgressPopup.h | 2 +- inc/FUiCtrlSectionTableView.h | 2 +- inc/FUiCtrlSlider.h | 2 +- inc/FUiCtrlTableView.h | 2 +- 19 files changed, 38 insertions(+), 153 deletions(-) diff --git a/inc/FGrpCanvasCommon.h b/inc/FGrpCanvasCommon.h index 9709878..8e2d08c 100644 --- a/inc/FGrpCanvasCommon.h +++ b/inc/FGrpCanvasCommon.h @@ -89,7 +89,7 @@ enum LineCapStyle }; /** - * @enum LineJoin + * @enum LineJoinStyle * * Defines the line join style. * diff --git a/inc/FGrpGlPlayer.h b/inc/FGrpGlPlayer.h index 59d6456..9c7f9d4 100644 --- a/inc/FGrpGlPlayer.h +++ b/inc/FGrpGlPlayer.h @@ -102,7 +102,7 @@ public: * @since 2.0 * @return An error code * @param[in] version EGL Context Client Version. - * @param[in] control Target control + * @param[in] pControl A pointer of the target control * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_INVALID_OPERATION The operation has failed, because of the duplicate call of Construct(). @@ -198,7 +198,7 @@ public: * * @since 2.0 * @return An error code - * @param[in] eglConfigList A list of EGL attributes and their values + * @param[in] pEglConfigList A list of EGL attributes and their values * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @@ -242,7 +242,7 @@ public: * * @since 2.0 * @return An error code - * @param[in] renderer %IGlRenderer defines how to render the scene. + * @param[in] pRenderer %IGlRenderer defines how to render the scene. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION Fail to perform the IGlRenderer::InitializeGl() method which is implemented by developers. * @see %IGlRenderer diff --git a/inc/FUiCompositeMode.h b/inc/FUiCompositeMode.h index 9a48c10..1893cc3 100644 --- a/inc/FUiCompositeMode.h +++ b/inc/FUiCompositeMode.h @@ -41,17 +41,10 @@ namespace Tizen {namespace Ui */ enum CompositeMode { - /** Composites two UI controls using alpha-blending */ - COMPOSITE_MODE_ALPHA_BLENDING, - - /** Composites two UI controls in a way that the given chroma key color from one control is made transparent */ - COMPOSITE_MODE_CHROMA_KEY, - - /** Composites two UI controls in a way that one control overwrites another control */ - COMPOSITE_MODE_OVERWRITE, - - /** Does not composite the given control */ - COMPOSITE_MODE_NONE, + COMPOSITE_MODE_ALPHA_BLENDING, /**< Composites two UI controls using alpha-blending */ + COMPOSITE_MODE_CHROMA_KEY, /**< Composites two UI controls in a way that the given chroma key color from one control is made transparent */ + COMPOSITE_MODE_OVERWRITE, /**< Composites two UI controls in a way that one control overwrites another control */ + COMPOSITE_MODE_NONE, /**< Does not composite the given control */ }; }} // Tizen::Ui diff --git a/inc/FUiContainer.h b/inc/FUiContainer.h index f0e9f19..cb43d2d 100644 --- a/inc/FUiContainer.h +++ b/inc/FUiContainer.h @@ -110,8 +110,7 @@ public: * @since 2.1 * * @return An error code - * @param[in] control The control to add to the container - * @param[in] pControl Pointer of the control to be added to the container + * @param[in] pControl The pointer of the control to add to the container * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c pControl is null. * The specified @c control is an instance of Window, or this control's parent container. diff --git a/inc/FUiControl.h b/inc/FUiControl.h index b6466a9..9686f37 100644 --- a/inc/FUiControl.h +++ b/inc/FUiControl.h @@ -785,7 +785,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] Position The new position + * @param[in] position The new position * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The control has not been constructed as yet. * @exception E_UNSUPPORTED_OPERATION This control is not movable. @@ -803,7 +803,7 @@ public: * @since 2.1 * * @return An error code - * @param[in] Position The new position + * @param[in] position The new position * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The control has not been constructed as yet. * @exception E_UNSUPPORTED_OPERATION This control is not movable. diff --git a/inc/FUiControls.h b/inc/FUiControls.h index 17f72b6..82a9cd9 100644 --- a/inc/FUiControls.h +++ b/inc/FUiControls.h @@ -182,16 +182,7 @@ namespace Controls * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_TITLE_TEXT; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_TITLE_TEXT; /** * @if OSPDEPREC @@ -204,16 +195,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_TITLE_TEXT; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_BODY_TEXT; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_BODY_TEXT; /** * @if OSPDEPREC @@ -226,16 +208,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_BODY_TEXT; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_FOREGROUND; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_FOREGROUND; /** * @if OSPDEPREC @@ -248,16 +221,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_FOREGROUND; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_BACKGROUND; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_BACKGROUND; /** * @if OSPDEPREC @@ -270,16 +234,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_BACKGROUND; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_BACKGROUND; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_BACKGROUND; /** * @if OSPDEPREC @@ -292,16 +247,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_BACKGROUND; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_FORM_BACKGROUND; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_FORM_BACKGROUND; /** * @if OSPDEPREC @@ -314,16 +260,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_FORM_BACKGROUND; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_FORM_GROUP_BACKGROUND; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_FORM_GROUP_BACKGROUND; /** * @if OSPDEPREC @@ -336,16 +273,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_FORM_GROUP_BACKGROUND; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_POPUP_BACKGROUND; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_POPUP_BACKGROUND; /** * @if OSPDEPREC @@ -358,16 +286,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_POPUP_BACKGROUND; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_GROUP_ITEM_TEXT; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_GROUP_ITEM_TEXT; /** * @if OSPDEPREC @@ -380,16 +299,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_GROUP_ITEM_TEXT; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_TEXT; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_TEXT; /** * @if OSPDEPREC @@ -402,16 +312,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_TEXT; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_PRESSED_TEXT; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_PRESSED_TEXT; /** * @if OSPDEPREC @@ -424,16 +325,7 @@ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_PRESSED_TEXT; * @remarks Different color values can be defined for different device models. * @endif */ -/** - * @htmlonly - * - * @endhtmlonly - */ -extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_HIGHLIGHTED_TEXT; +_OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_HIGHLIGHTED_TEXT; }; // Tizen::Ui::Controls }; // Tizen::Ui diff --git a/inc/FUiCtrlCustomList.h b/inc/FUiCtrlCustomList.h index 97132cf..c6f3841 100644 --- a/inc/FUiCtrlCustomList.h +++ b/inc/FUiCtrlCustomList.h @@ -629,7 +629,7 @@ public: * else @c -1 if no more item after the specified index is checked, @n * or the specified @c index is less than @c 0 or greater than the item count. * @param[in] index The index of the %CustomList control item - * endif + * @endif */ int GetNextCheckedItemIndexAfter(int index) const; diff --git a/inc/FUiCtrlCustomListItemFormat.h b/inc/FUiCtrlCustomListItemFormat.h index 1df299e..0362888 100644 --- a/inc/FUiCtrlCustomListItemFormat.h +++ b/inc/FUiCtrlCustomListItemFormat.h @@ -73,7 +73,7 @@ public: * @brief [Deprecated] * @deprecated This class is deprecated. There is no need to use this class. * @since 2.0 - * + * @endif */ virtual ~CustomListItemFormat(void); @@ -89,7 +89,7 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * + * @endif */ result Construct(void); diff --git a/inc/FUiCtrlExpandableList.h b/inc/FUiCtrlExpandableList.h index 26183ca..31ec111 100644 --- a/inc/FUiCtrlExpandableList.h +++ b/inc/FUiCtrlExpandableList.h @@ -951,6 +951,7 @@ public: int GetNextCheckedItemIndexAfter(int mainIndex) const; /** + * @if OSPDEPREC * Gets the next checked sub-item from the specified index in the main item. * * @brief [Deprecated] diff --git a/inc/FUiCtrlGroupContainer.h b/inc/FUiCtrlGroupContainer.h index 61096db..924fc48 100644 --- a/inc/FUiCtrlGroupContainer.h +++ b/inc/FUiCtrlGroupContainer.h @@ -299,7 +299,7 @@ public: * @param[in] columnIndex The column index of the column in which the control should be resized * @param[in] enable boolean value to enable or disable the resizing of control * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c rowIndex or @ccolumnIndex is greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE The specified @c rowIndex or @c columnIndex is greater than the number of elements or less than @c 0. * */ result SetChildResizingEnabled(int rowIndex, int columnIndex, bool enable); diff --git a/inc/FUiCtrlGroupedTableView.h b/inc/FUiCtrlGroupedTableView.h index 47d485d..ee7ee73 100644 --- a/inc/FUiCtrlGroupedTableView.h +++ b/inc/FUiCtrlGroupedTableView.h @@ -816,7 +816,7 @@ public: * * @since 2.0 * - * @excpetion E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1. * @remarks This method clears all the items in the table view and invokes the methods of the item provider again to update the table view. @n * This method does not work during the ITableViewItemProvider call-back procedure. diff --git a/inc/FUiCtrlIconListTypes.h b/inc/FUiCtrlIconListTypes.h index 4a227d9..7041d36 100644 --- a/inc/FUiCtrlIconListTypes.h +++ b/inc/FUiCtrlIconListTypes.h @@ -48,7 +48,7 @@ enum IconListStyle }; /** - * if OSPDEPREC + * @if OSPDEPREC * @enum IconListCheckBoxPosition * * Defines the check-box position. diff --git a/inc/FUiCtrlListContextItem.h b/inc/FUiCtrlListContextItem.h index ef71479..2079d79 100644 --- a/inc/FUiCtrlListContextItem.h +++ b/inc/FUiCtrlListContextItem.h @@ -173,7 +173,7 @@ public: * @return An error code * @param[in] elementId The ID of the element * @param[in] status The stauts of the context item element - * @param[in] color The background color of the context item element + * @param[in] backgroundColor The background color of the context item element * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified @ elementId is invalid. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @@ -206,7 +206,7 @@ public: * @return An error code * @param[in] elementId The ID of the element * @param[in] status The stauts of the context item element - * @param[in] color The text color of the context item element + * @param[in] textColor The text color of the context item element * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified @ elementId is invalid. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. diff --git a/inc/FUiCtrlListTypes.h b/inc/FUiCtrlListTypes.h index 7408aee..1d591ba 100644 --- a/inc/FUiCtrlListTypes.h +++ b/inc/FUiCtrlListTypes.h @@ -106,7 +106,7 @@ enum ListItemText }; /** - * if OSPDEPREC + * @if OSPDEPREC * @enum FastScrollIndexDigit * * Defines the number of digits or characters of the fast scroll index. diff --git a/inc/FUiCtrlProgress.h b/inc/FUiCtrlProgress.h index 00c0a5a..8a447f0 100644 --- a/inc/FUiCtrlProgress.h +++ b/inc/FUiCtrlProgress.h @@ -292,7 +292,7 @@ public: * * @since 2.1 * - * @param[in] color The color to be set + * @param[in] barBackgroundColor The color to be set * @remarks The method ignores the alpha value of the @c color parameter and sets the alpha value to @c 255. * @see GetBarBackgroundColor() */ diff --git a/inc/FUiCtrlProgressPopup.h b/inc/FUiCtrlProgressPopup.h index 5266c2c..ab0b81a 100644 --- a/inc/FUiCtrlProgressPopup.h +++ b/inc/FUiCtrlProgressPopup.h @@ -190,7 +190,7 @@ public: * @return An error code * @param[in] cancelButton Set to @c true if the %ProgressPopup window has a cancel button, @n * else @c false - * @param[in] translucent Set to @c true if the %ProgressPopup window is translucent, @n + * @param[in] transparent Set to @c true if the %ProgressPopup window is translucent, @n * else @c false * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. @n diff --git a/inc/FUiCtrlSectionTableView.h b/inc/FUiCtrlSectionTableView.h index f528f4b..15ab035 100755 --- a/inc/FUiCtrlSectionTableView.h +++ b/inc/FUiCtrlSectionTableView.h @@ -672,7 +672,7 @@ public: * * @since 2.0 * - * @excpetion E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1. * @remarks This method clears all the items in the table view and invokes the methods of the item provider again to update the table view. @n * This method does not work during the ITableViewItemProvider call-back procedure. diff --git a/inc/FUiCtrlSlider.h b/inc/FUiCtrlSlider.h index e337e29..15e9e54 100644 --- a/inc/FUiCtrlSlider.h +++ b/inc/FUiCtrlSlider.h @@ -410,7 +410,7 @@ public: * * @since 2.1 * - * @param[in] color The color to be set + * @param[in] barBackgroundColor The color to be set * @remarks The method ignores the alpha value of the @c color parameter and sets the alpha value to @c 255. * @see GetBarBackgroundColor() */ diff --git a/inc/FUiCtrlTableView.h b/inc/FUiCtrlTableView.h index 74d1e79..0ee7576 100755 --- a/inc/FUiCtrlTableView.h +++ b/inc/FUiCtrlTableView.h @@ -625,7 +625,7 @@ public: * * @since 2.0 * - * @excpetion E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1. * @remarks This method clears all the items in the table view and invokes the methods of the item provider again to update the table view. @n * This method does not work during the ITableViewItemProvider call-back procedure. -- 2.7.4