Revert "[3.0] Exclude internal tag module in Public API reference"

[platform/core/uifw/dali-core.git] / dali / public-api / render-tasks / render-task-list.h

diff --git a/dali/public-api/render-tasks/render-task-list.h b/dali/public-api/render-tasks/render-task-list.h
index bb02117..8a36810 100644 (file)
--- a/dali/public-api/render-tasks/render-task-list.h
+++ b/dali/public-api/render-tasks/render-task-list.h
@@ -2,7 +2,7 @@
 #define __DALI_RENDER_TASK_LIST_H__
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 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.
@@ -19,11 +19,14 @@
  */
 
 // INTERNAL INCLUDES
-#include <dali/public-api/common/vector-wrapper.h>
 #include <dali/public-api/object/base-handle.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
+/**
+ * @addtogroup dali_core_rendering_effects
+ * @{
+ */
 
 class RenderTask;
 
@@ -36,8 +39,9 @@ class RenderTaskList;
  * @brief An ordered list of Dali::RenderTask%s.
  *
  * These tasks describe how the Dali scene should be rendered; @see Dali::RenderTask for more details.
+ * @SINCE_1_0.0
  */
-class RenderTaskList : public BaseHandle
+class DALI_IMPORT_API RenderTaskList : public BaseHandle
 {
 public:
 
@@ -45,6 +49,7 @@ public:
    * @brief Create an empty RenderTaskList handle.
    *
    * This can be initialised with Stage::GetRenderTaskList().
+   * @SINCE_1_0.0
    */
   RenderTaskList();
 
@@ -54,6 +59,7 @@ public:
    * If handle points to a RenderTaskList the downcast produces valid
    * handle. If not the returned handle is left uninitialized.
    *
+   * @SINCE_1_0.0
    * @param[in] handle A handle to an object.
    * @return A handle to a RenderTaskList or an uninitialized handle.
    */
@@ -63,24 +69,39 @@ public:
    * @brief Destructor
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
   ~RenderTaskList();
 
   /**
-   * @copydoc Dali::BaseHandle::operator=
+   * @brief This copy constructor is required for (smart) pointer semantics.
+   *
+   * @SINCE_1_0.0
+   * @param [in] handle A reference to the copied handle
    */
-  using BaseHandle::operator=;
+  RenderTaskList(const RenderTaskList& handle);
+
+  /**
+   * @brief This assignment operator is required for (smart) pointer semantics.
+   *
+   * @SINCE_1_0.0
+   * @param [in] rhs  A reference to the copied handle
+   * @return A reference to this
+   */
+  RenderTaskList& operator=(const RenderTaskList& rhs);
 
   /**
    * @brief Create a new RenderTask.
    *
    * This will be appended to the list of render-tasks.
+   * @SINCE_1_0.0
    * @return A valid handle to a new RenderTask.
    */
   RenderTask CreateTask();
 
   /**
    * @brief Remove a RenderTask from the list of render-tasks.
+   * @SINCE_1_0.0
    * @param[in] task The render-task to remove.
    */
   void RemoveTask( RenderTask task );
@@ -89,6 +110,7 @@ public:
    * @brief Query the number of render-tasks in the list.
    *
    * This is ordered i.e. the task with index 0 is the first to be processed each frame.
+   * @SINCE_1_0.0
    * @return The number of render-tasks.
    */
   unsigned int GetTaskCount() const;
@@ -96,9 +118,10 @@ public:
   /**
    * @brief Retrieve a render-task.
    *
-   * @pre index should be in range i.e. less than GetTaskCount().
+   * @SINCE_1_0.0
    * @param[in] index The index of the render task to retrieve
    * @return A handle to the render-task.
+   * @pre index should be in range i.e. less than GetTaskCount().
    */
   RenderTask GetTask( unsigned int index ) const;
 
@@ -106,11 +129,15 @@ public: // Not intended for application developers
 
   /**
    * @brief This constructor is used by Dali New() methods
+   * @SINCE_1_0.0
    * @param [in] renderTask A pointer to a newly allocated render-task
    */
   explicit DALI_INTERNAL RenderTaskList( Internal::RenderTaskList* renderTask );
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif //__DALI_RENDER_TASK_LIST_H__