Tizen 2.4 SDK Rev6 Release

[framework/graphics/dali-toolkit.git] / dali-toolkit / public-api / controls / buttons / button.h

diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h
index 64f353c..108684d 100644 (file)
--- a/dali-toolkit/public-api/controls/buttons/button.h
+++ b/dali-toolkit/public-api/controls/buttons/button.h
@@ -76,7 +76,7 @@ class DALI_IMPORT_API Button : public Control
 public:
 
   /**
-   * @brief The start and end property ranges for this control.
+   * @brief The start and end property ranges for this control
    * @since_tizen 2.4
    */
   enum PropertyRange
@@ -86,7 +86,7 @@ public:
   };
 
   /**
-   * @brief An enumeration of properties belonging to the Button class.
+   * @brief An enumeration of properties belonging to the Button class
    * @since_tizen 2.4
    */
   struct Property
@@ -123,13 +123,13 @@ public:
   Button();
 
   /**
-   * @brief Copy constructor.
+   * @brief Copy constructor
    * @since_tizen 2.4
    */
   Button( const Button& button );
 
   /**
-   * @brief Assignment operator.
+   * @brief Assignment operator
    * @since_tizen 2.4
    */
   Button& operator=( const Button& button );
@@ -142,7 +142,7 @@ public:
    *
    * @since_tizen 2.4
    * @param[in] handle Handle to an object
-   * @return handle to a Button or an uninitialized handle
+   * @return A handle to a Button or an uninitialized handle
    */
   static Button DownCast( BaseHandle handle );
 
@@ -160,14 +160,14 @@ public:
    * No signals are emitted when the \e disabled property is set.
    *
    * @since_tizen 2.4
-   * @param[in] disabled property.
+   * @param[in] disabled property
    */
   void SetDisabled( bool disabled );
 
   /**
    * @brief Returns if the button is disabled.
    * @since_tizen 2.4
-   * @return \e true if the button is \e disabled.
+   * @return \e True if the button is \e disabled.
    */
   bool IsDisabled() const;
 
@@ -185,7 +185,7 @@ public:
   /**
    * @brief Returns if the autorepeating property is set.
    * @since_tizen 2.4
-   * @return \e true if the \e autorepeating property is set.
+   * @return \e True if the \e autorepeating property is set.
    */
   bool IsAutoRepeating() const;
 
@@ -203,7 +203,7 @@ public:
   /**
    * @brief Gets the initial autorepeating delay in seconds.
    * @since_tizen 2.4
-   * @return the initial autorepeating delay in seconds.
+   * @return The initial autorepeating delay in seconds
    */
   float GetInitialAutoRepeatingDelay() const;
 
@@ -221,7 +221,7 @@ public:
   /**
    * @brief Gets the next autorepeating delay in seconds.
    * @since_tizen 2.4
-   * @return the next autorepeating delay in seconds.
+   * @return The next autorepeating delay in seconds
    */
   float GetNextAutoRepeatingDelay() const;
 
@@ -231,14 +231,14 @@ public:
    * If the \e togglable property is set to \e true, then the \e autorepeating property is set to false.
    *
    * @since_tizen 2.4
-   * @param[in] togglable property.
+   * @param[in] togglable property
    */
   void SetTogglableButton( bool togglable );
 
   /**
    * @brief Returns if the togglable property is set.
    * @since_tizen 2.4
-   * @return \e true if the \e togglable property is set.
+   * @return \e True if the \e togglable property is set.
    */
   bool IsTogglableButton() const;
 
@@ -250,14 +250,14 @@ public:
    * Emits a Button::StateChangedSignal() signal.
    *
    * @since_tizen 2.4
-   * @param[in] selected property.
+   * @param[in] selected property
    */
   void SetSelected( bool selected );
 
   /**
    * @brief Returns if the selected property is set and the button is togglable.
    * @since_tizen 2.4
-   * @return \e true if the button is \e selected.
+   * @return \e True if the button is \e selected.
    */
   bool IsSelected() const;
 
@@ -265,7 +265,7 @@ public:
    * @brief Sets the animation time.
    *
    * @since_tizen 2.4
-   * @param[in] animationTime The animation time in seconds.
+   * @param[in] animationTime The animation time in seconds
    */
   void SetAnimationTime( float animationTime );
 
@@ -273,7 +273,7 @@ public:
    * @brief Retrieves button's animation time.
    *
    * @since_tizen 2.4
-   * @return The animation time in seconds.
+   * @return The animation time in seconds
    */
   float GetAnimationTime() const;
 
@@ -281,7 +281,7 @@ public:
    * @brief Sets the button's label.
    *
    * @since_tizen 2.4
-   * @param[in] label The label text.
+   * @param[in] label The label text
    */
   void SetLabelText( const std::string& label );
 
@@ -289,7 +289,7 @@ public:
    * @brief Gets the label.
    *
    * @since_tizen 2.4
-   * @return The label text.
+   * @return The label text
    */
   std::string GetLabelText() const;
 
