X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=capi%2Fdali-toolkit%2Fpublic-api%2Fshader-effects%2Fmask-effect.h;h=aefa9e7872b17a5ea026665abff2c10a7eafb5ba;hp=de6c22389228c34b0a9c2c94df599f9d7e7c018a;hb=aa19ec23c1186efea1585ed2dc19587714063e39;hpb=e2eda444afbe82e9591fe198eef339227f90a616 diff --git a/capi/dali-toolkit/public-api/shader-effects/mask-effect.h b/capi/dali-toolkit/public-api/shader-effects/mask-effect.h index de6c223..aefa9e7 100644 --- a/capi/dali-toolkit/public-api/shader-effects/mask-effect.h +++ b/capi/dali-toolkit/public-api/shader-effects/mask-effect.h @@ -18,7 +18,7 @@ // /** - * @addtogroup CAPI_DALI_FRAMEWORK + * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE * @{ */ @@ -32,7 +32,8 @@ namespace Toolkit { /** - * MaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image. + * @brief MaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image. + * * Typically mask images should be the same size as the main image being viewed, but this isn't essential. * * Usage example: @@ -46,17 +47,19 @@ class DALI_IMPORT_API MaskEffect : public ShaderEffect public: /** - * Create an empty MaskEffect handle. + * @brief Create an empty MaskEffect handle. */ MaskEffect(); /** - * Virtual destructor. + * @brief Virtual destructor. */ virtual ~MaskEffect(); /** - * Create a MaskEffect. + * @brief Create a MaskEffect. + * + * @param[in] maskImage The image to use as a mask * @return A handle to a newly allocated MaskEffect. */ static MaskEffect New( Image maskImage );