From 17d0acabd30358ac1f3edf7664833e38ca7dc8f4 Mon Sep 17 00:00:00 2001 From: Mirko Waechter <waechter@kit.edu> Date: Mon, 2 Mar 2015 01:29:25 +0100 Subject: [PATCH] doc --- etc/doxygen/pages/5.Components.dox | 4 ++++ source/RobotAPI/components/DebugDrawer/DebugDrawerComponent.h | 2 +- source/RobotAPI/components/MMMPlayer/MMMPlayer.h | 2 +- .../WeissHapticSensorListener/WeissHapticSensorListener.h | 2 +- source/RobotAPI/components/robotstate/RobotStateComponent.h | 2 +- 5 files changed, 8 insertions(+), 4 deletions(-) diff --git a/etc/doxygen/pages/5.Components.dox b/etc/doxygen/pages/5.Components.dox index d99251036..46eac4e8e 100644 --- a/etc/doxygen/pages/5.Components.dox +++ b/etc/doxygen/pages/5.Components.dox @@ -1,8 +1,12 @@ /** \addtogroup Components 5. Components +Components are the main building blocks of ArmarX and offer services for other applications via Ice. +Each component usually implements one Ice interface by which it offers its services. +They can be configured with \ref armarx-componentproperties via config files. \defgroup RobotAPI-Components RobotAPI Components \ingroup RobotAPI Components +Robot related components like RobotStateComponent ... */ diff --git a/source/RobotAPI/components/DebugDrawer/DebugDrawerComponent.h b/source/RobotAPI/components/DebugDrawer/DebugDrawerComponent.h index 7b734202a..9240ae7e3 100644 --- a/source/RobotAPI/components/DebugDrawer/DebugDrawerComponent.h +++ b/source/RobotAPI/components/DebugDrawer/DebugDrawerComponent.h @@ -65,7 +65,7 @@ public: /*! \class DebugDrawerComponent - \ingroup Components + \ingroup RobotAPI-Components * \brief The DebugDrawerComponent class implements a component that listens to layered / debug drawer commands and creates internal representations of the visualization * which can be conveniently used by gui components to visualize the content. * diff --git a/source/RobotAPI/components/MMMPlayer/MMMPlayer.h b/source/RobotAPI/components/MMMPlayer/MMMPlayer.h index 9d72efcc6..f333e4769 100644 --- a/source/RobotAPI/components/MMMPlayer/MMMPlayer.h +++ b/source/RobotAPI/components/MMMPlayer/MMMPlayer.h @@ -78,7 +78,7 @@ namespace armarx /** * @class MMMPlayer - * @ingroup Components + * @ingroup RobotAPI-Components * @brief A brief description * * Detailed Description diff --git a/source/RobotAPI/components/WeissHapticSensorListener/WeissHapticSensorListener.h b/source/RobotAPI/components/WeissHapticSensorListener/WeissHapticSensorListener.h index a6570fc94..2a1501e57 100644 --- a/source/RobotAPI/components/WeissHapticSensorListener/WeissHapticSensorListener.h +++ b/source/RobotAPI/components/WeissHapticSensorListener/WeissHapticSensorListener.h @@ -52,7 +52,7 @@ namespace armarx /** * @class WeissHapticSensorListener - * @ingroup Components + * @ingroup RobotAPI-Components * @brief A brief description * * Detailed Description diff --git a/source/RobotAPI/components/robotstate/RobotStateComponent.h b/source/RobotAPI/components/robotstate/RobotStateComponent.h index 8d46f163a..80d9ec37b 100644 --- a/source/RobotAPI/components/robotstate/RobotStateComponent.h +++ b/source/RobotAPI/components/robotstate/RobotStateComponent.h @@ -57,7 +57,7 @@ namespace armarx /** * @class RobotStateComponent - * @ingroup Components + * @ingroup RobotAPI-Components * The RobotStateComponent creates an internal robot representation from * a VirtualRobot (see [Simox](http://simox.sourceforge.net/)) XML file. * Upon request, an Ice proxy to a shared instance of this internal robot -- GitLab