[Tizen] Sync for libds

[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / offscreen-application.h

diff --git a/dali/devel-api/adaptor-framework/offscreen-application.h b/dali/devel-api/adaptor-framework/offscreen-application.h
index dd5eacb..994545c 100644 (file)
--- a/dali/devel-api/adaptor-framework/offscreen-application.h
+++ b/dali/devel-api/adaptor-framework/offscreen-application.h
@@ -44,16 +44,20 @@ class OffscreenApplication;
  */
 class DALI_IMPORT_API OffscreenApplication : public Dali::BaseHandle
 {
+
 public:
 
+  using OffscreenApplicationSignalType = Signal<void (void)>;
+
+  /**
+   * @brief Enumeration for the render mode
+   */
   enum class RenderMode
   {
-    AUTO,         // UI is rendered automatically
-    MANUAL        // UI is rendered by RenderOnce()
+    AUTO,         // Scene is rendered automatically
+    MANUAL        // Scene is rendered by RenderOnce()
   };
 
-  typedef Signal<void (void)> OffscreenApplicationSignalType;
-
 public:
 
   /**
@@ -74,8 +78,7 @@ public:
    * @param[in] isTranslucent Whether the OffscreenWindow is translucent or not
    * @param[in] renderMode The RenderMode of the OffscreenApplication
    */
-  static OffscreenApplication New( Dali::Any surface, bool isTranslucent,
-                                   RenderMode renderMode = RenderMode::AUTO );
+  static OffscreenApplication New( Dali::Any surface, bool isTranslucent, RenderMode renderMode = RenderMode::AUTO );
 
   /**
    * @brief Constructs an empty handle
@@ -84,11 +87,16 @@ public:
 
   /**
    * @brief Copy constructor
+   *
+   * @param [in] offscreenApplication A reference to the copied handle
    */
   OffscreenApplication( const OffscreenApplication& offscreenApplication );
 
   /**
    * @brief Assignment operator
+   *
+   * @param [in] offscreenApplication A reference to the copied handle
+   * @return A reference to this
    */
   OffscreenApplication& operator=( const OffscreenApplication& offscreenApplication );
 
@@ -111,8 +119,8 @@ public:
 
 
   /**
-   * @brief Get the default Window handle
-   * @return The default Window
+   * @brief Get the default OffscreenWindow handle
+   * @return The default OffscreenWindow
    */
   OffscreenWindow GetWindow();