Merge branch 'devel/master' into tizen

[platform/core/uifw/dali-toolkit.git] / dali-scene3d / public-api / algorithm / path-finder-waypoint.h

diff --git a/dali-scene3d/public-api/algorithm/path-finder-waypoint.h b/dali-scene3d/public-api/algorithm/path-finder-waypoint.h
index 201783c..dd14e59 100644 (file)
--- a/dali-scene3d/public-api/algorithm/path-finder-waypoint.h
+++ b/dali-scene3d/public-api/algorithm/path-finder-waypoint.h
@@ -17,9 +17,6 @@
  *  limitations under the License.
  */
 
-// INTERNAL INCLUDES
-#include <dali-scene3d/public-api/api.h>
-
 // EXTERNAL INCLUDES
 #include <dali/public-api/math/vector2.h>
 #include <dali/public-api/math/vector3.h>
@@ -27,9 +24,12 @@
 #include <cinttypes>
 #include <memory>
 
+// INTERNAL INCLUDES
+#include <dali-scene3d/public-api/api.h>
+
 namespace Dali::Scene3D::Internal::Algorithm
 {
-class WayPointData;
+struct WayPointData;
 }
 
 namespace Dali::Scene3D::Algorithm
@@ -38,18 +38,20 @@ namespace Dali::Scene3D::Algorithm
  * @class WayPoint
  *
  * The class represents a public interface to the WayPoint object
+ * @SINCE_2_2.12
  */
 class DALI_SCENE3D_API WayPoint
 {
 public:
-
   /**
    * @brief Constructor
+   * @SINCE_2_2.12
    */
   WayPoint();
 
   /**
    * @brief Destructor
+   * @SINCE_2_2.12
    */
   ~WayPoint();
 
@@ -59,6 +61,7 @@ public:
    * Function returns index of face withing the NavigationMesh
    * that the waypoint is associated with.
    *
+   * @SINCE_2_2.12
    * @return Valid index of the face
    */
   [[nodiscard]] uint32_t GetNavigationMeshFaceIndex() const;
@@ -69,6 +72,7 @@ public:
    * The face space uses the face barycentre as an origin. The x-axis is
    * aligned with x-axis of the NavigationMesh.
    *
+   * @SINCE_2_2.12
    * @return Valid 2D location vector
    */
   [[nodiscard]] Dali::Vector2 GetFaceLocalSpacePosition() const;
@@ -80,6 +84,7 @@ public:
    * of associated NavigationMesh object (using transformation set with
    * NavigationMesh::SetSceneTransform()).
    *
+   * @SINCE_2_2.12
    * @return Valid 3D location vector
    */
   [[nodiscard]] Dali::Vector3 GetScenePosition() const;
@@ -88,6 +93,7 @@ public:
    * @brief Copy constructor
    *
    * Only copy semantics is allowed on the WayPoint object
+   * @SINCE_2_2.12
    */
   WayPoint(const WayPoint&);
 
@@ -96,19 +102,17 @@ public:
    *
    * Only copy semantics is allowed on the WayPoint object
    *
+   * @SINCE_2_2.12
    * @return Copy of source object
    */
   WayPoint& operator=(const WayPoint&);
 
 private:
-
   std::unique_ptr<Internal::Algorithm::WayPointData> mImpl;
 
 public:
-
   DALI_INTERNAL operator Internal::Algorithm::WayPointData&();
-
 };
-}
+} // namespace Dali::Scene3D::Algorithm
 
 #endif // DALI_SCENE3D_PATH_FINDER_WAYPOINT_H