Updated non-capi public API documentation to new style.

[platform/core/uifw/dali-core.git] / dali / public-api / events / hit-test-algorithm.h

diff --git a/dali/public-api/events/hit-test-algorithm.h b/dali/public-api/events/hit-test-algorithm.h
index 959b968..2043526 100644 (file)
--- a/dali/public-api/events/hit-test-algorithm.h
+++ b/dali/public-api/events/hit-test-algorithm.h
@@ -20,13 +20,14 @@
 #include <dali/public-api/actors/actor.h>
 #include <dali/public-api/common/stage.h>
 
+
 namespace Dali DALI_IMPORT_API
 {
 
 class RenderTask;
 
 /**
- * This namespace is provided for application developers to do hit-test for the actors.
+ * @brief This namespace is provided for application developers to do hit-test for the actors.
  *
  * <h3>Hit Test Algorithm:</h3>
  *
@@ -100,12 +101,18 @@ class RenderTask;
 namespace HitTestAlgorithm
 {
 
+/**
+ * @brief How the actor tree should be traversed.
+ */
 enum TraverseType
 {
   CHECK_ACTOR,            ///< Hit test the given actor.
   DESCEND_ACTOR_TREE      ///< Check whether the actor tree should be descended to hit-test its children.
 };
 
+/**
+ * @brief Results structure containing the hit actor and where it was hit.
+ */
 struct Results
 {
   Actor      actor;            ///< The hit actor.
@@ -113,15 +120,18 @@ struct Results
 };
 
 /**
- * Definition of a hit-test function to use in HitTest() method to check if the actor is hittable (e.g. touchable or focusable).
+ * @brief Definition of a hit-test function to use in HitTest() method to check if the actor is hittable (e.g. touchable or focusable).
+ *
  * @return true, if the actor is hittable, false otherwise.
  */
 typedef bool (*HitTestFunction)(Actor actor, TraverseType type);
 
 /**
- * Given screen coordinates, this method returns the hit actor & the local coordinates relative to
- * the top-left (0.0f, 0.0f, 0.5f) of the actor. An actor is only hittable if the actor meets all the
- * conditions defined by the given function (see HitTestAlgorithm).
+ * @brief Given screen coordinates, this method returns the hit actor & the local coordinates relative to
+ * the top-left (0.0f, 0.0f, 0.5f) of the actor.
+ *
+ * An actor is only hittable if the actor meets all the conditions
+ * defined by the given function (see HitTestAlgorithm).
  *
  * Typically, if an actor has a zero size or its world color is fully transparent, it should not be
  * hittable; and if an actor's visibility flag is unset, its children should not be hittable either.
@@ -134,7 +144,8 @@ typedef bool (*HitTestFunction)(Actor actor, TraverseType type);
 void HitTest( Stage stage, const Vector2& screenCoordinates, Results& results, HitTestFunction func );
 
 /**
- * Hit test specific to a given RenderTask
+ * @brief Hit test specific to a given RenderTask.
+ *
  * @param[in] renderTask The render task for hit test
  * @param[in] screenCoordinates The screen coordinates.
  * @param[out] results The results of the hit-test.