Conversion to Apache 2.0 license

[platform/core/uifw/dali-toolkit.git] / capi / dali-toolkit / public-api / shader-effects / ripple2d-effect.h

diff --git a/capi/dali-toolkit/public-api/shader-effects/ripple2d-effect.h b/capi/dali-toolkit/public-api/shader-effects/ripple2d-effect.h
index 45b9efb..a03aa8c 100644 (file)
--- a/capi/dali-toolkit/public-api/shader-effects/ripple2d-effect.h
+++ b/capi/dali-toolkit/public-api/shader-effects/ripple2d-effect.h
@@ -1,24 +1,25 @@
 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_H__
 #define __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_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_SHADER_EFFECTS_MODULE
  * @{
  */
 
@@ -32,49 +33,55 @@ namespace Toolkit
 {
 
 /**
- * Ripple2DEffect is a custom shader effect to achieve 2d ripple effects on Image actors
+ * @brief Ripple2DEffect is a custom shader effect to achieve 2d ripple effects on Image actors.
  */
 class Ripple2DEffect : public ShaderEffect
 {
 public:
 
   /**
-   * Create an uninitialized Ripple2DEffect; this can be initialized with Ripple2DEffect::New()
+   * @brief Create an uninitialized Ripple2DEffect; this can be initialized with Ripple2DEffect::New().
+   *
    * Calling member functions with an uninitialized Dali::Object is not allowed.
    */
   Ripple2DEffect();
 
   /**
-   * Virtual destructor.
+   * @brief Virtual destructor.
    */
   virtual ~Ripple2DEffect();
 
   /**
-   * Create an initialized Ripple2DEffect.
+   * @brief Create an initialized Ripple2DEffect.
+   *
    * @return A handle to a newly allocated Dali resource.
    */
   static Ripple2DEffect New();
 
   /**
-   * Set the amplitude of the 2d ripple.
+   * @brief Set the amplitude of the 2d ripple.
+   *
    * @param[in] amplitude The amplitude in float.
    */
   void SetAmplitude(float amplitude);
 
   /**
-   * Set the time duration for the 2d ripple.
+   * @brief Set the time duration for the 2d ripple.
+   *
    * @param[in] time The time duration in float.
    */
   void SetTime(float time);
 
   /**
-   * Get the name for the amplitude property
+   * @brief Get the name for the amplitude property.
+   *
    * @return A std::string containing the property name
    */
   const std::string& GetAmplitudePropertyName() const;
 
   /**
-   * Get the name for the time property
+   * @brief Get the name for the time property.
+   *
    * which can be used in Animation API's
    * @return A std::string containing the property name
    */