Updated CAPI documentation style

[platform/core/uifw/dali-toolkit.git] / capi / dali-toolkit / public-api / shader-effects / page-turn-book-spine-effect.h

diff --git a/capi/dali-toolkit/public-api/shader-effects/page-turn-book-spine-effect.h b/capi/dali-toolkit/public-api/shader-effects/page-turn-book-spine-effect.h
index 72330bf..0fcece0 100644 (file)
--- a/capi/dali-toolkit/public-api/shader-effects/page-turn-book-spine-effect.h
+++ b/capi/dali-toolkit/public-api/shader-effects/page-turn-book-spine-effect.h
@@ -18,7 +18,7 @@
 //
 
 /**
- * @addtogroup CAPI_DALI_FRAMEWORK
+ * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
  * @{
  */
 
@@ -31,52 +31,62 @@ namespace Dali DALI_IMPORT_API
 namespace Toolkit
 {
 /**
- * It is an assisting effect of PageTurnEffect to display book spine on STATIC pages, and also flip the image horizontally when needed.
- * When the page is turned over in landscape, call SetIsBackImageVisible(true), this effect can display the back image correctly after the imageActor been rotated 180 degrees.
- * To display the pages visually consistent with its turning state, please set the uniforms with the same values as the PageTurnEffect
+ * @brief This is an assisting effect of PageTurnEffect to display a book spine on _static_ pages, and also to flip the image horizontally when needed.
+ *
+ * When the page is turned over in landscape, call
+ * SetIsBackImageVisible(true), this effect can display the back image
+ * correctly after the imageActor been rotated 180 degrees.  To
+ * display the pages visually consistent with its turning state,
+ * please set the uniforms with the same values as the PageTurnEffect.
  **/
 class PageTurnBookSpineEffect : public ShaderEffect
 {
 public:
   /**
-   * Create an uninitialized PageTurnBookSpineEffect; this can be initialized with PageTurnBookSpineEffect::New()
+   * @brief Create an uninitialized PageTurnBookSpineEffect; this can be initialized with PageTurnBookSpineEffect::New().
+   *
    * Calling member functions with an uninitialized Dali::Object is not allowed.
    */
   PageTurnBookSpineEffect();
 
   /**
-   * Virtual destructor.
+   * @brief Virtual destructor.
    */
   virtual ~PageTurnBookSpineEffect();
 
   /**
-   * Create an initialized PageTurnBookSpineEffect.
+   * @brief Create an initialized PageTurnBookSpineEffect.
+   *
    * @return A handle to a newly allocated Dali resource.
    */
   static PageTurnBookSpineEffect New();
 
   /**
-   * Set whether the current page is with its backside visible
+   * @brief Set whether the current page is with its backside visible.
+   *
    * Need to pass the parameter as true for the page which is turned over but still visible in Landscape
    * @param [in] isBackVisible True for page with its backside upwards
    */
   void SetIsBackImageVisible( bool isBackVisible );
 
   /**
-   * Set the page width of the PageTurnBookSpineEffect.
+   * @brief Set the page width of the PageTurnBookSpineEffect.
+   *
    * @param [in] pageWidth The width of the page size.
    */
   void SetPageWidth( float pageWidth );
 
   /**
-   * Set the width of shadow to be pageSize * shadowWidth
+   * @brief Set the width of shadow to be pageSize * shadowWidth.
+   *
    * this shadow appears at the edges of the actor which is not visible on static pages
    * @param [in] shadowWidth The width for the simulated shadow
    */
   void SetShadowWidth( float shadowWidth );
 
   /**
-   * Set the spine shadow parameter
+   * @brief Set the spine shadow parameter.
+   *
    * The two parameters are the major&minor radius (in pixels) to form an ellipse shape
    * The top-left quarter of this ellipse is used to calculate spine normal for simulating shadow
    * @param [in] spineShadowParameter The major&minor ellipse radius for the simulated spine shadow