Tizen 2.4 SDK Rev6 Release

[framework/graphics/dali-toolkit.git] / dali-toolkit / public-api / controls / gaussian-blur-view / gaussian-blur-view.h

diff --git a/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h b/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h
index 16487bd..b4b9ae8 100644 (file)
--- a/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h
+++ b/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h
@@ -77,29 +77,29 @@ class BloomView;
  * Usage example:-
  *
  * @code
- *  // initialise\n
- *  GaussianBlurView gaussianBlurView = GaussianBlurView::New();\n
+ *  // Initialise
+ *  GaussianBlurView gaussianBlurView = GaussianBlurView::New();
  *
- *  // create and add some visible actors to the GaussianBlurView, all these child actors will therefore get blurred.\n
- *  Image image = Image::New(...);\n
- *  ImageView imageView = ImageView::New(image);\n
- *  gaussianBlurView.Add(imageView);\n
- *  ...\n
+ *  // Create and add some visible actors to the GaussianBlurView, all these child actors will therefore get blurred.
+ *  Image image = Image::New(...);
+ *  ImageView imageView = ImageView::New(image);
+ *  gaussianBlurView.Add(imageView);
+ *  ...
  *
- *  // Start rendering the GaussianBlurView\n
- *  Stage::GetCurrent().Add(gaussianBlurView);\n
- *  gaussianBlurView.Activate();\n
- *  ...\n
+ *  // Start rendering the GaussianBlurView
+ *  Stage::GetCurrent().Add(gaussianBlurView);
+ *  gaussianBlurView.Activate();
+ *  ...
  *
- *  // animate the strength of the blur - this can fade between no blur and full blur. See GetBlurStrengthPropertyIndex().\n
- *  Animation blurAnimation = Animation::New( ... );\n
- *  blurAnimation.AnimateTo( Property( gaussianBlurView, gaussianBlurView.GetBlurStrengthPropertyIndex() ), ... );\n
- *  blurAnimation.Play();\n
+ *  // Animate the strength of the blur - this can fade between no blur and full blur. See GetBlurStrengthPropertyIndex().
+ *  Animation blurAnimation = Animation::New( ... );
+ *  blurAnimation.AnimateTo( Property( gaussianBlurView, gaussianBlurView.GetBlurStrengthPropertyIndex() ), ... );
+ *  blurAnimation.Play();
  *
- *  ...\n
- *  // Stop rendering the GaussianBlurView\n
- *  Stage::GetCurrent().Remove(gaussianBlurView);\n
- *  gaussianBlurView.Deactivate();\n
+ *  ...
+ *  // Stop rendering the GaussianBlurView
+ *  Stage::GetCurrent().Remove(gaussianBlurView);
+ *  gaussianBlurView.Deactivate();
  * @endcode
  * @since_tizen 2.4
  * @remarks This is an experimental feature and might not be supported in the next release.
@@ -115,20 +115,20 @@ public:
   typedef Signal< void (GaussianBlurView source) > GaussianBlurViewSignal;
 
   /**
-   * @brief Create an uninitialized GaussianBlurView; this can be initialized with GaussianBlurView::New()
+   * @brief Create an uninitialized GaussianBlurView; this can be initialized with GaussianBlurView::New().
    * Calling member functions with an uninitialized Dali::Object is not allowed.
    * @since_tizen 2.4
    */
   GaussianBlurView();
 
   /**
-   * @brief Copy constructor. Creates another handle that points to the same real object
+   * @brief Copy constructor. Creates another handle that points to the same real object.
    * @since_tizen 2.4
    */
   GaussianBlurView(const GaussianBlurView& handle);
 
   /**
-   * @brief Assignment operator. Changes this handle to point to another real object
+   * @brief Assignment operator. Changes this handle to point to another real object.
    * @since_tizen 2.4
    */
   GaussianBlurView& operator=(const GaussianBlurView& ZoomView);
@@ -148,7 +148,7 @@ public:
    * downcast produces valid handle. If not the returned handle is left uninitialized.
    * @since_tizen 2.4
    * @param[in] handle Handle to an object
-   * @return handle to a GaussianBlurView or an uninitialized handle
+   * @return A handle to a GaussianBlurView or an uninitialized handle
    */
   static GaussianBlurView DownCast( BaseHandle handle );
 
@@ -191,7 +191,7 @@ public:
   /**
    * @brief Adds a child Actor to this Actor.
    * @since_tizen 2.4
-   * @param [in] child The child.
+   * @param [in] child The child
    * @pre This Actor (the parent) has been initialized.
    * @pre The child actor has been initialized.
    * @pre The child actor is not the same as the parent actor.
@@ -200,7 +200,7 @@ public:
    * even if the handle passed into this method is reset or destroyed.
    * @note if the child already has a parent, it will be removed from old parent
    * and reparented to this actor. This may change childs position, color, shader effect,
-   * scale etc as it now inherits them from this actor
+   * scale etc as it now inherits them from this actor.
    */
   void Add(Actor child);
 
@@ -209,7 +209,7 @@ public:
    *
    * If the actor was not a child of this actor, this is a no-op.
    * @since_tizen 2.4
-   * @param [in] child The child.
+   * @param [in] child The child
    * @pre This Actor (the parent) has been initialized.
    * @pre The child actor is not the same as the parent actor.
    */
@@ -276,14 +276,14 @@ public:
   /**
   * @brief Set background color for the view. The background will be filled with this color.
   * @since_tizen 2.4
-  * @param[in] color The background color.
+  * @param[in] color The background color
   */
   void SetBackgroundColor( const Vector4& color );
 
   /**
   * @brief Get the background color.
   * @since_tizen 2.4
-  * @return The background color.
+  * @return The background color
   */
   Vector4 GetBackgroundColor() const;
 
@@ -301,14 +301,14 @@ public:
   /**
    * @brief Creates a handle using the Toolkit::Internal implementation.
    * @since_tizen 2.4
-   * @param[in]  implementation  The UI Control implementation.
+   * @param[in]  implementation  The UI Control implementation
    */
   DALI_INTERNAL GaussianBlurView( Internal::GaussianBlurView& implementation );
 
   /**
    * @brief Allows the creation of this UI Control from an Internal::CustomActor pointer.
    * @since_tizen 2.4
-   * @param[in]  internal  A pointer to the internal CustomActor.
+   * @param[in]  internal  A pointer to the internal CustomActor
    */
   DALI_INTERNAL GaussianBlurView( Dali::Internal::CustomActor* internal );