Fix comments about CornerRadiusPolicy and BorderlineColor 60/262360/1
authorEunki, Hong <eunkiki.hong@samsung.com>
Mon, 9 Aug 2021 05:26:55 +0000 (14:26 +0900)
committerEunki, Hong <eunkiki.hong@samsung.com>
Mon, 9 Aug 2021 05:31:44 +0000 (14:31 +0900)
When CornerRadiusPolicy is Relative, the maximum value is 0.5f.
If value is bigger than 0.5f, it will be clampled internally.
But we cannot notificate that informations only by documents.
Now fix it.
+
We add some more informations about borderline color;
It will be affected by visual opacity

Change-Id: Ic8afc5de3fd92b9cefcb1378959cb9ff4ab8102d
Signed-off-by: Eunki, Hong <eunkiki.hong@samsung.com>
dali-toolkit/devel-api/visuals/visual-properties-devel.h

index 5d620bb..0042451 100644 (file)
@@ -64,7 +64,7 @@ enum Type
   OPACITY             = Dali::Toolkit::Visual::Property::OPACITY,
 
   /**
   OPACITY             = Dali::Toolkit::Visual::Property::OPACITY,
 
   /**
-   * @brief The fitting mode of the visual
+   * @brief The fitting mode of the visual.
    * @details Name "fittingMode", type FittingMode (Property::INTEGER) or Property::STRING.
    * @see DevelVisual::FittingMode
    * @note The default is defined by the type of visual (if it's suitable to be stretched or not).
    * @details Name "fittingMode", type FittingMode (Property::INTEGER) or Property::STRING.
    * @see DevelVisual::FittingMode
    * @note The default is defined by the type of visual (if it's suitable to be stretched or not).
@@ -72,12 +72,12 @@ enum Type
   VISUAL_FITTING_MODE = OPACITY + 1,
 
   /**
   VISUAL_FITTING_MODE = OPACITY + 1,
 
   /**
-   * @brief The radius for the rounded corners of the visual
+   * @brief The radius for the rounded corners of the visual.
    * @details Name "cornerRadius", type Property::FLOAT or Prooperty::VECTOR4, animatable
    * @note By default, it is Vector::ZERO.
    * @note Only Property::Vector4 can be animated.
    * @note Each radius will clamp internally to the half of smaller of the visual width and visual height.
    * @details Name "cornerRadius", type Property::FLOAT or Prooperty::VECTOR4, animatable
    * @note By default, it is Vector::ZERO.
    * @note Only Property::Vector4 can be animated.
    * @note Each radius will clamp internally to the half of smaller of the visual width and visual height.
-   * @note Their may exist some alias when you use it as ClippingMode::CLIP_CHILDREN
+   * @note Their may exist some alias when you use it as ClippingMode::CLIP_CHILDREN.
    * @note Radius value are used in clockwise order from top-left-corner to bottom-left-corner.
    *       When radius is Vector4(x, y, z, w)
    *       x    y
    * @note Radius value are used in clockwise order from top-left-corner to bottom-left-corner.
    *       When radius is Vector4(x, y, z, w)
    *       x    y
@@ -89,7 +89,7 @@ enum Type
   CORNER_RADIUS = OPACITY + 2,
 
   /**
   CORNER_RADIUS = OPACITY + 2,
 
   /**
-   * @brief Whether the corner radius value is relative (percentage [0.0f to 1.0f] of the visual size) or absolute (in world units).
+   * @brief Whether the corner radius value is relative (percentage [0.0f to 0.5f] of the visual size) or absolute (in world units).
    * @details Name "cornerRadiusPolicy", type Property::INTEGER.
    * @see Policy::Type
    * @note By default, it is ABSOLUTE to the visual's size.
    * @details Name "cornerRadiusPolicy", type Property::INTEGER.
    * @see Policy::Type
    * @note By default, it is ABSOLUTE to the visual's size.
@@ -98,16 +98,17 @@ enum Type
   CORNER_RADIUS_POLICY = OPACITY + 3,
 
   /**
   CORNER_RADIUS_POLICY = OPACITY + 3,
 
   /**
-   * @brief The width for the borderline of the visual
+   * @brief The width for the borderline of the visual.
    * @details Name "borderlineWidth", type Property::FLOAT, animatable
    * @note Optional. Default value is 0.0f.
    */
   BORDERLINE_WIDTH = OPACITY + 4,
 
   /**
    * @details Name "borderlineWidth", type Property::FLOAT, animatable
    * @note Optional. Default value is 0.0f.
    */
   BORDERLINE_WIDTH = OPACITY + 4,
 
   /**
-   * @brief The color for the borderline of the visual
+   * @brief The color for the borderline of the visual.
    * @details Name "borderlineColor", type Property::VECTOR4, animatable
    * @details Name "borderlineColor", type Property::VECTOR4, animatable
-   * @note Default value is Color::BLACK
+   * @note Default value is Color::BLACK.
+   * @note This color is affected by opacity.
    */
   BORDERLINE_COLOR = OPACITY + 5,
 
    */
   BORDERLINE_COLOR = OPACITY + 5,