Skip to content
Snippets Groups Projects
Commit f67dd468 authored by Manfred Kröhnert's avatar Manfred Kröhnert
Browse files

doc: adapt to new doc structure

parent 2b5d8cca
No related branches found
No related tags found
No related merge requests found
/**
\mainpage
\li \subpage RobotAPI-Overview "RobotAPI Overview"
\li \subpage RobotAPI-Installation "RobotAPI Installation"
\li \subpage RobotAPI-Tutorials "RobotAPI Tutorials"
\li \subpage RobotAPI-HowTos "RobotAPI Howtos"
\li \subpage RobotAPI-FAQ "RobotAPI FAQ"
\li \subpage RobotAPI-Components "RobotAPI Components"
\li \subpage RobotAPI-GuiPlugins "RobotAPI Gui Plugins"
\li \subpage RobotAPI-About "RobotAPI About"
\li \subpage RobotAPI-License "RobotAPI License"
*/
/**
\defgroup RobotAPI RobotAPI Overview
\page RobotAPI-Overview RobotAPI Overview
\brief The RobotAPI package provides a robot-intependent API that other ArmarX packages can use for accessing central functionality of a robot.
......
......@@ -2,10 +2,7 @@
\cond DOXYGEN_EXCLUDE
TODO: Uncomment once tutorials are available
\addtogroup Tutorials 2. Tutorials
\defgroup RobotAPI-Tutorials RobotAPI Tutorials
\ingroup RobotAPI Tutorials
\page RobotAPI-Tutorials RobotAPI Tutorials
Tutorials related to RobotAPI
\endcond
......
/**
\addtogroup HowTos 3. HowTos
\defgroup RobotAPI-HowTos RobotAPI HowTos
\ingroup RobotAPI HowTos
\page RobotAPI-HowTos RobotAPI HowTos
\brief  
\page RobotAPI-HowTos-Eigen-From-Pose How to convert a pose variants to an Eigen matrices
\ingroup RobotAPI-HowTos
\section RobotAPI-HowTos-Eigen-From-Pose How to convert a pose variants to an Eigen matrices
Use the following code if you want to convert from an armarx::Pose, an armarx::FramedPose or an armarx::LinkedPose.
Refer to \ref RobotAPI-FramedPose for further information.
......@@ -29,8 +25,7 @@ Refer to \ref RobotAPI-FramedPose for further information.
\page RobotAPI-HowTos-Eigen-From-PosOrient How to convert position and orientation variants to an Eigen matrices
\ingroup RobotAPI-HowTos
\section RobotAPI-HowTos-Eigen-From-PosOrient How to convert position and orientation variants to an Eigen matrices
Use the following code if you want to convert from armarx::FramedPosition and armarx::FramedOrientation.
Refer to \ref RobotAPI-FramedPose for further information.
......@@ -52,15 +47,14 @@ Refer to \ref RobotAPI-FramedPose for further information.
\page RobotAPI-HowTos-Change-Pose-Frame How to change a frame of a coordinate/pose
\ingroup RobotAPI-HowTos
\section RobotAPI-HowTos-Change-Pose-Frame How to change a frame of a coordinate/pose
Refer to \ref RobotAPI-FramedPose.
\page RobotAPI-HowTos-RemoteRobot-Start How to start a RobotStateComponent
\ingroup RobotAPI-HowTos
\section RobotAPI-HowTos-RemoteRobot-Start How to start a RobotStateComponent
The RobotState component serves as a central component for storing all robot related data. For now this data covers the current joint angles of the robot.<br>
The RobotStateComponent implements a KinematicUnitListener, hence it reacts on all joint updates that are reported by a KinematicUnit component. An exemplary startup script could look like this
......@@ -91,8 +85,7 @@ With the corresponding configuration in ./config/Armar3Config.cfg:
\page RobotAPI-HowTos-RemoteRobot-Access How to access a RobotStateComponent
\ingroup RobotAPI-HowTos
\section RobotAPI-HowTos-RemoteRobot-Access How to access a RobotStateComponent
The RobotStateComponent provides several methods for accessing the current configuration of the robot and for getting a snapshot of the current state which is compatible with
models of the Simox/VirtualRobot framework. With these models the whole functionality of Simox (http://simox.sf.net) can be used, e.g. IK solving, collision detection or motion and grasp planning.
......
......@@ -2,9 +2,6 @@
\cond DOXYGEN_EXCLUDE
TODO: Uncomment once FAQ is available
\addtogroup FAQ 4. FAQ
\defgroup RobotAPI-FAQ RobotAPI FAQ
\ingroup RobotAPI FAQ
\page RobotAPI-FAQ RobotAPI FAQ
\endcond
*/
/**
\mainpage
\ref RobotAPI "RobotAPI Overview"
*/
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