Conversion to Apache 2.0 license

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

diff --git a/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h b/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h
index 7c862c9..b254c32 100644 (file)
--- a/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h
+++ b/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h
@@ -1,24 +1,25 @@
 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__
 #define __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_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) 2014 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.
+ *
+ */
 
 /**
- * @addtogroup CAPI_DALI_FRAMEWORK
+ * @addtogroup CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE
  * @{
  */
 
@@ -45,17 +46,18 @@ class ScrollViewWobbleEffect;
 class ScrollView;
 class ScrollViewEffect;
 
-typedef std::vector<ScrollViewEffect> ScrollViewEffectContainer;
-typedef ScrollViewEffectContainer::iterator ScrollViewEffectIter;
-typedef ScrollViewEffectContainer::const_iterator ScrollViewEffectConstIter;
+typedef std::vector<ScrollViewEffect> ScrollViewEffectContainer; ///< Container of Dali::Toolkit::ScrollViewEffect%s
+typedef ScrollViewEffectContainer::iterator ScrollViewEffectIter; ///< Iterator for Dali::Toolkit::ScrollViewEffectContainer
+typedef ScrollViewEffectContainer::const_iterator ScrollViewEffectConstIter; ///< Const Iterator for Dali::Toolkit::ScrollViewEffectContainer
 
 /**
- * ScrollView Effect base class, used to apply custom
- * effects to a ScrollView instance. Such effects are
- * purely logical (i.e. physics), and may produce
- * properties that can be used with visual effects.
- * Such as creating constraints that are applied to ShaderEffects
- * or Actors using these properties as inputs.
+ * @brief ScrollView Effect base class, used to apply custom effects to a
+ * ScrollView instance.
+ *
+ * Such effects are purely logical (i.e. physics), and may produce
+ * properties that can be used with visual effects.  Such as creating
+ * constraints that are applied to ShaderEffects or Actors using these
+ * properties as inputs.
  */
 class ScrollViewEffect : public Dali::BaseHandle
 {
@@ -63,7 +65,8 @@ class ScrollViewEffect : public Dali::BaseHandle
 public:
 
   /**
-   * Create an uninitialized ScrollViewEffect; this can only be initialized with derived classes
+   * @brief Create an uninitialized ScrollViewEffect; this can only be initialized with derived classes.
+   *
    * Calling member functions with an uninitialized Toolkit::BaseObject is not allowed.
    */
   ScrollViewEffect();
@@ -71,7 +74,8 @@ public:
 public: // Not intended for application developers
 
   /**
-   * This constructor is used by Dali New() methods.
+   * @brief This constructor is used by Dali New() methods.
+   *
    * @param [in] impl A pointer to a newly allocated Dali resource
    */
   ScrollViewEffect(Internal::ScrollViewEffect *impl);