Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / common / stage.h

diff --git a/dali/public-api/common/stage.h b/dali/public-api/common/stage.h
index 7e1c6ac..84e6940 100644 (file)
--- a/dali/public-api/common/stage.h
+++ b/dali/public-api/common/stage.h
@@ -50,28 +50,18 @@ struct WheelEvent;
  *
  * Multiple stage/window support is not currently provided.
  *
- * Signals
- * | %Signal Name              | Method                               |
- * |---------------------------|--------------------------------------|
- * | key-event                 | @ref KeyEventSignal()                |
- * | event-processing-finished | @ref EventProcessingFinishedSignal() |
- * | touched                   | @ref TouchedSignal()                 |
- * | wheel-event               | @ref WheelEventSignal()              |
- * | context-lost              | @ref ContextLostSignal()             |
- * | context-regained          | @ref ContextRegainedSignal()         |
- * | scene-created             | @ref SceneCreatedSignal()            |
  * @since_tizen 2.4
  */
 class DALI_IMPORT_API Stage : public BaseHandle
 {
 public:
 
-  typedef Signal< void (const KeyEvent&)> KeyEventSignalType;     ///< Key event signal type
-  typedef Signal< void () > EventProcessingFinishedSignalType;    ///< Event Processing finished signal type
-  typedef Signal< void (const TouchEvent&)> TouchedSignalType;    ///< Touched signal type
-  typedef Signal< void (const WheelEvent&)> WheelEventSignalType; ///< Touched signal type
-  typedef Signal< void () > ContextStatusSignal;                  ///< Context status signal type
-  typedef Signal< void () > SceneCreatedSignalType;               ///< Scene created signal type
+  typedef Signal< void (const KeyEvent&)> KeyEventSignalType;     ///< Key event signal type @since_tizen 2.4
+  typedef Signal< void () > EventProcessingFinishedSignalType;    ///< Event Processing finished signal type @since_tizen 2.4
+  typedef Signal< void (const TouchEvent&)> TouchedSignalType;    ///< Touched signal type @since_tizen 2.4
+  typedef Signal< void (const WheelEvent&)> WheelEventSignalType; ///< Touched signal type @since_tizen 2.4
+  typedef Signal< void () > ContextStatusSignal;                  ///< Context status signal type @since_tizen 2.4
+  typedef Signal< void () > SceneCreatedSignalType;               ///< Scene created signal type @since_tizen 2.4
 
   static const Vector4 DEFAULT_BACKGROUND_COLOR; ///< Default black background.
   static const Vector4 DEBUG_BACKGROUND_COLOR;   ///< Green background, useful when debugging.
@@ -88,7 +78,7 @@ public:
    * @brief Get the current Stage.
    *
    * @since_tizen 2.4
-   * @return The current stage or an empty handle if Core has not been created or has been already destroyed.
+   * @return The current stage or an empty handle if the internal core has not been created or has been already destroyed.
    */
   static Stage GetCurrent();
 
@@ -186,7 +176,7 @@ public:
    * @since_tizen 2.4
    * @param[in] depth The depth.
    * @return The layer found at the given depth.
-   * @pre depth is less than layer count; see GetLayerCount().
+   * @pre Depth is less than layer count; see GetLayerCount().
    */
   Layer GetLayer(unsigned int depth) const;
 
@@ -220,7 +210,7 @@ public:
    * @brief Retrieve the DPI of the display device to which the stage is connected.
    *
    * @since_tizen 2.4
-   * @return the horizontal and vertical DPI
+   * @return The horizontal and vertical DPI
    */
   Vector2 GetDpi() const;
 
@@ -240,7 +230,7 @@ public:
    * By default Dali will stop rendering when no Actor positions are being set, and when no animations are running etc.
    * This method is useful to force screen refreshes e.g. when updating a NativeImage.
    * @since_tizen 2.4
-   * @param durationSeconds to keep rendering, 0 means render at least one more frame
+   * @param[i] durationSeconds Time to keep rendering, 0 means render at least one more frame
    */
   void KeepRendering( float durationSeconds );
 
@@ -302,7 +292,7 @@ public:
    * If the application is responsible for handling context loss, it should listen to
    * this signal and tear down UI components when recieved.
    * @since_tizen 2.4
-   * @return The ContextLost signal to connect to.
+   * @return The context lost signal to connect to.
    */
   ContextStatusSignal& ContextLostSignal();
 
@@ -313,12 +303,14 @@ public:
    * If the application is responsible for handling context loss, it should listen to
    * this signal and rebuild UI components on receipt.
    * @since_tizen 2.4
-   * @return The ContextRegained signal to connect to.
+   * @return The context regained signal to connect to.
    */
   ContextStatusSignal& ContextRegainedSignal();
 
   /**
-   * @brief This signal is emitted after the initial scene is created. It will be triggered after the
+   * @brief This signal is emitted after the initial scene is created.
+   *
+   * It will be triggered after the
    * application init signal.
    *
    * A callback of the following type may be connected:
@@ -333,7 +325,7 @@ public:
 public: // Not intended for application developers
 
   /**
-   * @brief This constructor is used by Dali GetCurrent() methods.
+   * @brief This constructor is used by Stage::GetCurrent() methods.
    *
    * @since_tizen 2.4
    * @param [in] stage A pointer to a Dali resource