X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fdevel-api%2Fadaptor-framework%2Foffscreen-application.h;h=b549cb63efffc3edf6f96c1060811810c5bf0ee1;hb=84fdd2eca766967c7d6a0ad6869dbbf20e0782ba;hp=dd5eacb1313003b98986b11c089df98cfd450bb7;hpb=ff3d9708cc7138bd1643821bd129724d09dbf871;p=platform%2Fcore%2Fuifw%2Fdali-adaptor.git

diff --git a/dali/devel-api/adaptor-framework/offscreen-application.h b/dali/devel-api/adaptor-framework/offscreen-application.h
index dd5eacb..b549cb6 100644
--- a/dali/devel-api/adaptor-framework/offscreen-application.h
+++ b/dali/devel-api/adaptor-framework/offscreen-application.h
@@ -19,13 +19,12 @@
  */
 
 // EXTERNAL INCLUDES
-#include <dali/public-api/signals/dali-signal.h>
 #include <dali/public-api/object/any.h>
 #include <dali/public-api/object/base-handle.h>
+#include <dali/public-api/signals/dali-signal.h>
 
 namespace Dali
 {
-
 /**
  * @addtogroup dali_adaptor_framework
  * @{
@@ -45,17 +44,18 @@ 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:
-
   /**
    * @brief This is the constructor of OffscreenApplication
    *
@@ -64,8 +64,7 @@ public:
    * @param[in] isTranslucent Whether the OffscreenWindow is translucent or not
    * @param[in] renderMode The RenderMode of the OffscreenApplication
    */
-  static OffscreenApplication New( uint16_t width, uint16_t height, bool isTranslucent,
-                                   RenderMode renderMode = RenderMode::AUTO );
+  static OffscreenApplication New(uint16_t width, uint16_t height, bool isTranslucent, RenderMode renderMode = RenderMode::AUTO);
 
   /**
    * @brief This is the constructor of OffscreenApplication
@@ -74,8 +73,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,13 +82,18 @@ public:
 
   /**
    * @brief Copy constructor
+   *
+   * @param [in] offscreenApplication A reference to the copied handle
    */
-  OffscreenApplication( const OffscreenApplication& offscreenApplication );
+  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 );
+  OffscreenApplication& operator=(const OffscreenApplication& offscreenApplication);
 
   /**
    * @brief Destructor
@@ -98,7 +101,6 @@ public:
   ~OffscreenApplication();
 
 public:
-
   /**
    * @brief Starts the OffscreenApplication (rendering, event handling, etc)
    */
@@ -109,10 +111,9 @@ public:
    */
   void Stop();
 
-
   /**
-   * @brief Get the default Window handle
-   * @return The default Window
+   * @brief Get the default OffscreenWindow handle
+   * @return The default OffscreenWindow
    */
   OffscreenWindow GetWindow();
 
@@ -121,36 +122,34 @@ public:
    */
   void RenderOnce();
 
-public:  // Signals
-
-  /**
+public: // Signals
+        /**
    * @brief Signal to notify the client when the application is ready to be initialized
    *
    * @note OffscreenApplication::Start() should be called to be initialized
    *
    * @return The signal
    */
- OffscreenApplicationSignalType& InitSignal();
+  OffscreenApplicationSignalType& InitSignal();
 
   /**
    * @brief Signal to notify the user when the application is about to be terminated
    *
    * @return The signal
    */
- OffscreenApplicationSignalType& TerminateSignal();
+  OffscreenApplicationSignalType& TerminateSignal();
 
 public: // Not intended for application developers
   /**
    * @brief Internal constructor
    */
-  explicit DALI_INTERNAL OffscreenApplication( Internal::OffscreenApplication* offscreenApplication );
-
+  explicit DALI_INTERNAL OffscreenApplication(Internal::OffscreenApplication* offscreenApplication);
 };
 
 /**
  * @}
  */
 
-}  // namespace Dali
+} // namespace Dali
 
 #endif // DALI_OFFSCREEN_APPLICATION_H