X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=capi%2Fdali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscroll-view%2Fscroll-view-page-spiral-effect.h;h=45021fb117d53a650bbc4c033ea937f193495528;hb=d585c0f0d53c488eb5026d2e9c49e90698b20181;hp=9de2d542d2625d9f46c0a3167bb56efc25f865ad;hpb=e2eda444afbe82e9591fe198eef339227f90a616;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-spiral-effect.h b/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-spiral-effect.h index 9de2d54..45021fb 100644 --- a/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-spiral-effect.h +++ b/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-spiral-effect.h @@ -1,24 +1,25 @@ #ifndef __DALI_TOOLKIT_SCROLL_VIEW_PAGE_SPIRAL_EFFECT_H__ #define __DALI_TOOLKIT_SCROLL_VIEW_PAGE_SPIRAL_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 * @{ */ @@ -39,9 +40,8 @@ class ScrollViewPageSpiralEffect; } /** - * ScrollView Page Spiral Effect. + * @brief This effect cause each page in a scroll-view to move along a spiral. * - * This effect cause each page in a scroll-view to move along a spiral. * It should be used on the following Actor hierarchy: * * ScrollView @@ -64,19 +64,23 @@ class ScrollViewPageSpiralEffect : public ScrollViewEffect public: /** - * Create an initialized ScrollViewPageSpiralEffect. + * @brief Create an initialized ScrollViewPageSpiralEffect. + * * @return A handle to a newly allocated Dali resource. */ static ScrollViewPageSpiralEffect New(); /** - * Create an uninitialized ScrollViewPageSpiralEffect; this can be initialized with ScrollViewPageSpiralEffect::New() + * @brief Create an uninitialized ScrollViewPageSpiralEffect; this can be initialized with ScrollViewPageSpiralEffect::New(). + * * Calling member functions with an uninitialized Toolkit::ScrollViewPageSpiralEffect is not allowed. */ ScrollViewPageSpiralEffect(); /** - * Downcast an Object handle to ScrollViewPageSpiralEffect. If handle points to a ScrollViewPageSpiralEffect the + * @brief Downcast an Object handle to ScrollViewPageSpiralEffect. + * + * If handle points to a ScrollViewPageSpiralEffect the * downcast produces valid handle. If not the returned handle is left uninitialized. * @param[in] handle Handle to an object * @return handle to a ScrollViewPageSpiralEffect or an uninitialized handle @@ -84,7 +88,8 @@ public: static ScrollViewPageSpiralEffect DownCast( BaseHandle handle ); /** - * Manually apply effect to a page in the scroll-view. + * @brief Manually apply effect to a page in the scroll-view. + * * @param[in] page The page to be affected by this effect. * @param[in] spiralAngle The spirald angle (in radians). * @@ -96,7 +101,8 @@ public: protected: /** - * 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 */ ScrollViewPageSpiralEffect( Internal::ScrollViewPageSpiralEffect *impl );