projects
/
platform
/
core
/
uifw
/
dali-toolkit.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Updated CAPI documentation style
[platform/core/uifw/dali-toolkit.git]
/
capi
/
dali-toolkit
/
public-api
/
shader-effects
/
mask-effect.h
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
(file)
--- 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:
* 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:
/**
public:
/**
- * Create an empty MaskEffect handle.
+ *
@brief
Create an empty MaskEffect handle.
*/
MaskEffect();
/**
*/
MaskEffect();
/**
- * Virtual destructor.
+ *
@brief
Virtual destructor.
*/
virtual ~MaskEffect();
/**
*/
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 );
* @return A handle to a newly allocated MaskEffect.
*/
static MaskEffect New( Image maskImage );