Applied a header review

Change-Id: Iaaa1b7c674b9f97aecd0d7369d7bedc68234bec1
Signed-off-by: Bongjoo Seo <bongjoo.seo@samsung.com>

diff --git a/inc/FUiAnimAnimationTransaction.h b/inc/FUiAnimAnimationTransaction.h
index 2026e6d..a2ee41b 100644 (file)
--- a/inc/FUiAnimAnimationTransaction.h
+++ b/inc/FUiAnimAnimationTransaction.h
@@ -202,9 +202,10 @@ public:
         * @param[in]   pListener       The pointer of listener instance to set
         * @exception   E_SUCCESS       The method is successful.
         * @exception   E_INVALID_OPERATION     An uncommitted transaction does not exist.
-        * @remarks     This is used as the default value for the newly created VisualElementAnimation class or its descendant classes in the current transaction.
-        * @remarks     When the animation which is listening to an animation status event is removed before starting, the platform skips to call @n
-        *                      the IVisualElementAnimationStatusEventListener::OnVisualElementAnimationStarted() method and directly calls the IVisualElementAnimationStatusEventListener::OnVisualElementAnimationFinished() method.
+        * @remarks     
+        *                              - This is used as the default value for the newly created VisualElementAnimation class or its descendant classes in the current transaction.
+        *              - If an animation that is listening to an animation status event is removed before starting, then the platform skips to call @n
+        *                            the IVisualElementAnimationStatusEventListener::OnVisualElementAnimationStarted() method and directly calls the IVisualElementAnimationStatusEventListener::OnVisualElementAnimationFinished() method.
         */
        static result SetVisualElementAnimationStatusEventListener(IVisualElementAnimationStatusEventListener* pListener);
 

diff --git a/inc/FUiAnimFrameAnimator.h b/inc/FUiAnimFrameAnimator.h
index 127af54..9383b2b 100644 (file)
--- a/inc/FUiAnimFrameAnimator.h
+++ b/inc/FUiAnimFrameAnimator.h
@@ -122,18 +122,18 @@ public:
        result SetCurrentForm(const Tizen::Ui::Controls::Form& form);
 
        /**
-        * Sets the specified form as the current form of the frame with an animation.
+        * Sets a specified form as the current form of the frame with an animation.
         *
         * @since       2.1
         *
         * @return              An error code
-        * @param[in]           pForm                           A pointer to form object to set.
+        * @param[in]           pForm                           A pointer to Form object to set
         * @exception     E_SUCCESS                             The method is successful.
         * @exception   E_INVALID_ARG                             The specified @c pForm is @c null.
         * @exception   E_INVALID_OPERATION             The current state of the instance prohibits the execution of the specified operation.
         * @exception     E_SYSTEM                              A system error has occurred.
         * @remarks             Control::Invalidate() need not be called to display the form. @n
-        *                              To select the animation to be used during this method, use SetFormTransitionAnimation() before calling this method.
+        *                              To select the animation that is used during this method, use SetFormTransitionAnimation() before calling this method.
         */
        result SetCurrentForm(Tizen::Ui::Controls::Form* pForm);
 

diff --git a/inc/FUiAnimIVisualElementEventListener.h b/inc/FUiAnimIVisualElementEventListener.h
index 6336ebb..17565e9 100644 (file)
--- a/inc/FUiAnimIVisualElementEventListener.h
+++ b/inc/FUiAnimIVisualElementEventListener.h
@@ -78,7 +78,7 @@ public:
        /**
         * Called when the child is detached to VisualElement. @n
         * Overrides the %OnChildDetached() method to provide user-specific code just after the child is detached from the %VisualElement.
-        * This method is invoked when @c child is detached from @c source by @c DetachChild, @c InsertChild, @c ChangeZOder.
+        * This method is invoked when @c child is detached from @c source by @c DetachChild, @c InsertChild, or @c ChangeZOder.
         *
         * @since               2.0
         *
@@ -107,7 +107,7 @@ public:
        /**
         * Called when VisualElement is detached to the parent. @n
         * Overrides the %OnDetached() method to provide user-specific code just after the %VisualElement is detached from the parent.
-        * This method is invoked when @c source is detached from @c parent by @c DetachChild, @c InsertChild, @c ChangeZOder.
+        * This method is invoked when @c source is detached from @c parent by @c DetachChild, @c InsertChild, or @c ChangeZOder.
         *
         * @since               2.0
         *

diff --git a/inc/FUiAnimTypes.h b/inc/FUiAnimTypes.h
index d85b498..a4754f1 100644 (file)
--- a/inc/FUiAnimTypes.h
+++ b/inc/FUiAnimTypes.h
@@ -95,7 +95,7 @@ enum AnimationTargetType
        ANIMATION_TARGET_NONE = -1,     /**< An invalid %Animation */
        ANIMATION_TARGET_SIZE,          /**< An animation for the size property */
        ANIMATION_TARGET_POSITION,      /**< An animation for the position property */
