Revert "[3.0] Add missed parameter documentation" 26/97726/1
authordongsug.song <dongsug.song@samsung.com>
Tue, 15 Nov 2016 02:33:16 +0000 (11:33 +0900)
committerdongsug.song <dongsug.song@samsung.com>
Tue, 15 Nov 2016 02:33:20 +0000 (11:33 +0900)
This reverts commit cf7a28995292a305889ce9253955df5d4c8637fb.

Change-Id: Ifa0a80c57e6f4b453204426d32d6d946b971ba87

16 files changed:
dali-toolkit/public-api/controls/buttons/button.h
dali-toolkit/public-api/controls/buttons/check-box-button.h
dali-toolkit/public-api/controls/buttons/push-button.h
dali-toolkit/public-api/controls/buttons/radio-button.h
dali-toolkit/public-api/controls/control-impl.h
dali-toolkit/public-api/controls/control.h
dali-toolkit/public-api/controls/flex-container/flex-container.h
dali-toolkit/public-api/controls/model3d-view/model3d-view.h
dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h
dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h
dali-toolkit/public-api/controls/scrollable/item-view/item-view.h
dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h
dali-toolkit/public-api/controls/slider/slider.h
dali-toolkit/public-api/controls/table-view/table-view.h
dali-toolkit/public-api/controls/video-view/video-view.h
dali-toolkit/public-api/toolkit-property-index-ranges.h

index 8fd3d6c..b6e2eec 100644 (file)
@@ -136,15 +136,12 @@ 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 );
 
index 5e9fdfd..2a93154 100644 (file)
@@ -92,15 +92,12 @@ 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 );
 
index eb4f1a7..5d58a77 100644 (file)
@@ -128,15 +128,12 @@ 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 );
 
index 4a360a0..1266d4a 100644 (file)
@@ -98,15 +98,12 @@ 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 );
 
index 7dcd5e3..c06235e 100644 (file)
@@ -407,10 +407,7 @@ protected: // Helpers for deriving classes
 
   // Construction
 
-  /**
-   * @brief Flags for the constructor
-   * @SINCE_1_0.0
-   */
+  // Flags for the constructor
   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
index 9acc84e..613307a 100644 (file)
@@ -130,10 +130,6 @@ 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
index a362c71..2b96061 100644 (file)
@@ -235,8 +235,6 @@ 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 );
 
index 4d4dc12..ccb34da 100644 (file)
@@ -95,9 +95,6 @@ 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 );
@@ -123,15 +120,12 @@ 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 );
 
index 5623fe0..8e77b50 100755 (executable)
@@ -167,15 +167,12 @@ 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 );
 
index f90fd39..f5ac448 100644 (file)
@@ -38,10 +38,6 @@ 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
index 614be7a..cdbfa34 100644 (file)
@@ -68,10 +68,6 @@ 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
@@ -123,15 +119,12 @@ 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 );
 
index 3116169..c5fd689 100644 (file)
@@ -46,8 +46,6 @@ 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 );
@@ -56,8 +54,6 @@ 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 );
index 3525f87..d1fec07 100644 (file)
@@ -184,7 +184,6 @@ 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 );
 
@@ -193,8 +192,6 @@ 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 );
 
index 420bd89..5f9dd41 100644 (file)
@@ -175,10 +175,6 @@ 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 )
@@ -202,15 +198,13 @@ public:
   /**
    * @brief Copy constructor. Creates another handle that points to the same real object
    * @SINCE_1_0.0
-   * @param[in] handle to copy from
+   * @param 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 );
 
@@ -412,7 +406,6 @@ 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.
@@ -433,7 +426,6 @@ 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.
@@ -453,7 +445,6 @@ 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.
@@ -474,7 +465,6 @@ 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.
index ad0864d..ae4c612 100644 (file)
@@ -66,10 +66,6 @@ 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
index 30ba495..a73cf06 100644 (file)
@@ -27,10 +27,6 @@ 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