From 66a49502d769d129c0db6a2f82293de009621a92 Mon Sep 17 00:00:00 2001 From: "dongsug.song" Date: Tue, 15 Nov 2016 11:33:16 +0900 Subject: [PATCH] Revert "[3.0] Add missed parameter documentation" This reverts commit cf7a28995292a305889ce9253955df5d4c8637fb. Change-Id: Ifa0a80c57e6f4b453204426d32d6d946b971ba87 --- dali-toolkit/public-api/controls/buttons/button.h | 3 --- .../public-api/controls/buttons/check-box-button.h | 3 --- .../public-api/controls/buttons/push-button.h | 3 --- .../public-api/controls/buttons/radio-button.h | 3 --- dali-toolkit/public-api/controls/control-impl.h | 5 +---- dali-toolkit/public-api/controls/control.h | 4 ---- .../controls/flex-container/flex-container.h | 2 -- .../public-api/controls/model3d-view/model3d-view.h | 6 ------ .../public-api/controls/scroll-bar/scroll-bar.h | 3 --- .../scrollable/item-view/default-item-layout.h | 4 ---- .../controls/scrollable/item-view/item-view.h | 7 ------- .../scrollable/scroll-view/scroll-view-constraints.h | 4 ---- dali-toolkit/public-api/controls/slider/slider.h | 3 --- .../public-api/controls/table-view/table-view.h | 12 +----------- .../public-api/controls/video-view/video-view.h | 4 ---- .../public-api/toolkit-property-index-ranges.h | 4 ---- 16 files changed, 2 insertions(+), 68 deletions(-) diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h index 8fd3d6ce47..b6e2eec921 100644 --- a/dali-toolkit/public-api/controls/buttons/button.h +++ b/dali-toolkit/public-api/controls/buttons/button.h @@ -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 ); 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 5e9fdfd6a3..2a93154b28 100644 --- a/dali-toolkit/public-api/controls/buttons/check-box-button.h +++ b/dali-toolkit/public-api/controls/buttons/check-box-button.h @@ -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 ); diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index eb4f1a705b..5d58a774dd 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -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 ); diff --git a/dali-toolkit/public-api/controls/buttons/radio-button.h b/dali-toolkit/public-api/controls/buttons/radio-button.h index 4a360a0272..1266d4a66f 100644 --- a/dali-toolkit/public-api/controls/buttons/radio-button.h +++ b/dali-toolkit/public-api/controls/buttons/radio-button.h @@ -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 ); diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index 7dcd5e31bb..c06235e2d4 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -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 diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h index 9acc84e904..613307a477 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -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 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 a362c7172a..2b96061c51 100644 --- a/dali-toolkit/public-api/controls/flex-container/flex-container.h +++ b/dali-toolkit/public-api/controls/flex-container/flex-container.h @@ -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 ); 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 4d4dc12c22..ccb34daf64 100644 --- a/dali-toolkit/public-api/controls/model3d-view/model3d-view.h +++ b/dali-toolkit/public-api/controls/model3d-view/model3d-view.h @@ -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 ); 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 5623fe009c..8e77b5086c 100755 --- a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h +++ b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h @@ -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 ); 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 f90fd391b5..f5ac44889f 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,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 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 614be7afe7..cdbfa344d4 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,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 ); 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 3116169b39..c5fd689539 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,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 ); diff --git a/dali-toolkit/public-api/controls/slider/slider.h b/dali-toolkit/public-api/controls/slider/slider.h index 3525f871ee..d1fec074bd 100644 --- a/dali-toolkit/public-api/controls/slider/slider.h +++ b/dali-toolkit/public-api/controls/slider/slider.h @@ -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 ); 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 420bd8939f..5f9dd4153f 100644 --- a/dali-toolkit/public-api/controls/table-view/table-view.h +++ b/dali-toolkit/public-api/controls/table-view/table-view.h @@ -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. 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 ad0864d611..ae4c612986 100644 --- a/dali-toolkit/public-api/controls/video-view/video-view.h +++ b/dali-toolkit/public-api/controls/video-view/video-view.h @@ -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 diff --git a/dali-toolkit/public-api/toolkit-property-index-ranges.h b/dali-toolkit/public-api/toolkit-property-index-ranges.h index 30ba4958bd..a73cf06125 100644 --- a/dali-toolkit/public-api/toolkit-property-index-ranges.h +++ b/dali-toolkit/public-api/toolkit-property-index-ranges.h @@ -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 -- 2.34.1