From b591ef50e17d16b10cf49affe0122f4727245c65 Mon Sep 17 00:00:00 2001 From: Yoonsang Lee Date: Fri, 22 Jan 2016 13:43:19 +0900 Subject: [PATCH] Apply the new doxygen tagging rule for @DEPRECATED - Change @deprecrated 1.x.x to @DEPRECATED_1_x.x to follow the new doxygen tagging rule. Change-Id: I2054064fda1d0737560d187a9d2cf8e7c865ab9a --- dali-toolkit/public-api/controls/buttons/button.h | 10 +++--- .../public-api/controls/buttons/push-button.h | 14 ++++---- .../controls/control-depth-index-ranges.h | 8 ++--- dali-toolkit/public-api/controls/control.h | 38 ++++++++++++++++++---- .../public-api/controls/image-view/image-view.h | 33 ++++++++++++++++--- 5 files changed, 75 insertions(+), 28 deletions(-) diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h index daeb403..f486118 100644 --- a/dali-toolkit/public-api/controls/buttons/button.h +++ b/dali-toolkit/public-api/controls/buttons/button.h @@ -357,7 +357,7 @@ public: // Deprecated API /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Sets the label with an actor. * @@ -367,7 +367,7 @@ public: void SetLabel( Actor label ); /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Sets the button image. * @@ -377,7 +377,7 @@ public: void SetButtonImage( Image image ); /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Sets the selected image. * @@ -387,7 +387,7 @@ public: void SetSelectedImage( Image image ); /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Gets the button image. * @@ -397,7 +397,7 @@ public: Actor GetButtonImage() const; /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Gets the selected image. * diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index 0bb6656..b772aa6 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -135,7 +135,7 @@ public: using Button::SetButtonImage; /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Sets the unselected image with an Actor. * @@ -147,7 +147,7 @@ public: using Button::SetBackgroundImage; /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Sets the background image with an Actor. * @@ -159,7 +159,7 @@ public: using Button::SetSelectedImage; /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Sets the selected image with an Actor. * @@ -171,7 +171,7 @@ public: using Button::SetSelectedBackgroundImage; /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Sets the selected background image with an Actor. * @@ -183,7 +183,7 @@ public: using Button::SetDisabledBackgroundImage; /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Sets the disabled background image with an Actor. * @@ -195,7 +195,7 @@ public: using Button::SetDisabledImage; /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Sets the disabled image with an Actor. * @@ -207,7 +207,7 @@ public: using Button::SetDisabledSelectedImage; /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Sets the disabled selected image with an Actor. * diff --git a/dali-toolkit/public-api/controls/control-depth-index-ranges.h b/dali-toolkit/public-api/controls/control-depth-index-ranges.h index 87ab0ca..684d258 100644 --- a/dali-toolkit/public-api/controls/control-depth-index-ranges.h +++ b/dali-toolkit/public-api/controls/control-depth-index-ranges.h @@ -31,16 +31,16 @@ namespace Toolkit */ /** - * @deprecated DALi 1.1.16 + * @DEPRECATED_1_1.16 * * @brief These depth indices should not be used. * @SINCE_1_0.0 */ enum DepthIndexRanges { - BACKGROUND_DEPTH_INDEX = static_cast( -Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ), ///< @deprecated DALi 1.1.16 @SINCE_1_0.0 - CONTENT_DEPTH_INDEX = 0, ///< @deprecated DALi 1.1.16 @SINCE_1_0.0 - DECORATION_DEPTH_INDEX = static_cast( Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ) ///< @deprecated DALi 1.1.16 @SINCE_1_0.0 + BACKGROUND_DEPTH_INDEX = static_cast( -Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ), ///< @DEPRECATED_1_1.16 @SINCE_1_0.0 + CONTENT_DEPTH_INDEX = 0, ///< @DEPRECATED_1_1.16 @SINCE_1_0.0 + DECORATION_DEPTH_INDEX = static_cast( Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ) ///< @DEPRECATED_1_1.16 @SINCE_1_0.0 }; /** diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h index 6a5ba62..3bada38 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -91,11 +91,36 @@ public: { enum { - STYLE_NAME = PROPERTY_START_INDEX, ///< name "styleName", @see SetStyleName, type std::string @SINCE_1_0.0 - BACKGROUND_COLOR, ///< name "background-color", @deprecated DALi 1.1.3 mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4 @SINCE_1_0.0 - BACKGROUND_IMAGE, ///< name "background-image", @deprecated DALi 1.1.3 mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map @SINCE_1_0.0 - KEY_INPUT_FOCUS, ///< name "keyInputFocus", @see SetKeyInputFocus, type bool @SINCE_1_0.0 - BACKGROUND, ///< name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map @SINCE_1_1.3 + /** + * @brief name "styleName", type std::string + * @SINCE_1_0.0 + * @see SetStyleName + */ + STYLE_NAME = PROPERTY_START_INDEX, + /** + * @DEPRECATED_1_1.3 + * @brief name "background-color", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4 + * @SINCE_1_0.0 + * @see SetStyleName + */ + BACKGROUND_COLOR, + /** + * @DEPRECATED_1_1.3 + * @brief name "background-image", mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map + * @SINCE_1_0.0 + */ + BACKGROUND_IMAGE, + /** + * @brief name "keyInputFocus", type bool + * @SINCE_1_0.0 + * @see SetKeyInputFocus + */ + KEY_INPUT_FOCUS, + /** + * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map + * @SINCE_1_1.3 + */ + BACKGROUND, }; }; @@ -271,7 +296,6 @@ public: /** * @brief Retrieves the name of the style to be applied to the control (if any). - * * @SINCE_1_0.0 * @return A string matching a style or an empty string. */ @@ -292,7 +316,7 @@ public: void SetBackgroundColor( const Vector4& color ); /** - * @deprecated DALi 1.1.3 API removed. + * @DEPRECATED_1_1.3 * * @brief Retrieves the background color of the control. * diff --git a/dali-toolkit/public-api/controls/image-view/image-view.h b/dali-toolkit/public-api/controls/image-view/image-view.h index cd98841..877ceef 100644 --- a/dali-toolkit/public-api/controls/image-view/image-view.h +++ b/dali-toolkit/public-api/controls/image-view/image-view.h @@ -69,12 +69,34 @@ public: enum { // Event side properties - RESOURCE_URL = PROPERTY_START_INDEX, ///< name "resourceUrl", @deprecated DALi 1.1.16 Use IMAGE instead. type string @SINCE_1_0.0 - IMAGE, ///< name "image", @see SetImage(), type string if it is a url, map otherwise @SINCE_1_0.0 - PRE_MULTIPLIED_ALPHA, ///< name "preMultipliedAlpha", type Boolean @pre image must be initialized. @SINCE_1_1.18 + + /** + * @DEPRECATED_1_1.16. Use IMAGE instead. + * @brief name "resourceUrl", type string + * @SINCE_1_0.0 + */ + RESOURCE_URL = PROPERTY_START_INDEX, + /** + * @brief name "image", type string if it is a url, map otherwise + * @SINCE_1_0.0 + */ + IMAGE, + /** + * @brief name "preMultipliedAlpha", type Boolean + * @SINCE_1_1.18 + * @pre image must be initialized. + */ + PRE_MULTIPLIED_ALPHA, // Animatable properties - PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX, ///< name "pixelArea", type Vector4, Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0]. @SINCE_1_1.18 + + + /** + * @brief name "pixelArea", type Vector4 + * @details Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0]. + * @SINCE_1_0.18 + */ + PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX, }; }; @@ -202,7 +224,8 @@ public: void SetImage( const std::string& url, ImageDimensions size ); /** - * @deprecated Gets the Image + * @DEPRECATED_1_1.4 + * @brief Gets the Image * * @SINCE_1_0.0 * @return The Image currently set to this ImageView -- 2.7.4