[5.0] Add '@addtogroup' tag to generate doxygen page

[platform/core/uifw/dali-core.git] / dali / public-api / rendering / shader.h

diff --git a/dali/public-api/rendering/shader.h b/dali/public-api/rendering/shader.h
index 4c28dad..2c58257 100644 (file)
--- a/dali/public-api/rendering/shader.h
+++ b/dali/public-api/rendering/shader.h
@@ -2,7 +2,7 @@
 #define DALI_SHADER_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 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.
@@ -57,6 +57,10 @@
 
 namespace Dali
 {
+/**
+ * @addtogroup dali_core_rendering_effects
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -68,7 +72,7 @@ class Shader;
  *
  * @SINCE_1_1.43
  */
-class DALI_IMPORT_API Shader : public Handle
+class DALI_CORE_API Shader : public Handle
 {
 public:
 
@@ -79,7 +83,7 @@ public:
   struct Hint
   {
     /**
-     * @brief Hint value
+     * @brief Enumeration for the hint value.
      * @SINCE_1_1.45
      */
     enum Value
@@ -91,17 +95,21 @@ public:
   };
 
   /**
-   * @brief An enumeration of properties belonging to the Shader class.
+   * @brief Enumeration for instances of properties belonging to the Shader class.
    * @SINCE_1_1.43
    */
   struct Property
   {
+    /**
+     * @brief Enumeration for instances of properties belonging to the Shader class.
+     * @SINCE_1_1.43
+     */
     enum
     {
       /**
-       * @brief Name: "program", Type: MAP
-       * @note  The default value is empty
-       * @note  Format: {"vertex":"","fragment":"",hints:"","vertexPrefix":"","fragmentPrefix":""}
+       * @brief Name: "program", Type: MAP.
+       * @note The default value is empty.
+       * @note Format: {"vertex":"","fragment":"",hints:"","vertexPrefix":"","fragmentPrefix":""}
        * @SINCE_1_1.43
        */
       PROGRAM = DEFAULT_OBJECT_PROPERTY_START_INDEX
@@ -109,12 +117,12 @@ public:
   };
 
   /**
-   * @brief Create Shader.
+   * @brief Creates Shader.
    *
    * @SINCE_1_1.43
-   * @param[in] vertexShader Vertex shader code for the effect. If you pass in an empty string, the default version will be used
-   * @param[in] fragmentShader fragment shader code for the effect. If you pass in an empty string, the default version will be used
-   * @param[in] hints GeometryHints to define the geometry of the rendered object
+   * @param[in] vertexShader Vertex shader code for the effect.
+   * @param[in] fragmentShader Fragment Shader code for the effect.
+   * @param[in] hints Hints to define the geometry of the rendered object
    * @return A handle to a shader effect
    */
   static Shader New( const std::string& vertexShader,
@@ -122,14 +130,14 @@ public:
                      Hint::Value hints = Hint::NONE );
 
   /**
-   * @brief Default constructor, creates an empty handle
+   * @brief Default constructor, creates an empty handle.
    *
    * @SINCE_1_1.43
    */
   Shader();
 
   /**
-   * @brief Destructor
+   * @brief Destructor.
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
    *
    * @SINCE_1_1.43
@@ -137,7 +145,7 @@ public:
   ~Shader();
 
   /**
-   * @brief Copy constructor
+   * @brief Copy constructor.
    *
    * @SINCE_1_1.43
    * @param[in] handle A handle to a Shader object
@@ -145,8 +153,8 @@ public:
   Shader( const Shader& handle );
 
   /**
-   * @brief Downcast to a shader handle.
-   * If not a shader the returned shader handle is left uninitialized.
+   * @brief Downcasts to a shader handle.
+   * If not, a shader the returned shader handle is left uninitialized.
    *
    * @SINCE_1_1.43
    * @param[in] handle Handle to an object
@@ -155,7 +163,7 @@ public:
   static Shader DownCast( BaseHandle handle );
 
   /**
-   * @brief Assignment operator, changes this handle to point at the same object
+   * @brief Assignment operator, changes this handle to point at the same object.
    *
    * @SINCE_1_1.43
    * @param[in] handle Handle to an object
@@ -174,6 +182,9 @@ public:
   explicit DALI_INTERNAL Shader( Internal::Shader* effect );
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // DALI_SHADER_H