Merge "Add Visual descriptions to generate doxygen page" into devel/master
authorAdeel Kazmi <adeel.kazmi@samsung.com>
Fri, 17 Feb 2017 11:30:10 +0000 (03:30 -0800)
committerGerrit Code Review <gerrit@review.vlan103.tizen.org>
Fri, 17 Feb 2017 11:30:10 +0000 (03:30 -0800)
1  2 
dali-toolkit/public-api/visuals/image-visual-properties.h
dali-toolkit/public-api/visuals/visual-properties.h

@@@ -32,12 -32,24 +32,24 @@@ namespace Toolki
   * @{
   */
  
+ /**
+  * @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
  {
    /**
    BORDER_ONLY,
  
    /**
 -   * @brief This enables Image visuals to automatically be converted to Batch-Image visuals.
 -   * @details Name "batchingEnabled", type Property::BOOLEAN.
 -   * @SINCE_1_2.0
 -   * @note Optional. If not specified, the default is false.
 -   * @note For Image visuals only. Not to be used with NPatch or SVG images.
 -   */
 -  BATCHING_ENABLED,
 -
 -  /**
     * @brief The image area to be displayed.
     * @details Name "pixelArea", type Property::VECTOR4.
     *          It is a rectangular area.
@@@ -2,7 -2,7 +2,7 @@@
  #define DALI_TOOLKIT_VISUAL_PROPERTIES_H
  
  /*
 - * Copyright (c) 2016 Samsung Electronics Co., Ltd.
 + * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
@@@ -32,6 -32,10 +32,10 @@@ namespace Toolki
   * @{
   */
  
+ /**
+  * @brief All the visual types
+  * @SINCE_1_1.45
+  */
  namespace Visual
  {
  
@@@ -50,9 -54,17 +54,17 @@@ enum Typ
    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
  {
    /**
  
  } // 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
  {
    /**
     * @brief The vertex shader.
 -   * @details Name "vertexShader", type Property::STRING.
 +   * @details Name "vertexShader", type Property::STRING or Property::ARRAY of Property::STRING.
 +   *          A Property::ARRAY of Property::STRING values can be used to split the shader string over multiple lines.
     * @SINCE_1_1.45
     * @note Optional
     * @note If not supplied, the visual's already set vertex shader is used.
  
    /**
     * @brief The fragment shader.
 -   * @details Name "fragmentShader", type Property::STRING.
 +   * @details Name "fragmentShader", type Property::STRING or Property::ARRAY of Property::STRING.
 +   *          A Property::ARRAY of Property::STRING values can be used to split the shader string over multiple lines.
     * @SINCE_1_1.45
     * @note Optional
     * @note If not supplied, the visual's already set fragment shader is used.