Skip to content
Snippets Groups Projects
Commit 7b9464a4 authored by Mirko Wächter's avatar Mirko Wächter
Browse files

component doc

parent 8a7a98d1
No related branches found
No related tags found
No related merge requests found
......@@ -92,8 +92,7 @@ namespace armarx
};
/**
* @class DMPComponent
*
* @defgroup Component-DMPComponent DMPComponent
* @ingroup RobotComponents-Components
* @brief A brief description
*
......@@ -102,6 +101,10 @@ namespace armarx
*/
/**
* @ingroup Component-DMPComponent
* @brief The DMPComponent class
*/
class DMPComponent :
virtual public Component,
virtual public DMPComponentBase
......
......@@ -79,7 +79,7 @@ namespace armarx
};
/**
* \class MMMPlayer
* \defgroup Component-MMMPlayer MMMPlayer
* \ingroup RobotComponents-Components
* \brief Replays an MMM trajectory from a file.
*
......@@ -87,6 +87,11 @@ namespace armarx
* The trajectory can be replayed using position control or velocity control.
* In the latter case, the control parameters (P, I, D) can be configured via component properties.
*/
/**
* @ingroup Component-MMMPlayer
* @brief The MMMPlayer class
*/
class MMMPlayer :
virtual public armarx::Component,
public KinematicUnitListener
......
......@@ -27,6 +27,7 @@
namespace armarx
{
/**
* @defgroup Component-AStarPathPlanner AStarPathPlanner
* @brief The AStarPathPlanner provides path planning using the A* algorithm.
*
*
......@@ -43,6 +44,11 @@ namespace armarx
*
* @ingroup RobotComponents-Components
*/
/**
* @ingroup Component-AStarPathPlanner
* @brief The AStarPathPlanner class
*/
class AStarPathPlanner:
virtual public PathPlanner,
virtual public AStarPathPlannerBase
......
......@@ -57,13 +57,19 @@ namespace armarx
/**
* @defgroup Component-PathPlanner PathPlanner
* @ingroup RobotComponents-Components
* @brief Abstract base class for path planners.
* This class offers basic methods for planning paths in the plane.
* A path consists of a sequence of 3D vectors containing position (mm) and orientation around the z axis (rad).
* In addition object and agent management is implemented here.
*
* A reference implementation of the A* path planner can be found here: \ref armarx::AStarPathPlanner
* @ingroup RobotComponents-Components
*/
/**
* @ingroup Component-PathPlanner
* @brief The PathPlanner class
*/
class PathPlanner:
virtual public Component,
......
......@@ -59,7 +59,7 @@ namespace armarx
/**
* \class RobotIK
* \defgroup Component-RobotIK RobotIK
* \ingroup RobotComponents-Components
* \brief Provides IK solving methods from VirtualRobot (see [Simox](http://simox.sourceforge.net/)).
*
......@@ -108,6 +108,11 @@ namespace armarx
* Also see [Simox-Tutorial] (http://sourceforge.net/p/simox/wiki/VirtualRobot/) for more information
* of how to use Simox for IK solving.
*/
/**
* @ingroup Component-RobotIK
* @brief Refer to \ref Component-RobotIK
*/
class ARMARXCOMPONENT_IMPORT_EXPORT RobotIK :
virtual public Component,
virtual public RobotIKInterface
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment