Revert "[3.0] Fixed Svace Defect"

[platform/core/uifw/dali-adaptor.git] / adaptors / base / thread-controller.h

diff --git a/adaptors/base/thread-controller.h b/adaptors/base/thread-controller.h
index fba36c5..d9b8976 100644 (file)
--- a/adaptors/base/thread-controller.h
+++ b/adaptors/base/thread-controller.h
@@ -51,43 +51,54 @@ public:
   ~ThreadController();
 
   /**
-   * Initializes the thread controller
+   * @brief Initializes the thread controller
+   *
+   * Will do any required initialiszation, e.g. initialize EGL, create threads (if required), etc.
+   *
+   * @note When this function returns, the application Init signal should be emitted
    */
   void Initialize();
 
   /**
-   * @copydoc Dali::Adaptor::Start()
+   * @brief Called AFTER the Init signal has been emitted.
+   *
+   * In other words, should be called AFTER the Init signal has been emitted and all messages for the first scene
+   * have been queued for update to process.
    */
   void Start();
 
   /**
-   * @copydoc Dali::Adaptor::Pause()
+   * @brief When called, update and rendering is paused.
    */
   void Pause();
 
   /**
-   * @copydoc Dali::Adaptor::Resume()
+   * @brief Resumes update/rendering after a previous pause.
    */
   void Resume();
 
   /**
-   * @copydoc Dali::Adaptor::Stop()
+   * @brief Stops update/rendering altogether.
+   *
+   * Will shutdown EGL, destroy threads (if required) etc.
    */
   void Stop();
 
   /**
-   * Called by the adaptor when core requires another update
+   * @brief Called by the adaptor when core requires another update
    */
   void RequestUpdate();
 
   /**
-   * Called by the adaptor when core requires one update
-   * If Adaptor is paused, we do one update and return to pause
+   * @brief Called by the adaptor when core requires one update
+   *
+   * @note If Adaptor is paused, we do one update/render only
    */
   void RequestUpdateOnce();
 
   /**
-   * Replaces the surface.
+   * @brief Replaces the surface.
+   *
    * @param surface new surface
    */
   void ReplaceSurface( RenderSurface* surface );