@@ -297,7 +297,7 @@ public:
    * @brief Sets the unselected button image.
    *
    * @since_tizen 2.4
-   * @param[in] filename The button image.
+   * @param[in] filename The button image
    */
   void SetUnselectedImage( const std::string& filename );
 
@@ -305,7 +305,7 @@ public:
    * @brief Sets the background image.
    *
    * @since_tizen 2.4
-   * @param[in] filename The background image.
+   * @param[in] filename The background image
    */
   void SetBackgroundImage( const std::string& filename );
 
@@ -313,7 +313,7 @@ public:
    * @brief Sets the selected image.
    *
    * @since_tizen 2.4
-   * @param[in] filename The selected image.
+   * @param[in] filename The selected image
    */
   void SetSelectedImage( const std::string& filename );
 
@@ -321,7 +321,7 @@ public:
    * @brief Sets the selected background image.
    *
    * @since_tizen 2.4
-   * @param[in] filename The selected background image.
+   * @param[in] filename The selected background image
    */
   void SetSelectedBackgroundImage( const std::string& filename );
 
@@ -329,7 +329,7 @@ public:
    * @brief Sets the disabled background image.
    *
    * @since_tizen 2.4
-   * @param[in] filename The disabled background image.
+   * @param[in] filename The disabled background image
    */
   void SetDisabledBackgroundImage( const std::string& filename );
 
@@ -337,7 +337,7 @@ public:
    * @brief Sets the disabled button image.
    *
    * @since_tizen 2.4
-   * @param[in] filename The disabled button image.
+   * @param[in] filename The disabled button image
    */
   void SetDisabledImage( const std::string& filename );
 
@@ -345,7 +345,7 @@ public:
    * @brief Sets the disabled selected button image.
    *
    * @since_tizen 2.4
-   * @param[in] filename The disabled selected button image.
+   * @param[in] filename The disabled selected button image
    */
   void SetDisabledSelectedImage( const std::string& filename );
 
@@ -361,7 +361,7 @@ public:
    * @brief Sets the button image.
    * @since_tizen 2.4
    * @remarks Avoid using this method as it's a legacy code. Instead, use @ref SetUnselectedImage.
-   * @param[in]  image The button image.
+   * @param[in]  image The button image
    */
   void SetButtonImage( Image image );
 
@@ -369,7 +369,7 @@ public:
    * @brief Sets the selected image.
    * @since_tizen 2.4
    * @remarks Avoid using this method as it's a legacy code. Instead, use SetSelectedImage( const std::string& filename ).
-   * @param[in]  image The selected image.
+   * @param[in]  image The selected image
    */
   void SetSelectedImage( Image image );
 
@@ -377,7 +377,7 @@ public:
    * @brief Gets the button image.
    * @since_tizen 2.4
    * @remarks Avoid using this method as it's a legacy code.
-   * @return     An actor with the button image.
+   * @return     An actor with the button image
    */
   Actor GetButtonImage() const;
 
@@ -385,7 +385,7 @@ public:
    * @brief Gets the selected image.
    * @since_tizen 2.4
    * @remarks Avoid using this method as it's a legacy code.
-   * @return     An actor with the selected image.
+   * @return     An actor with the selected image
    */
   Actor GetSelectedImage() const;
 
@@ -405,7 +405,7 @@ public: //Signals
    *   bool YourCallbackName( Button button );
    * @endcode
    * @since_tizen 2.4
-   * @return The signal to connect to.
+   * @return The signal to connect to
    */
   ButtonSignalType& PressedSignal();
 
@@ -417,7 +417,7 @@ public: //Signals
    *   bool YourCallbackName( Button button );
    * @endcode
    * @since_tizen 2.4
-   * @return The signal to connect to.
+   * @return The signal to connect to
    */
   ButtonSignalType& ReleasedSignal();
 
@@ -429,7 +429,7 @@ public: //Signals
    *   bool YourCallbackName( Button button );
    * @endcode
    * @since_tizen 2.4
-   * @return The signal to connect to.
+   * @return The signal to connect to
    */
   ButtonSignalType& ClickedSignal();
 
@@ -443,7 +443,7 @@ public: //Signals
    *   bool YourCallbackName( Button button );
    * @endcode
    * @since_tizen 2.4
-   * @return The signal to connect to.
+   * @return The signal to connect to
    */
   ButtonSignalType& StateChangedSignal();
 
@@ -453,7 +453,7 @@ public: // Not intended for application developers
    * @brief Creates a handle using the Toolkit::Internal implementation.
    *
    * @since_tizen 2.4
-   * @param[in]  implementation  The Control implementation.
+   * @param[in]  implementation  The Control implementation
    */
   DALI_INTERNAL Button( Internal::Button& implementation );
 
@@ -461,7 +461,7 @@ public: // Not intended for application developers
    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
    *
    * @since_tizen 2.4
-   * @param[in]  internal  A pointer to the internal CustomActor.
+   * @param[in]  internal  A pointer to the internal CustomActor
    */
   DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
 };