From 8b3b9640acbe887e8a56a2dddf031b0564b1632b Mon Sep 17 00:00:00 2001 From: Seoyeon Kim Date: Thu, 22 Dec 2016 16:21:23 +0900 Subject: [PATCH] Add Visual descriptions to generate doxygen page Change-Id: I6d90458289e4d01064c08ba9eac3a0a91cc78252 Signed-off-by: Seoyeon Kim --- .../public-api/visuals/border-visual-properties.h | 12 ++++++++++ .../public-api/visuals/color-visual-properties.h | 12 ++++++++++ .../visuals/gradient-visual-properties.h | 26 ++++++++++++++++++++++ .../public-api/visuals/image-visual-properties.h | 12 ++++++++++ .../public-api/visuals/mesh-visual-properties.h | 20 +++++++++++++++++ .../visuals/primitive-visual-properties.h | 19 +++++++++++++++- .../public-api/visuals/visual-properties.h | 24 ++++++++++++++++++++ 7 files changed, 124 insertions(+), 1 deletion(-) diff --git a/dali-toolkit/public-api/visuals/border-visual-properties.h b/dali-toolkit/public-api/visuals/border-visual-properties.h index f6f2361..84470a9 100644 --- a/dali-toolkit/public-api/visuals/border-visual-properties.h +++ b/dali-toolkit/public-api/visuals/border-visual-properties.h @@ -32,12 +32,24 @@ namespace Toolkit * @{ */ +/** + * @brief BorderVisual is to render a solid color as an internal border to the control's quad. + * @SINCE_1_1.45 + */ namespace BorderVisual { +/** + * @brief BorderVisual Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief BorderVisual Property + * @SINCE_1_1.45 + */ enum { /** diff --git a/dali-toolkit/public-api/visuals/color-visual-properties.h b/dali-toolkit/public-api/visuals/color-visual-properties.h index 5a23abc..fb87e54 100644 --- a/dali-toolkit/public-api/visuals/color-visual-properties.h +++ b/dali-toolkit/public-api/visuals/color-visual-properties.h @@ -32,12 +32,24 @@ namespace Toolkit * @{ */ +/** + * @brief ColorVisual is to render a solid color to the control's quad. + * @SINCE_1_1.45 + */ namespace ColorVisual { +/** + * @brief ColorVisual Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief ColorVisual Property + * @SINCE_1_1.45 + */ enum { /** diff --git a/dali-toolkit/public-api/visuals/gradient-visual-properties.h b/dali-toolkit/public-api/visuals/gradient-visual-properties.h index 9c3929f..ae895ca 100644 --- a/dali-toolkit/public-api/visuals/gradient-visual-properties.h +++ b/dali-toolkit/public-api/visuals/gradient-visual-properties.h @@ -32,12 +32,24 @@ namespace Toolkit * @{ */ +/** + * @brief GradientVisual is to render a smooth transition of colors to the control's quad. + * @SINCE_1_1.45 + */ namespace GradientVisual { +/** + * @brief GradientVisual Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief GradientVisual Property + * @SINCE_1_1.45 + */ enum { /** @@ -109,6 +121,14 @@ enum } // namespace Property +/** + * @brief The type of coordinate system for certain attributes of the points in a gradient. + * + * This applies to the: + * - Start (x1, y1) and End (x2 and y2) points of a line if using a linear gradient. + * - Center point (cx, cy) and radius (r) of a circle if using a radial gradient. + * @SINCE_1_1.45 + */ namespace Units { @@ -118,6 +138,7 @@ namespace Units * This applies to the: * - Start (x1, y1) and End (x2 and y2) points of a line if using a linear gradient. * - Center point (cx, cy) and radius (r) of a circle if using a radial gradient. + * @SINCE_1_1.45 */ enum Type { @@ -127,11 +148,16 @@ enum Type } // namespace Units +/** + * @brief Policies that define what happens if the gradient starts or ends inside the bounds of the target rectangle. + * @SINCE_1_1.45 + */ namespace SpreadMethod { /** * @brief Policies that define what happens if the gradient starts or ends inside the bounds of the target rectangle. + * @SINCE_1_1.45 */ enum Type { diff --git a/dali-toolkit/public-api/visuals/image-visual-properties.h b/dali-toolkit/public-api/visuals/image-visual-properties.h index c1b0bfa..9b98812 100644 --- a/dali-toolkit/public-api/visuals/image-visual-properties.h +++ b/dali-toolkit/public-api/visuals/image-visual-properties.h @@ -32,12 +32,24 @@ namespace Toolkit * @{ */ +/** + * @brief ImageVisual is to render an image into the control's quad. + * @SINCE_1_1.45 + */ namespace ImageVisual { +/** + * @brief ImageVisual Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief ImageVisual Property + * @SINCE_1_1.45 + */ enum { /** diff --git a/dali-toolkit/public-api/visuals/mesh-visual-properties.h b/dali-toolkit/public-api/visuals/mesh-visual-properties.h index d9b7348..765fce7 100644 --- a/dali-toolkit/public-api/visuals/mesh-visual-properties.h +++ b/dali-toolkit/public-api/visuals/mesh-visual-properties.h @@ -32,12 +32,24 @@ namespace Toolkit * @{ */ +/** + * @brief MeshVisual is to render a mesh using a .obj file, optionally with textures provided by a mtl file. + * @SINCE_1_1.45 + */ namespace MeshVisual { +/** + * @brief MeshVisual Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief MeshVisual Property + * @SINCE_1_1.45 + */ enum { /** @@ -103,9 +115,17 @@ enum } // namespace Property +/** + * @brief The shading mode used by MeshVisual. + * @SINCE_1_1.45 + */ namespace ShadingMode { +/** + * @brief The shading mode used by MeshVisual. + * @SINCE_1_1.45 + */ enum Value { TEXTURELESS_WITH_DIFFUSE_LIGHTING, ///< *Simplest*. One color that is lit by ambient and diffuse lighting. @SINCE_1_1.45 diff --git a/dali-toolkit/public-api/visuals/primitive-visual-properties.h b/dali-toolkit/public-api/visuals/primitive-visual-properties.h index 4b31dc6..12f56e5 100644 --- a/dali-toolkit/public-api/visuals/primitive-visual-properties.h +++ b/dali-toolkit/public-api/visuals/primitive-visual-properties.h @@ -32,12 +32,24 @@ namespace Toolkit * @{ */ +/** + * @brief PrimitiveVisual is to render a simple 3D shape, such as a cube or sphere. + * @SINCE_1_1.45 + */ namespace PrimitiveVisual { +/** + * @brief PrimitiveVisual Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief PrimitiveVisual Property + * @SINCE_1_1.45 + */ enum { /** @@ -182,11 +194,16 @@ enum } // namespace Property +/** + * @brief The primitive shape to render as a PrimitiveVisual. + * @SINCE_1_1.45 + */ namespace Shape { /** - * @brief The primitive shape to render. + * @brief The primitive shape to render as a PrimitiveVisual. + * @SINCE_1_1.45 */ enum Type { diff --git a/dali-toolkit/public-api/visuals/visual-properties.h b/dali-toolkit/public-api/visuals/visual-properties.h index e5f7431..e708050 100644 --- a/dali-toolkit/public-api/visuals/visual-properties.h +++ b/dali-toolkit/public-api/visuals/visual-properties.h @@ -32,6 +32,10 @@ namespace Toolkit * @{ */ +/** + * @brief All the visual types + * @SINCE_1_1.45 + */ namespace Visual { @@ -50,9 +54,17 @@ enum Type WIREFRAME ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2_2 }; +/** + * @brief Visual Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief Visual Property + * @SINCE_1_1.45 + */ enum { /** @@ -77,12 +89,24 @@ enum } // namespace Property +/** + * @brief Shader for Visuals + * @SINCE_1_1.45 + */ namespace Shader { +/** + * @brief Shader Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief The type of Shader + * @SINCE_1_1.45 + */ enum { /** -- 2.7.4