-       ANIMATION_TARGET_ALPHA,         /**< An animation for alpha property */
+       ANIMATION_TARGET_ALPHA,         /**< An animation for alpha property @n The value range for playing the alpha animation must be between @c 0.0 to @c 1.0. */
        ANIMATION_TARGET_ROTATION,      /**< An animation for rotate property @n The control will be rotated in the xy-plane along the z-axis. */
        ANIMATION_TARGET_MAX            // This enum value is for internal use only.
                                                                        // Using this enum value can cause behavioral, security-related, and consistency-related issues in the application.

diff --git a/inc/FUiAnimVisualElement.h b/inc/FUiAnimVisualElement.h
index 1286f37..034fab9 100644 (file)
--- a/inc/FUiAnimVisualElement.h
+++ b/inc/FUiAnimVisualElement.h
@@ -60,7 +60,7 @@ class _VisualElementImpl;
  * It also provides infrastructure necessary for animations (AddAnimation(), RemoveAnimation() and so on).
  * A %VisualElement object instantiated by applications works as a model object and may have a cloned counter part for presentation on screen which has a separated life-cycle.
  * The presentation object is managed by system and applications must not change properties of it.
- * Use the presentation instance only for getting the current state of the visual element in the tree. If you call the setter methods of the presentation instance, it can cause unexpected behavior.
+ * Use the presentation instance only to get the current state of a visual element in a tree. Calling the setter methods of a presentation instance can cause unexpected behavior to occur.
  * Most animations of %VisualElement are applied on presentation objects. Properties set by applications are stored in model objects while properties of presentation objects
  * are changing during implicit or explicit animations.
  *
@@ -392,15 +392,15 @@ public:
        bool IsChildOf(const VisualElement& other) const;
 
        /**
-        * Checks whether this instance is a child or descendant of the specified one.
+        * Checks whether an instance is a child or descendant of a specified one.
         *
         * @since               2.1
         *
-        * @return              @c true if this instance is a child or descendant of the specified one, @n
+        * @return              @c true if this instance is a child or descendant of a specified one, @n
         *                              else @c false
-        * @param[in]           pOther                          A Pointer to %VisualElement instance to test relationship
+        * @param[in]           pOther                          A pointer to %VisualElement instance to check its relationship
         * @exception           E_SUCCESS The method is successful.
-        * @exception           E_INVALID_ARG  The specified @c pOther is null.
+        * @exception           E_INVALID_ARG  The specified @c pOther is @c null.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        bool IsChildOf(const VisualElement* pOther) const;
@@ -427,9 +427,9 @@ public:
        result AttachChild(const VisualElement& child);
 
        /**
-        * Attaches a child to this instance. @n
+        * Attaches a child to an instance. @n
         * The %AttachChild() method attaches the specified @c pChild at the highest position in the Z order group of the @c pChild.
-        * If you need to change Z-Order group, you can change it using the SetZOrderGroup() method.
+        * Z-Order group can be changed using the SetZOrderGroup() method.
         *
         * @since               2.1
         *
@@ -478,16 +478,16 @@ public:
        result InsertChild(const VisualElement& child, const VisualElement* pReference, bool above);
 
        /**
-        * Inserts a child to this instance. @n
+        * Inserts a child to an instance. @n
         * If @c pReference is not @c null, the Z order group of @c pChild will be changed into that of @c pReference and @c child will be
         * placed right above or below the @c pReference instance according to the @c above parameter.
         *
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   pChild                          A pointer to %VisualElement instance to attach to this instance
-        * @param[in]   pReference                      A pointer to the %VisualElement instance that is referenced
-        * @param[in]   above                           Specifies the position of @c pChild relative to the @c pReference
+        * @param[in]   pChild                          A pointer to %VisualElement instance to insert
+        * @param[in]   pReference                      A pointer to the %VisualElement instance to refer
+        * @param[in]   above                           The position of @c pChild relative to @c pReference
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_ARG           The input parameter is incorrect. Either of the following conditions has occurred: @n
         *                                                                      - The specified @c pChild is not instantiated successfully. @n
@@ -496,10 +496,10 @@ public:
         *                                                                      - The specified @c pChild is already an ancestor of this instance. @n
         *                                                                      - The parent of @c pReference is not this instance if @c pReference is not @c null. @n
         *                                                                      - The specified @c pChild is @c null.
-        * @remarks             If @c above is @c true, the @c pChild will be attached above @c pReference in Z order,
-        *                              else it will be attached below the @c pReference %VisualElement. @n
-        *                              If @c pReference is @c null, the @c pChild will be attached at the highest position in the @c pChild's Z order group,
-        *                              else the child will be attached at the lowest position in the @c pChild's Z order group.
+        * @remarks             If @c above is @c true, the @c pChild is attached above @c pReference in Z order,
+        *                              else it is attached below the @c pReference %VisualElement. @n
+        *                              If @c pReference is @c null, the @c pChild is attached at the highest position in the @c pChild's Z order group,
+        *                              else the child is attached at the lowest position in the @c pChild's Z order group.
         * @see         SetZOrderGroup()
         * @see         AttachChild()
         * @see         DetachChild()
@@ -523,16 +523,16 @@ public:
        result DetachChild(const VisualElement& child);
 
        /**
-        * Detaches a child from this instance.
+        * Detaches a child from an instance.
         *
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   pChild                          A pointer to %VisualElement instance to detach from this instance
+        * @param[in]   pChild                          A pointer to %VisualElement instance to detach
         * @exception           E_SUCCESS                       The method is successful.
         * @exception           E_OBJ_NOT_FOUND The specified @c pChild is not a child of this instance.
         * @exception           E_INVALID_ARG           The specified @c pChild is @c null.
-        * @remarks             This method detaches @c pChild from this instance. If you need to deallocate %VisualElement, call Destroy() method, not C++ delete.
+        * @remarks             This method detaches @c pChild from this instance. To deallocate %VisualElement, call Destroy() method, and not C++ delete.
         * @see                InsertChild()
         * @see         AttachChild()
         */
@@ -1277,7 +1277,7 @@ public:
        result ConvertCoordinates(Tizen::Graphics::FloatRectangle& rectangle, const VisualElement* pFromVisualElement) const;
 
        /**
-        * Transforms point in @c pOriginVisualElement coordinate space into the specified vector in this instance's coordinate space.
+        * Transforms a point in @c pOriginVisualElement coordinate space into a specified vector in calling instance's coordinate space.
         *
         * @since                       2.1
         *
@@ -1288,8 +1288,8 @@ public:
         * @exception           E_INVALID_ARG           The input parameter is incorrect.
         * @exception           E_INVALID_OPERATION                     The current state of the instance prohibits the execution of the specified operation. @n
                                                                                                The matrix for this conversion is singular which has zero determinant.
-        * @remarks                     This instance and @c pOriginVisualElement must share a common ancestor.
-        * @remarks                     The specific error code can be accessed using the GetLastResult() method.
+        * @remarks                     - This instance and @c pOriginVisualElement must share a common ancestor.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         */
        Tizen::Graphics::FloatPoint3 TransformVectorFromOrigin(const Tizen::Graphics::FloatPoint3& originPoint, const VisualElement* pOriginVisualElement) const;
 

diff --git a/inc/FUiAnimVisualElementAnimation.h b/inc/FUiAnimVisualElementAnimation.h
index bfc918c..5e89704 100644 (file)
--- a/inc/FUiAnimVisualElementAnimation.h
+++ b/inc/FUiAnimVisualElementAnimation.h
@@ -165,7 +165,7 @@ public:
         * @since       2.0
         *
         * @param[in]   pListener               The listener instance to set
-        * @remarks     When the animation which is listening to an animation status event is removed before starting, the platform skips to call @n
+        * @remarks     When the animation that is listening to an animation status event is removed before it starts, the platform skips to call @n
         *                      the IVisualElementAnimationStatusEventListener::OnVisualElementAnimationStarted() method and directly calls the IVisualElementAnimationStatusEventListener::OnVisualElementAnimationFinished() method.
         */
        void SetVisualElementAnimationStatusEventListener(IVisualElementAnimationStatusEventListener* pListener);

diff --git a/src/ui/animations/FUiAnim_EflVisualElementSurfaceImpl.cpp b/src/ui/animations/FUiAnim_EflVisualElementSurfaceImpl.cpp
index 7396123..9f2a5bb 100644 (file)
--- a/src/ui/animations/FUiAnim_EflVisualElementSurfaceImpl.cpp
+++ b/src/ui/animations/FUiAnim_EflVisualElementSurfaceImpl.cpp
@@ -149,7 +149,10 @@ _EflVisualElementSurfaceImpl::~_EflVisualElementSurfaceImpl(void)
        if (__pEvasImage != null)
        {
                evas_object_hide(__pEvasImage);
-               if (__pBuffer)
+
+               // * DO NOT delete object which has a native surface
+               // because it has been created from other modules.
+               if (!evas_object_image_native_surface_get(__pEvasImage))
                {
                        evas_object_image_data_set(__pEvasImage, null);
                        evas_object_del(__pEvasImage);