Apply the new doxygen tagging rule for @SINCE

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / buttons / check-box-button.h

diff --git a/dali-toolkit/public-api/controls/buttons/check-box-button.h b/dali-toolkit/public-api/controls/buttons/check-box-button.h
index 9752213..735bcfc 100644 (file)
--- a/dali-toolkit/public-api/controls/buttons/check-box-button.h
+++ b/dali-toolkit/public-api/controls/buttons/check-box-button.h
@@ -33,9 +33,13 @@ namespace Internal DALI_INTERNAL
 {
 class CheckBoxButton;
 }
+/**
+ * @addtogroup dali_toolkit_controls_buttons
+ * @{
+ */
 
 /**
- * CheckBoxButton provides a check box button which user can check or uncheck.
+ * @brief CheckBoxButton provides a check box button which user can check or uncheck.
  *
  * By default a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to selected or unselected.
  *
@@ -49,24 +53,28 @@ class CheckBoxButton;
  *
  * CheckBoxButton doesn't have a text. However, a Dali::Toolkit::TableView with a Dali::TextActor or a Dali::Toolkit::TextView
  * and a CheckBoxButton could be used instead.
+ * @SINCE_1_0.0
  */
 class DALI_IMPORT_API CheckBoxButton : public Button
 {
 public:
 
   /**
-   * Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
+   * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
    * Calling member functions with an uninitialized Dali::Object is not allowed.
+   * @SINCE_1_0.0
    */
   CheckBoxButton();
 
   /**
-   * Copy constructor.
+   * @brief Copy constructor.
+   * @SINCE_1_0.0
    */
   CheckBoxButton( const CheckBoxButton& checkBox );
 
   /**
-   * Assignment operator.
+   * @brief Assignment operator.
+   * @SINCE_1_0.0
    */
   CheckBoxButton& operator=( const CheckBoxButton& checkBox );
 
@@ -74,110 +82,46 @@ public:
    * @brief Destructor
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
   ~CheckBoxButton();
 
   /**
-   * Create an initialized CheckBoxButton.
+   * @brief Create an initialized CheckBoxButton.
+   * @SINCE_1_0.0
    * @return A handle to a newly allocated Dali resource.
    */
   static CheckBoxButton New();
 
   /**
-   * Downcast an Object handle to CheckBoxButton. If handle points to a CheckBoxButton the
+   * @brief Downcast an Object handle to CheckBoxButton. If handle points to a CheckBoxButton the
    * downcast produces valid handle. If not the returned handle is left uninitialized.
+   * @SINCE_1_0.0
    * @param[in] handle Handle to an object
    * @return handle to a CheckBoxButton or an uninitialized handle
    */
   static CheckBoxButton DownCast( BaseHandle handle );
 
-  /**
-   * Sets the background image.
-   *
-   * @param[in] image The background image.
-   */
-  void SetBackgroundImage( Image image );
-
-  /**
-   * @copydoc SetBackgroundImage( Image image )
-   */
-  void SetBackgroundImage( Actor image );
-
-  /**
-   * Gets the background image.
-   * @return An actor with the background image.
-   */
-  Actor GetBackgroundImage() const;
-
-  /**
-   * Sets the selected image.
-   *
-   * @param[in] image The selected image.
-   */
-  void SetSelectedImage( Image image );
-
-  /**
-   * @copydoc SetSelectedImage( Image image )
-   */
-  void SetSelectedImage( Actor image );
-
-  /**
-   * Gets the selected image.
-   * @return An actor with the selected image.
-   */
-  Actor GetSelectedImage() const;
-
-  /**
-   * Sets the disabled background image.
-   *
-   * @param[in] image The disabled background image.
-   */
-  void SetDisabledBackgroundImage( Image image );
-
-  /**
-   * @copydoc SetDisabledBackgroundImage( Image image )
-   */
-  void SetDisabledBackgroundImage( Actor image );
-
-  /**
-   * Gets the disabled background image.
-   * @return An actor with the disabled background image.
-   */
-  Actor GetDisabledBackgroundImage() const;
-
-  /**
-   * Sets the disabled selected image.
-   *
-   * @param[in] image The disabled selected image.
-   */
-  void SetDisabledSelectedImage( Image image );
-
-  /**
-   * @copydoc SetDisabledSelectedImage( Image image )
-   */
-  void SetDisabledSelectedImage( Actor image );
-
-  /**
-   * Gets the disabled selected image.
-   * @return An actor with the disabled selected image.
-   */
-  Actor GetDisabledSelectedImage() const;
-
 public: // Not intended for application developers
 
   /**
-   * Creates a handle using the Toolkit::Internal implementation.
+   * @brief Creates a handle using the Toolkit::Internal implementation.
+   * @SINCE_1_0.0
    * @param[in]  implementation  The Control implementation.
    */
   DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation );
 
   /**
-   * Allows the creation of this Control from an Internal::CustomActor pointer.
+   * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
+   * @SINCE_1_0.0
    * @param[in]  internal  A pointer to the internal CustomActor.
    */
   DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
 };
 
+/**
+ * @}
+ */
 } // namespace Toolkit
 
 } // namespace Dali