From: Seoyeon Kim <seoyeon2.kim@samsung.com>
Date: Thu, 29 Dec 2016 02:46:27 +0000 (-0800)
Subject: Merge "[3.0] Add Visual descriptions to generate doxygen page" into tizen_3.0
X-Git-Tag: submit/tizen_3.0/20161230.052259~2
X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=e0e7742873655fd279abd0937120ce127f5bedfd;hp=cd7c45043e7b14931eaff69913d288ec674d28dc

Merge "[3.0] Add Visual descriptions to generate doxygen page" into tizen_3.0
---

diff --git a/dali-toolkit/public-api/visuals/border-visual-properties.h b/dali-toolkit/public-api/visuals/border-visual-properties.h
index 9024e91..7b6bee9 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 40ff7cc..3504984 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 9c12502..391a4d4 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,10 @@ enum
 
 } // namespace Property
 
+/**
+ * @brief The type of coordinate system for certain attributes of the points in a gradient
+ * @SINCE_1_1.45
+ */
 namespace Units
 {
 
@@ -118,6 +134,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 +144,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 7a8c602..bd25ffe 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 3999197..91d0c32 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 MeshVisual ShadingMode specified
+ * @SINCE_1_1.45
+ */
 namespace ShadingMode
 {
 
+/**
+ * @brief MeshVisual ShadingMode specified
+ * @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 86a4d3f9..6ce97f0 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 PrimitiveVisual Shape to render
+ * @SINCE_1_1.45
+ */
 namespace Shape
 {
 
 /**
- * @brief The primitive shape to render.
+ * @brief PrimitiveVisual Shape to render
+ * @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 b432e17..08b5b7b 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
 {
   /**