Enhance documentation

  - classes are now distributed into modules for clarity.

doc/main.hh

@@ -46,3 +46,4 @@ namespace hpp {
     }
   }
 }
+

include/hpp/manipulation/graph-path-validation.hh

@@ -36,6 +36,9 @@ namespace hpp {
     using hpp::core::PathVectorPtr_t;
     using graph::GraphPtr_t;
 
+    /// \addtogroup validation
+    /// \{
+
     /// Path validation for a constraint graph
     ///
     /// This class encapsulates another path validation class.
@@ -117,6 +120,7 @@ namespace hpp {
     {
       return GraphPathValidation::create (T::create (robot, stepSize));
     }
+    /// \}
   } // namespace manipulation
 } // namespace hpp
 

include/hpp/manipulation/graph-steering-method.hh

@@ -28,6 +28,8 @@ namespace hpp {
   namespace manipulation {
     using core::SteeringMethod;
     using core::PathPtr_t;
+    /// \addtogroup steering_method
+    /// \{
 
     class HPP_MANIPULATION_DLLAPI GraphSteeringMethod : public SteeringMethod
     {
@@ -64,6 +66,7 @@ namespace hpp {
         /// Metric in configuration space.
         core::WeighedDistancePtr_t distance_;
     };
+    /// \}
   } // namespace manipulation
 } // namespace hpp
 

include/hpp/manipulation/manipulation-planner.hh

@@ -33,7 +33,11 @@
 
 namespace hpp {
   namespace manipulation {
-    class HPP_MANIPULATION_DLLAPI ManipulationPlanner : public hpp::core::PathPlanner
+    /// \addtogroup path_planning
+    /// \{
+
+    class HPP_MANIPULATION_DLLAPI ManipulationPlanner :
+      public hpp::core::PathPlanner
     {
       public:
         /// Create an instance and return a shared pointer to the instance
@@ -114,6 +118,7 @@ namespace hpp {
 
         mutable Configuration_t qProj_;
     };
+    /// \}
   } // namespace manipulation
 } // namespace hpp
 

include/hpp/manipulation/problem.hh

@@ -27,6 +27,9 @@
 
 namespace hpp {
   namespace manipulation {
+    /// \addtogroup path_planning
+    /// \{
+
     class HPP_MANIPULATION_DLLAPI Problem : public core::Problem
     {
       public:
@@ -83,7 +86,8 @@ namespace hpp {
         graph::GraphPtr_t graph_;
         /// Steering method
         GraphSteeringMethodPtr_t steeringMethod_;
-    };
+    }; // class Problem
+    /// \}
   } // namespace manipulation
 } // namespace hpp
 

include/hpp/manipulation/roadmap.hh

@@ -25,6 +25,9 @@
 
 namespace hpp {
   namespace manipulation {
+    /// \addtogroup roadmap
+    /// \{
+
     /// Extension of hpp::core::Roadmap. It adds the ability of doing
     /// statistics on the graph
     class HPP_MANIPULATION_DLLAPI Roadmap : public core::Roadmap
@@ -64,6 +67,7 @@ namespace hpp {
         /// There should be one histogram per foliation.
         Histograms histograms_;
     };
+    /// \}
   } // namespace manipulation
 } // namespace hpp