Updated doxygen comments in scroll-view constraints

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / scrollable / scroll-view / scroll-view-constraints.h

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 ef93f54..2e2c2b2 100644 (file)
--- 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
@@ -1,27 +1,27 @@
 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H__
 #define __DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H__
 
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 // EXTERNAL INCLUDES
+#include <dali/public-api/animation/constraint.h>
 
-// INTERNAL INCLUDES
-
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
 
 struct Vector2;
@@ -31,6 +31,10 @@ class PropertyInput;
 
 namespace Toolkit
 {
+/**
+ * @addtogroup dali_toolkit_controls_scroll_view
+ * @{
+ */
 
 // Constraints ////////////////////////////////////////////////////////////////////////////////////
 
@@ -39,43 +43,26 @@ namespace Toolkit
  */
 
 /**
- * Move Actor constraint.
+ * @brief Moves an Actor in accordance with the scroll position.
  *
- * Moves an Actor in accordance to scroll position.
+ * @SINCE_1_0.0
+ * @param[in] current Current position
+ * @param[in] inputs The position input that Actor will move
  */
-Vector3 MoveActorConstraint(const Vector3&    current,
-                            const PropertyInput& scrollPositionProperty);
+DALI_IMPORT_API void MoveActorConstraint( Vector3& current, const PropertyInputContainer& inputs );
 
 /**
- * Move-Scaled Actor constraint.
+ * @brief Wraps an Actor's position in accordance with the min/max bounds of domain.
  *
- * Moves an Actor in accordance to scroll position (and scroll scale).
+ * @SINCE_1_0.0
+ * @param[in] position Position to be wrapped
+ * @param[in] inputs The input that Actor's position will be wrapped
  */
-Vector3 MoveScaledActorConstraint(const Vector3&    current,
-                                  const PropertyInput& scrollPositionProperty,
-                                  const PropertyInput& scrollScaleProperty);
+DALI_IMPORT_API void WrapActorConstraint( Vector3& position, const PropertyInputContainer& inputs );
 
 /**
- * Scale Actor constraint.
- *
- * Scales an Actor in accordance to scroll scale.
+ * @}
  */
-Vector3 ScaleActorConstraint(const Vector3&    current,
-                             const PropertyInput& scrollScaleProperty);
-
-/**
- * Wrap Actor constraint.
- *
- * Wraps an Actors position in accordance to min/max bounds of domain.
- */
-Vector3 WrapActorConstraint(const Vector3&    current,
-                            const PropertyInput& actorScaleProperty,
-                            const PropertyInput& actorAnchorPointProperty,
-                            const PropertyInput& actorSizeProperty,
-                            const PropertyInput& scrollPositionMin,
-                            const PropertyInput& scrollPositionMax,
-                            const PropertyInput& scrollWrap);
-
 } // namespace Toolkit
 
 } // namespace Dali