Commit a80917b6 authored by Florent Lamiraux's avatar Florent Lamiraux
Browse files

Enhance documentation.

parent 5a62897d
/// \mainpage
/// \section hppCore_sec_intro Introduction
///
/// This package implements path planning algorithms for kinematic chains. Kinematic
/// chains are represented by class hpp::model::Device.
/// This package implements path planning algorithms for kinematic chains.
/// Kinematic chains are represented by class hpp::model::Device.
///
/// The main classes are:
/// \li hpp::core::Problem: defines a canonical path planning problem,
......
......@@ -29,11 +29,10 @@ namespace hpp {
namespace core {
/// Defines a path planning problem for one robot.
/// A path planning problem is defined by
/// \li a robot: instance of class Device,
/// \li a set of obstacles: a list of CollisionObject,
/// \li a robot: instance of class hpp::model::Device,
/// \li a set of obstacles: a list of hpp::model::CollisionObject,
/// \li initial and goal configurations,
/// \li a steering method to handle the robot dynamics,
/// \li a path planner
/// \li a SteeringMethod to handle the robot dynamics,
class HPP_CORE_DLLAPI Problem
{
public:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment