Revert "[3.0] Exclude internal tag module in Public API reference"

[platform/core/uifw/dali-core.git] / dali / public-api / actors / actor.h

diff --git a/dali/public-api/actors/actor.h b/dali/public-api/actors/actor.h
index 1040218..cbd4d8c 100644 (file)
--- a/dali/public-api/actors/actor.h
+++ b/dali/public-api/actors/actor.h
@@ -147,7 +147,13 @@ typedef Rect<float> Padding;      ///< Padding definition @SINCE_1_0.0
  *
  *     Hit Priority of above Actor tree (all overlays): 1 - Lowest. 6 - Highest.
  *     @endcode
- *     For more information, see SetDrawMode().
+ *   - Stencil Actors can be used to influence the result of hits on renderable actors within a layer.
+ *     If a Stencil Actor exists on a layer and that Actor is marked visible then a successful
+ *     hit on a renderable actor can only take place in the area that the stencil Actor marks as visible.
+ *     The hit can be in any Stencil Actor in that layer, but must be in the region of one of them.
+ *     Stencil Actor inheritance behaves as with rendering in that any child of a Stencil Actor will
+ *     also be considered a Stencil Actor.
+ *     Non-renderable actors can be hit regardless of whether a stencil actor is hit or not.
  *
  * <i>Touch or hover Event Delivery:</i>
  *
@@ -301,7 +307,8 @@ public:
       PADDING,                                            ///< name "padding",               type Vector4 @SINCE_1_0.0
       MINIMUM_SIZE,                                       ///< name "minimumSize",           type Vector2 @SINCE_1_0.0
       MAXIMUM_SIZE,                                       ///< name "maximumSize",           type Vector2 @SINCE_1_0.0
-      INHERIT_POSITION,                                   ///< name "inheritPosition", type bool @SINCE_1_1.24
+      INHERIT_POSITION,                                   ///< name "inheritPosition",       type bool @SINCE_1_1.24
+      BATCH_PARENT,                                       ///< name "batchParent",           type bool @SINCE_1_2.0
     };
   };
 
@@ -1553,7 +1560,6 @@ public: // Signals
 public: // Not intended for application developers
 
   /**
-   * @internal
    * @brief This constructor is used by Actor::New() methods.
    *
    * @SINCE_1_0.0
@@ -1563,7 +1569,6 @@ public: // Not intended for application developers
 };
 
 /**
- * @internal
  * @brief Helper for discarding an actor handle.
  *
  * If the handle is empty, this method does nothing.  Otherwise