From f54caf0701f2812a55aa573530f2861ea057e8d6 Mon Sep 17 00:00:00 2001 From: Adeel Kazmi Date: Mon, 21 Sep 2015 11:39:31 +0100 Subject: [PATCH 1/1] Added version when deprecated to the documentation for Button/PushButton Change-Id: Id74b2aee630822444e7a232a81b718dec4e5e8cd --- dali-toolkit/public-api/controls/buttons/button.h | 25 ++++++++++++---- .../public-api/controls/buttons/push-button.h | 35 +++++++++++++++++----- 2 files changed, 48 insertions(+), 12 deletions(-) diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h index f5c2701..34ea28f 100644 --- a/dali-toolkit/public-api/controls/buttons/button.h +++ b/dali-toolkit/public-api/controls/buttons/button.h @@ -326,31 +326,46 @@ public: // Deprecated API /** - * @deprecated Sets the label with an actor. + * @brief Sets the label with an actor. + * + * @deprecated DALi 1.0.50 + * * @param[in] label The actor to use as a label */ void SetLabel( Actor label ); /** - * @deprecated Sets the button image. + * @brief Sets the button image. + * + * @deprecated DALi 1.0.50 + * * @param[in] image The button image. */ void SetButtonImage( Image image ); /** - * @deprecated Sets the selected image. + * @brief Sets the selected image. + * + * @deprecated DALi 1.0.50 + * * @param[in] image The selected image. */ void SetSelectedImage( Image image ); /** - * @deprecated Gets the button image. + * @brief Gets the button image. + * + * @deprecated DALi 1.0.50 + * * @return An actor with the button image. */ Actor GetButtonImage() const; /** - * @deprecated Gets the selected image. + * @brief Gets the selected image. + * + * @deprecated DALi 1.0.50 + * * @return An actor with the selected image. */ Actor GetSelectedImage() const; diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index 8ebbf58..313d7d0 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -126,7 +126,10 @@ public: using Button::SetButtonImage; /** - * @deprecated Sets the unselected image with an Actor. + * @brief Sets the unselected image with an Actor. + * + * @deprecated DALi 1.0.50 + * * @param[in] image The Actor to use. */ void SetButtonImage( Actor image ); @@ -134,7 +137,10 @@ public: using Button::SetBackgroundImage; /** - * @deprecated Sets the background image with an Actor. + * @brief Sets the background image with an Actor. + * + * @deprecated DALi 1.0.50 + * * @param[in] image The Actor to use. */ void SetBackgroundImage( Actor image ); @@ -142,7 +148,10 @@ public: using Button::SetSelectedImage; /** - * @deprecated Sets the selected image with an Actor. + * @brief Sets the selected image with an Actor. + * + * @deprecated DALi 1.0.50 + * * @param[in] image The Actor to use. */ void SetSelectedImage( Actor image ); @@ -150,7 +159,10 @@ public: using Button::SetSelectedBackgroundImage; /** - * @deprecated Sets the selected background image with an Actor. + * @brief Sets the selected background image with an Actor. + * + * @deprecated DALi 1.0.50 + * * @param[in] image The Actor to use. */ void SetSelectedBackgroundImage( Actor image ); @@ -158,7 +170,10 @@ public: using Button::SetDisabledBackgroundImage; /** - * @deprecated Sets the disabled background image with an Actor. + * @brief Sets the disabled background image with an Actor. + * + * @deprecated DALi 1.0.50 + * * @param[in] image The Actor to use. */ void SetDisabledBackgroundImage( Actor image ); @@ -166,7 +181,10 @@ public: using Button::SetDisabledImage; /** - * @deprecated Sets the disabled image with an Actor. + * @brief Sets the disabled image with an Actor. + * + * @deprecated DALi 1.0.50 + * * @param[in] image The Actor to use. */ void SetDisabledImage( Actor image ); @@ -174,7 +192,10 @@ public: using Button::SetDisabledSelectedImage; /** - * @deprecated Sets the disabled selected image with an Actor. + * @brief Sets the disabled selected image with an Actor. + * + * @deprecated DALi 1.0.50 + * * @param[in] image The Actor to use. */ void SetDisabledSelectedImage( Actor image ); -- 2.7.4