From 662687142c192b01837bde7c572521427ac69b4c Mon Sep 17 00:00:00 2001
From: Rainer Kartmann <rainer.kartmann@kit.edu>
Date: Fri, 26 Nov 2021 15:19:10 +0100
Subject: [PATCH] Cleanup gui plugin doxygen page
---
etc/doxygen/pages/GuiPlugins.dox | 61 ++++++++++++++-----
.../ArMemMemoryViewerWidgetController.h | 1 +
.../gui-plugins/ArViz/ArVizWidgetController.h | 2 +-
.../BoxToGraspCandidatesWidgetController.h | 2 +-
.../DebugDrawerViewerWidgetController.h | 2 +-
.../GuiHealthClientWidgetController.h | 2 +-
...ogeneousMatrixCalculatorWidgetController.h | 2 +-
.../LaserScannerPluginWidgetController.h | 2 +-
.../RobotUnitPluginWidgetController.h | 2 +-
9 files changed, 55 insertions(+), 21 deletions(-)
diff --git a/etc/doxygen/pages/GuiPlugins.dox b/etc/doxygen/pages/GuiPlugins.dox
index e090dfd48..ccfe2ca19 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 ccb06e18a..dc6789843 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 2dd295afc..cd089f6c8 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 be3ae8e5e..4a74933b2 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 b8c58435f..ac525eccf 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 38448ece1..0fed7c1ae 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 8c726c501..104d0c89b 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 9aca4525b..6d87e4fc6 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 d1111ffa0..00cd3a3c9 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
--
GitLab