From: Seoyeon Kim <seoyeon2.kim@samsung.com>
Date: Fri, 23 Sep 2016 05:10:29 +0000 (+0900)
Subject: Add missed parameter documentation
X-Git-Tag: dali_1.2.10~16^2
X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=c4699b9f5bd574bf545151f88ea05693467fb5dd

Add missed parameter documentation

- Parameters of some members are not documented.
- Enumeration of some classes are not documented.
- Return types of some members are not documented.

Change-Id: I09781311d2ef8aa33e62dfb7ddbbfc1f2371e924
Signed-off-by: Seoyeon Kim <seoyeon2.kim@samsung.com>
---

diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h
index cd142c5..0ffad99 100644
--- a/dali-toolkit/public-api/controls/buttons/button.h
+++ b/dali-toolkit/public-api/controls/buttons/button.h
@@ -136,12 +136,15 @@ public:
   /**
    * @brief Copy constructor.
    * @SINCE_1_0.0
+   * @param[in] button Handle to an object
    */
   Button( const Button& button );
 
   /**
    * @brief Assignment operator.
    * @SINCE_1_0.0
+   * @param[in] button Handle to an object
+   * @return A reference to this
    */
   Button& operator=( const Button& button );
 
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 ca5c288..105f784 100644
--- a/dali-toolkit/public-api/controls/buttons/check-box-button.h
+++ b/dali-toolkit/public-api/controls/buttons/check-box-button.h
@@ -92,12 +92,15 @@ public:
   /**
    * @brief Copy constructor.
    * @SINCE_1_0.0
+   * @param[in] checkBox Handle to an object
    */
   CheckBoxButton( const CheckBoxButton& checkBox );
 
   /**
    * @brief Assignment operator.
    * @SINCE_1_0.0
+   * @param[in] checkBox Handle to an object
+   * @return A reference to this
    */
   CheckBoxButton& operator=( const CheckBoxButton& checkBox );
 
diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h
index 603601d..8720e5c 100644
--- a/dali-toolkit/public-api/controls/buttons/push-button.h
+++ b/dali-toolkit/public-api/controls/buttons/push-button.h
@@ -128,12 +128,15 @@ public:
   /**
    * @brief Copy constructor.
    * @SINCE_1_0.0
+   * @param[in] pushButton Handle to an object
    */
   PushButton( const PushButton& pushButton );
 
   /**
    * @brief Assignment operator.
    * @SINCE_1_0.0
+   * @param[in] pushButton Handle to an object
+   * @return A reference to this
    */
   PushButton& operator=( const PushButton& pushButton );
 
diff --git a/dali-toolkit/public-api/controls/buttons/radio-button.h b/dali-toolkit/public-api/controls/buttons/radio-button.h
index 3dcd111..0bc276e 100644
--- a/dali-toolkit/public-api/controls/buttons/radio-button.h
+++ b/dali-toolkit/public-api/controls/buttons/radio-button.h
@@ -98,12 +98,15 @@ class DALI_IMPORT_API RadioButton: public Button
   /**
    * @brief Copy constructor.
    * @SINCE_1_0.0
+   * @param[in] radioButton Handle to an object
    */
   RadioButton( const RadioButton& radioButton );
 
   /**
    * @brief Assignment operator.
    * @SINCE_1_0.0
+   * @param[in] radioButton Handle to an object
+   * @return A reference to this
    */
   RadioButton& operator=( const RadioButton& radioButton );
 
diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h
index 97ed7d1..18346c4 100644
--- a/dali-toolkit/public-api/controls/control-impl.h
+++ b/dali-toolkit/public-api/controls/control-impl.h
@@ -456,7 +456,10 @@ protected: // Helpers for deriving classes
 
   // Construction
 
-  // Flags for the constructor
+  /**
+   * @brief Flags for the constructor
+   * @SINCE_1_0.0
+   */
   enum ControlBehaviour
   {
     REQUIRES_STYLE_CHANGE_SIGNALS        = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ),     ///< True if needs to monitor style change signals such as theme/font change @SINCE_1_0.0
diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h
index cdeee6b..d35402f 100644
--- a/dali-toolkit/public-api/controls/control.h
+++ b/dali-toolkit/public-api/controls/control.h
@@ -130,6 +130,10 @@ public:
    */
   struct KeyboardFocus
   {
+    /**
+     * @brief Keyboard focus direction
+     * @SINCE_1_0.0
+     */
     enum Direction
     {
       LEFT,   ///< Move keyboard focus towards the left direction @SINCE_1_0.0
diff --git a/dali-toolkit/public-api/controls/flex-container/flex-container.h b/dali-toolkit/public-api/controls/flex-container/flex-container.h
index d3cd972..375b2ce 100644
--- a/dali-toolkit/public-api/controls/flex-container/flex-container.h
+++ b/dali-toolkit/public-api/controls/flex-container/flex-container.h
@@ -235,6 +235,8 @@ public:
   /**
    * @brief Assignment operator. Changes this handle to point to another real object
    * @SINCE_1_1.35
+   * @param[in] handle Handle to an object
+   * @return A reference to this
    */
   FlexContainer& operator=( const FlexContainer& handle );
 
diff --git a/dali-toolkit/public-api/controls/model3d-view/model3d-view.h b/dali-toolkit/public-api/controls/model3d-view/model3d-view.h
index 97932f9..3aa186d 100644
--- a/dali-toolkit/public-api/controls/model3d-view/model3d-view.h
+++ b/dali-toolkit/public-api/controls/model3d-view/model3d-view.h
@@ -95,6 +95,9 @@ public:
    * @brief Create a new instance of a Model3dView control.
    *
    * @SINCE_1_1.4
+   * @param[in] objUrl The path to the geometry file
+   * @param[in] mtlUrl The path to the material file
+   * @param[in] imagesUrl The path to the images directory
    * @return A handle to the new Model3dView control.
    */
   static Model3dView New( const std::string& objUrl, const std::string& mtlUrl, const std::string& imagesUrl );
@@ -120,12 +123,15 @@ public:
   /**
    * @brief Copy constructor.
    * @SINCE_1_1.4
+   * @param[in] model3dView Handle to an object
    */
   Model3dView( const Model3dView& model3dView );
 
   /**
    * @brief Assignment operator.
    * @SINCE_1_1.4
+   * @param[in] model3dView Handle to an object
+   * @return reference to this
    */
   Model3dView& operator=( const Model3dView& model3dView );
 
diff --git a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h
index 0639dd5..ef50b30 100755
--- a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h
+++ b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h
@@ -167,12 +167,15 @@ public:
   /**
    * @brief Copy constructor.
    * @SINCE_1_0.0
+   * @param[in] scrollBar Handle to an object
    */
   ScrollBar( const ScrollBar& scrollBar );
 
   /**
    * @brief Assignment operator.
    * @SINCE_1_0.0
+   * @param[in] scrollBar Handle to an object
+   * @return A reference to this
    */
   ScrollBar& operator=( const ScrollBar& scrollBar );
 
diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h b/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h
index f5ac448..f90fd39 100644
--- a/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h
+++ b/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h
@@ -38,6 +38,10 @@ namespace Toolkit
 namespace DefaultItemLayout
 {
 
+/**
+ * @brief The type of DefaultItemLayout
+ * @SINCE_1_0.0
+ */
 enum Type
 {
   DEPTH,     ///< Items arranged in a grid, scrolling along the Z-Axis. @SINCE_1_0.0
diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h
index 92fe4bd..ae98934 100644
--- a/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h
+++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h
@@ -68,6 +68,10 @@ class DALI_IMPORT_API ItemView : public Scrollable
 {
 public:
 
+  /**
+   * @brief The start and end property ranges for this control.
+   * @SINCE_1_1.18
+   */
   enum PropertyRange
   {
     PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1,                        ///< @SINCE_1_1.18
@@ -119,12 +123,15 @@ public:
   /**
    * @brief Copy constructor.
    * @SINCE_1_0.0
+   * @param[in] itemView Handle to an object
    */
   ItemView( const ItemView& itemView );
 
   /**
    * @brief Assignment operator.
    * @SINCE_1_0.0
+   * @param[in] itemView Handle to an object
+   * @return A reference to this
    */
   ItemView& operator=( const ItemView& itemView );
 
diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h
index c5fd689..3116169 100644
--- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h
+++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h
@@ -46,6 +46,8 @@ namespace Toolkit
  * @brief Move Actor constraint.
  *
  * Moves an Actor in accordance to scroll position.
+ * @param[in] current Current position
+ * @param[in] inputs The position input that Actor will move
  * @SINCE_1_0.0
  */
 DALI_IMPORT_API void MoveActorConstraint( Vector3& current, const PropertyInputContainer& inputs );
@@ -54,6 +56,8 @@ DALI_IMPORT_API void MoveActorConstraint( Vector3& current, const PropertyInputC
  * @brief Wrap Actor constraint.
  *
  * Wraps an Actors position in accordance to min/max bounds of domain.
+ * @param[in] position Position to be wrapped
+ * @param[in] inputs The input that Actor's position will be wrapped
  * @SINCE_1_0.0
  */
 DALI_IMPORT_API void WrapActorConstraint( Vector3& position, const PropertyInputContainer& inputs );
diff --git a/dali-toolkit/public-api/controls/slider/slider.h b/dali-toolkit/public-api/controls/slider/slider.h
index d1cffec..2b35742 100644
--- a/dali-toolkit/public-api/controls/slider/slider.h
+++ b/dali-toolkit/public-api/controls/slider/slider.h
@@ -184,6 +184,7 @@ public:
    *
    * Creates another handle that points to the same real object.
    * @SINCE_1_1.39
+   * @param[in] handle Handle to an object
    */
   Slider( const Slider& handle );
 
@@ -192,6 +193,8 @@ public:
    *
    * Changes this handle to point to another real object.
    * @SINCE_1_1.39
+   * @param[in] handle Handle to an object
+   * @return A reference to this
    */
   Slider& operator=( const Slider& handle );
 
diff --git a/dali-toolkit/public-api/controls/table-view/table-view.h b/dali-toolkit/public-api/controls/table-view/table-view.h
index b043d40..8af9427 100644
--- a/dali-toolkit/public-api/controls/table-view/table-view.h
+++ b/dali-toolkit/public-api/controls/table-view/table-view.h
@@ -175,6 +175,10 @@ public:
     /**
      * @brief Constructor to initialise values to defaults for convenience
      * @SINCE_1_0.0
+     * @param[in] rowIndex The row index initialized
+     * @param[in] columnIndex The column index initialized
+     * @param[in] rowSpan The row span initialized
+     * @param[in] columnSpan The column span initialized
      */
     CellPosition( unsigned int rowIndex = 0, unsigned int columnIndex = 0,
                     unsigned int rowSpan = 1, unsigned int columnSpan = 1 )
@@ -198,13 +202,15 @@ public:
   /**
    * @brief Copy constructor. Creates another handle that points to the same real object
    * @SINCE_1_0.0
-   * @param handle to copy from
+   * @param[in] handle to copy from
    */
   TableView( const TableView& handle );
 
   /**
    * @brief Assignment operator. Changes this handle to point to another real object
    * @SINCE_1_0.0
+   * @param[in] handle Handle to an object
+   * @return A reference to this
    */
   TableView& operator=( const TableView& handle );
 
@@ -406,6 +412,7 @@ public:
   /**
    * @brief Gets a row's fixed height.
    * @SINCE_1_0.0
+   * @param[in] rowIndex The row index with fixed height
    * @return height in world coordinate units.
    * @pre The row rowIndex must exist.
    * @note The returned value is valid if it has been set before.
@@ -426,6 +433,7 @@ public:
   /**
    * @brief Gets a row's relative height.
    * @SINCE_1_0.0
+   * @param[in] rowIndex The row index with relative height
    * @return height in percentage units, between 0.0f and 1.0f.
    * @pre The row rowIndex must exist.
    * @note The returned value is valid if it has been set before.
@@ -445,6 +453,7 @@ public:
   /**
    * @brief Gets a column's fixed width.
    * @SINCE_1_0.0
+   * @param[in] columnIndex The column index with fixed width
    * @return width in world coordinate units.
    * @pre The column columnIndex must exist.
    * @note The returned value is valid if it has been set before.
@@ -465,6 +474,7 @@ public:
   /**
    * @brief Gets a column's relative width.
    * @SINCE_1_0.0
+   * @param[in] columnIndex The column index with relative width
    * @return width in percentage units, between 0.0f and 1.0f.
    * @pre The column columnIndex must exist.
    * @note The returned value is valid if it has been set before.
diff --git a/dali-toolkit/public-api/controls/video-view/video-view.h b/dali-toolkit/public-api/controls/video-view/video-view.h
index 71b9a45..561ca2c 100644
--- a/dali-toolkit/public-api/controls/video-view/video-view.h
+++ b/dali-toolkit/public-api/controls/video-view/video-view.h
@@ -66,6 +66,10 @@ public:
   // Signal
   typedef Signal< void (VideoView&) > VideoViewSignalType; ///< Video playback finished signal type @ SINCE_1_1.38
 
+  /**
+   * @brief The start and end property ranges for this control.
+   * @SINCE_1_0.0
+   */
   enum PropertyRange
   {
     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,  ///< @SINCE_1_0.0
diff --git a/dali-toolkit/public-api/toolkit-property-index-ranges.h b/dali-toolkit/public-api/toolkit-property-index-ranges.h
index a73cf06..30ba495 100644
--- a/dali-toolkit/public-api/toolkit-property-index-ranges.h
+++ b/dali-toolkit/public-api/toolkit-property-index-ranges.h
@@ -27,6 +27,10 @@ namespace Dali
 namespace Toolkit
 {
 
+/**
+ * @brief The start and end property ranges.
+ * @SINCE_1_1.45
+ */
 enum PropertyRanges
 {
   VISUAL_PROPERTY_BASE_START_INDEX  = CORE_PROPERTY_MAX_INDEX + 1,             ///< Visual Property Base Start Index. @SINCE_1_1.45