diff --git a/etc/doxygen/pages/GuiPlugins.dox b/etc/doxygen/pages/GuiPlugins.dox index e090dfd4881e183d76f14e84129a755bf50b6597..ccfe2ca1998f1b6902f645cae8c2af9ef38d06b1 100644 --- a/etc/doxygen/pages/GuiPlugins.dox +++ b/etc/doxygen/pages/GuiPlugins.dox @@ -1,31 +1,64 @@ /** \page RobotAPI-GuiPlugins RobotAPI Gui Plugins -The following Gui Plugins are available: +The following Gui Plugins are available in RobotAPI: -\subpage RobotAPI-GuiPlugins-TCPMover -\subpage RobotAPI-GuiPlugins-HandUnitWidget +ArViz (3D Visualization): -\subpage RobotAPI-GuiPlugins-HapticUnitPlugin +\li \subpage RobotAPI-GuiPlugins-ArViz -\subpage RobotAPI-GuiPlugins-KinematicUnitPlugin +\li \subpage RobotAPI-GuiPlugins-ArVizDrawerGui -\subpage RobotAPI-GuiPlugins-PlatformUnitPlugin +Memory System: -\subpage RobotAPI-GuiPlugins-RobotViewerPlugin +\li \subpage RobotAPI-GuiPlugins-ArMemMemoryViewer -\subpage RobotAPI-GuiPlugins-ViewSelection -\subpage ArmarXGui-GuiPlugins-DebugDrawerViewer +Controlling and Visualizing the Robot: -\subpage ArmarXGui-GuiPlugins-LaserScannerPlugin +\li \subpage RobotAPI-GuiPlugins-HandUnitWidget -\subpage ArmarXGui-GuiPlugins-HomogeneousMatrixCalculator +\li \subpage RobotAPI-GuiPlugins-KinematicUnitPlugin -\subpage ArmarXGui-GuiPlugins-RobotUnitPlugin +\li \subpage RobotAPI-GuiPlugins-PlatformUnitPlugin -\subpage ArmarXGui-GuiPlugins-GuiHealthClient +\li \subpage RobotAPI-GuiPlugins-RobotViewerPlugin + +\li \subpage RobotAPI-GuiPlugins-RobotUnitPlugin + +\li \subpage RobotAPI-GuiPlugins-TCPMover + + +Miscellaneous: + +\li \subpage RobotAPI-GuiPlugins-BoxToGraspCandidates + +\li \subpage RobotAPI-GuiPlugins-DebugRobotUnitDataStreaming + +\li \subpage RobotAPI-GuiPlugins-FTSensorCalibrationGui + +\li \subpage RobotAPI-GuiPlugins-GraspCandidateViewer + +\li \subpage RobotAPI-GuiPlugins-GuiHealthClient + +\li \subpage RobotAPI-GuiPlugins-HapticUnitPlugin + +\li \subpage RobotAPI-GuiPlugins-HomogeneousMatrixCalculator + +\li \subpage RobotAPI-GuiPlugins-LaserScannerPlugin + +\li \subpage RobotAPI-GuiPlugins-ObjectPoseGui + +\li \subpage RobotAPI-GuiPlugins-SkillObserverMonitor + +\li \subpage RobotAPI-GuiPlugins-ViewSelection + + +Debug Drawer (deprecated, superseded by ArViz): + +\li \subpage RobotAPI-GuiPlugins-DebugDrawerGuiPlugin + +\li \subpage RobotAPI-GuiPlugins-DebugDrawerViewer -\subpage RobotAPI-GuiPlugins-CartesianWaypointControlGui */ diff --git a/source/RobotAPI/gui-plugins/ArMemMemoryViewer/ArMemMemoryViewerWidgetController.h b/source/RobotAPI/gui-plugins/ArMemMemoryViewer/ArMemMemoryViewerWidgetController.h index ccb06e18a3cfafb185c257e9f6e33da8d07dd508..dc6789843bc3d079051591c6af992f26835084d0 100644 --- a/source/RobotAPI/gui-plugins/ArMemMemoryViewer/ArMemMemoryViewerWidgetController.h +++ b/source/RobotAPI/gui-plugins/ArMemMemoryViewer/ArMemMemoryViewerWidgetController.h @@ -42,6 +42,7 @@ namespace armarx * @brief The ArMemMemoryViewer allows visualizing ... * @image html ArMemMemoryViewer.png * The user can + * * API Documentation @ref ArMemMemoryViewerWidgetController * * @see ArMemMemoryViewerGuiPlugin diff --git a/source/RobotAPI/gui-plugins/ArViz/ArVizWidgetController.h b/source/RobotAPI/gui-plugins/ArViz/ArVizWidgetController.h index 2dd295afccc97080bea8e7d4a7dc222324fb71d5..cd089f6c83760e161f4095aaf4b132093100f78f 100644 --- a/source/RobotAPI/gui-plugins/ArViz/ArVizWidgetController.h +++ b/source/RobotAPI/gui-plugins/ArViz/ArVizWidgetController.h @@ -51,7 +51,7 @@ namespace armarx /** - \page ArmarXGui-GuiPlugins-ArViz ArViz + \page RobotAPI-GuiPlugins-ArViz ArViz \brief The ArViz allows visualizing ... \image html ArViz.png diff --git a/source/RobotAPI/gui-plugins/BoxToGraspCandidates/BoxToGraspCandidatesWidgetController.h b/source/RobotAPI/gui-plugins/BoxToGraspCandidates/BoxToGraspCandidatesWidgetController.h index be3ae8e5ed07ae535958ad80fd74c8343b29e3f4..4a74933b2dec8300cc88109b760effaee7ded3c6 100644 --- a/source/RobotAPI/gui-plugins/BoxToGraspCandidates/BoxToGraspCandidatesWidgetController.h +++ b/source/RobotAPI/gui-plugins/BoxToGraspCandidates/BoxToGraspCandidatesWidgetController.h @@ -38,7 +38,7 @@ namespace armarx { /** - \page ARCHES-GuiPlugins-BoxToGraspCandidates BoxToGraspCandidates + \page RobotAPI-GuiPlugins-BoxToGraspCandidates BoxToGraspCandidates \brief The BoxToGraspCandidates allows visualizing ... \image html BoxToGraspCandidates.png diff --git a/source/RobotAPI/gui-plugins/DebugDrawerViewer/DebugDrawerViewerWidgetController.h b/source/RobotAPI/gui-plugins/DebugDrawerViewer/DebugDrawerViewerWidgetController.h index b8c58435fb792f97ef8ae3f88c518bb10fd407c2..ac525eccf6f521bce1b4a5d0554b0fe13661d828 100644 --- a/source/RobotAPI/gui-plugins/DebugDrawerViewer/DebugDrawerViewerWidgetController.h +++ b/source/RobotAPI/gui-plugins/DebugDrawerViewer/DebugDrawerViewerWidgetController.h @@ -35,7 +35,7 @@ namespace armarx { /** - \page ArmarXGui-GuiPlugins-DebugDrawerViewer DebugDrawerViewer + \page RobotAPI-GuiPlugins-DebugDrawerViewer DebugDrawerViewer \brief The DebugDrawerViewer listens on the DebugDrawer topic and visualizes all incoming data. This GUI only displays the DebugDrawer content and nothing else. The content is shown in the 3D Viewer Widget. diff --git a/source/RobotAPI/gui-plugins/GuiHealthClient/GuiHealthClientWidgetController.h b/source/RobotAPI/gui-plugins/GuiHealthClient/GuiHealthClientWidgetController.h index 38448ece1e1fe342fec02b2b7fc0016c61174109..0fed7c1ae22ad51714624a49388e8fec87a2967d 100644 --- a/source/RobotAPI/gui-plugins/GuiHealthClient/GuiHealthClientWidgetController.h +++ b/source/RobotAPI/gui-plugins/GuiHealthClient/GuiHealthClientWidgetController.h @@ -35,7 +35,7 @@ namespace armarx { /** - \page ArmarXGui-GuiPlugins-GuiHealthClient GuiHealthClient + \page RobotAPI-GuiPlugins-GuiHealthClient GuiHealthClient \brief The GuiHealthClient allows visualizing ... \image html GuiHealthClient.png diff --git a/source/RobotAPI/gui-plugins/HomogeneousMatrixCalculator/HomogeneousMatrixCalculatorWidgetController.h b/source/RobotAPI/gui-plugins/HomogeneousMatrixCalculator/HomogeneousMatrixCalculatorWidgetController.h index 8c726c50144ee12b5b1b31e2bfeacd77f8cafa20..104d0c89be3ff4f5a95511233efaad942330b1a4 100644 --- a/source/RobotAPI/gui-plugins/HomogeneousMatrixCalculator/HomogeneousMatrixCalculatorWidgetController.h +++ b/source/RobotAPI/gui-plugins/HomogeneousMatrixCalculator/HomogeneousMatrixCalculatorWidgetController.h @@ -34,7 +34,7 @@ namespace armarx { /** - \page ArmarXGui-GuiPlugins-HomogeneousMatrixCalculator HomogeneousMatrixCalculator + \page RobotAPI-GuiPlugins-HomogeneousMatrixCalculator HomogeneousMatrixCalculator \brief The HomogeneousMatrixCalculator allows visualizing ... \image html HomogeneousMatrixCalculator.png diff --git a/source/RobotAPI/gui-plugins/LaserScannerPlugin/LaserScannerPluginWidgetController.h b/source/RobotAPI/gui-plugins/LaserScannerPlugin/LaserScannerPluginWidgetController.h index 9aca4525b7c91bb801e13f6ec7bca97b8e233561..6d87e4fc65c46a9045e13383bb39b8700d1446d2 100644 --- a/source/RobotAPI/gui-plugins/LaserScannerPlugin/LaserScannerPluginWidgetController.h +++ b/source/RobotAPI/gui-plugins/LaserScannerPlugin/LaserScannerPluginWidgetController.h @@ -36,7 +36,7 @@ namespace armarx { /** - \page ArmarXGui-GuiPlugins-LaserScannerPlugin LaserScannerPlugin + \page RobotAPI-GuiPlugins-LaserScannerPlugin LaserScannerPlugin \brief The LaserScannerPlugin allows visualizing the raw sensor data captured from multiple laser scanners. API Documentation \ref LaserScannerPluginWidgetController diff --git a/source/RobotAPI/gui-plugins/RobotUnitPlugin/RobotUnitPlugin/RobotUnitPluginWidgetController.h b/source/RobotAPI/gui-plugins/RobotUnitPlugin/RobotUnitPlugin/RobotUnitPluginWidgetController.h index d1111ffa0913679ff35361e5ca8f5160123f7eff..00cd3a3c99457ca041155765cf9de83cbe3dd583 100644 --- a/source/RobotAPI/gui-plugins/RobotUnitPlugin/RobotUnitPlugin/RobotUnitPluginWidgetController.h +++ b/source/RobotAPI/gui-plugins/RobotUnitPlugin/RobotUnitPlugin/RobotUnitPluginWidgetController.h @@ -56,7 +56,7 @@ namespace armarx { /** - \page ArmarXGui-GuiPlugins-RobotUnitPlugin RobotUnitPlugin + \page RobotAPI-GuiPlugins-RobotUnitPlugin RobotUnitPlugin \brief The RobotUnitPlugin allows visualizing ... \image html RobotUnitPlugin.png