[doc] Add path planner algorightms in path planner module.

humanoid-path-planner · Nov 26, 2024 · f31c378 · f31c378
1 parent fdaa8ec
commit f31c378
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/include/hpp/core/path-planner/bi-rrt-star.hh b/include/hpp/core/path-planner/bi-rrt-star.hh
@@ -38,6 +38,9 @@ namespace pathPlanner {
 HPP_PREDEF_CLASS(BiRrtStar);
 typedef shared_ptr<BiRrtStar> BiRrtStarPtr_t;
 
+/// \addtogroup path_planning
+/// \{
+
 /// Bi-RRT* path planning algorithm
 /// as described in http://www.golems.org/papers/AkgunIROS11-sampling.pdf
 class HPP_CORE_DLLAPI BiRrtStar : public PathPlanner {
@@ -111,6 +114,9 @@ class HPP_CORE_DLLAPI BiRrtStar : public PathPlanner {
   /// Weak pointer to itself
   BiRrtStarWkPtr_t weak_;
 };  // class BiRrtStar
+
+/// \}
+
 }  // namespace pathPlanner
 }  // namespace core
 }  // namespace hpp

diff --git a/include/hpp/core/path-planner/k-prm-star.hh b/include/hpp/core/path-planner/k-prm-star.hh
@@ -35,6 +35,10 @@
 namespace hpp {
 namespace core {
 namespace pathPlanner {
+
+/// \addtogroup path_planning
+/// \{
+
 /// k-PRM* path planning algorithm
 /// as described in https://arxiv.org/pdf/1105.1186.pdf.
 class HPP_CORE_DLLAPI kPrmStar : public PathPlanner {
@@ -107,6 +111,9 @@ class HPP_CORE_DLLAPI kPrmStar : public PathPlanner {
   /// Weak pointer to itself
   kPrmStarWkPtr_t weak_;
 };  // class kPrmStar
+
+/// \}
+
 }  // namespace pathPlanner
 }  // namespace core
 }  // namespace hpp