Skip to content
Snippets Groups Projects
Commit 830124c8 authored by Christian Mandery's avatar Christian Mandery
Browse files

Restructure documentation (in progress)

parent 55b09a73
No related branches found
No related tags found
No related merge requests found
/**
\page RobotAPI RobotAPI Overview
The ArmarX project RobotAPI is based on the ArmarXCore Framework.
\par Components
RobotAPI provides the following components
- armarx::ComponentX: ComponentX description
Each component can provide several properties which are set on command line or via a configuration file.
See \ref componentproperties for an overview of properties.
\par Applications
- armarx::ApplicationY: Description of ApplicationY
\par interface Interface Documentation
Documentation of interfaces available in ArmarXCore is available on the \ref slicedocumentation "Slice Documentation" page.
*/
/**
\addtogroup Installation
\defgroup RobotAPI-Installation RobotAPI Installation
\ingroup RobotAPI
\ingroup Installation
RobotAPI depends on ArmarXCore and ArmarXGui which must be installed.
*/
/**
\addtogroup Tutorials
\defgroup RobotAPI-Tutorials RobotAPI Tutorials
\ingroup RobotAPI
\ingroup Tutorials
...
*/
/**
\defgroup remoterobot Robot State and Remote Robot
\ingroup api-robotapi
\page RobotAPI-HowTos-RemoteRobot Robot State and Remote Robot
\ingroup RobotAPI-HowTos
\section remoterobot-start Starting a RobotStateComponent
......
/**
\page robotapi-howtos HowTos
\addtogroup HowTos
\subpage robotapi-howtos-eigen-from-pose
\defgroup RobotAPI-HowTos RobotAPI HowTos
\ingroup RobotAPI
\ingroup HowTos
\page robotapi-howtos-eigen-from-pose How to convert a Variant pose into an Eigen Matrix
\page RobotAPI-HowTos-Eigen-From-Pose How to convert a Variant pose into an Eigen Matrix
\ingroup RobotAPI-HowTos
\code
#include <RobotAPI/libraries/robotstate/remote/ArmarPose.h>
......
/**
\addtogroup FAQ
\defgroup RobotAPI-FAQ RobotAPI FAQ
\ingroup RobotAPI
\ingroup FAQ
...
*/
/**
\addtogroup Components
\defgroup RobotAPI-Components RobotAPI Components
\ingroup RobotAPI
\ingroup Components
...
*/
/**
\defgroup api-robotapi RobotAPI
*/
/*!
* \defgroup robotapi-overview Overview
* \ingroup api-robotapi
*
* The ArmarX project RobotAPI is based on the ArmarXCore Framework.
*
* \par Components
* RobotAPI provides the following components
* - armarx::ComponentX: ComponentX description
*
* Each component can provide several properties which are set on command line or via a configuration file.
* See \ref componentproperties for an overview of properties.
*
* \par Applications
* - armarx::ApplicationY: Description of ApplicationY
*
* \par interface Interface Documentation
* Documentation of interfaces available in ArmarXCore is available on the \ref slicedocumentation "Slice Documentation" page.
*/
/**
\defgroup robotapi-states States
\ingroup api-robotapi
*/
/*! \mainpage
- \subpage robotapi-overview
- \subpage remoterobot
*/
/**
\mainpage
\ref RobotAPI "RobotAPI Overview"
*/
/**
\page robotapi-slicedocumentation Slice Documentation
\ingroup api-robotapi
<a href="slice/index.html"> Slice Documentation </a>
*/
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