(Buttons) Creating actor from property-maps
[platform/core/uifw/dali-toolkit.git] / capi / dali-toolkit / public-api / shader-effects / nine-patch-mask-effect.h
index 43de3b2..b203eb6 100644 (file)
@@ -18,7 +18,7 @@
 //
 
 /**
- * @addtogroup CAPI_DALI_FRAMEWORK
+ * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
  * @{
  */
 
@@ -32,7 +32,8 @@ namespace Toolkit
 {
 
 /**
- * NinePatchMaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
+ * @brief NinePatchMaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
+ *
  * The mask image is expected to be smaller than the main image being viewed.
  * Conceptually the mask image is divided into a 3x3 grid (9 patches). The middle patch is stretched whilst the outer border is not.
  *
@@ -49,7 +50,8 @@ namespace NinePatchMaskEffect
 {
 
 /**
- * Apply the mask effect to an ImageActor.
+ * @brief Apply the mask effect to an ImageActor.
+ *
  * NinePatchMaskEffect is mutually exclusive with ImageActor::STYLE_NINE_PATCH i.e. the actor's main image should not be a nine-patch.
  * @param [in] actor The actor which needs the effect. To remove the effect call actor.RemoveShaderEffect().
  * @param [in] maskImage The path to a file containing the mask. The center pixels of the mask will be stretched.
@@ -57,7 +59,8 @@ namespace NinePatchMaskEffect
 void Apply( ImageActor actor, const std::string& maskImage );
 
 /**
- * Apply the mask effect to an ImageActor.
+ * @brief Apply the mask effect to an ImageActor.
+ *
  * NinePatchMaskEffect is mutually exclusive with ImageActor::STYLE_NINE_PATCH i.e. the actor's main image should not be a nine-patch.
  * @param [in] actor The actor which needs the effect. To remove the effect call actor.RemoveShaderEffect().
  * @param [in] maskImage The path to a file containing the mask.