From b8045f974cd7416bcad3d9ae7e8c371be96c47d8 Mon Sep 17 00:00:00 2001
From: Peter Kaiser <peter.kaiser@kit.edu>
Date: Thu, 13 Aug 2015 17:10:43 +0200
Subject: [PATCH] Documentation: Rearranged gui plugins
---
etc/doxygen/pages/GuiPlugins.dox | 20 +++++++++++++++++--
etc/doxygen/pages/Overview.dox | 2 +-
etc/doxygen/pages/mainpage.dox | 3 ++-
.../HandUnitPlugin/HandUnitGuiPlugin.h | 5 +----
.../HapticUnitPlugin/HapticUnitGuiPlugin.h | 11 +---------
.../KinematicUnitGuiPlugin.h | 6 ++----
.../PlatformUnitGuiPlugin.h | 4 +---
.../RobotViewerPlugin/RobotViewerGuiPlugin.h | 6 ++----
.../ArmarXPlotter/ArmarXPlotter.h | 2 +-
.../ArmarXTCPMover/TCPMover.h | 6 +++---
10 files changed, 32 insertions(+), 33 deletions(-)
diff --git a/etc/doxygen/pages/GuiPlugins.dox b/etc/doxygen/pages/GuiPlugins.dox
index d04378063..83a4ed213 100644
--- a/etc/doxygen/pages/GuiPlugins.dox
+++ b/etc/doxygen/pages/GuiPlugins.dox
@@ -1,3 +1,19 @@
/**
- * \defgroup RobotAPI-ArmarXGuiPlugins GUI Plugins
- */
+\page RobotAPI-GuiPlugins GUI Plugins
+
+The following Gui Plugins are available:
+
+\subpage RobotAPI-GuiPlugins-ArmarXPlotter
+
+\subpage RobotAPI-GuiPlugins-TCPMover
+
+\subpage RobotAPI-GuiPlugins-HandUnitWidget
+
+\subpage RobotAPI-GuiPlugins-HapticUnitPlugin
+
+\subpage RobotAPI-GuiPlugins-KinematicUnitPlugin
+
+\subpage RobotAPI-GuiPlugins-PlatformUnitPlugin
+
+\subpage RobotAPI-GuiPlugins-RobotViewerPlugin
+*/
diff --git a/etc/doxygen/pages/Overview.dox b/etc/doxygen/pages/Overview.dox
index a976faf4b..5475ae60e 100644
--- a/etc/doxygen/pages/Overview.dox
+++ b/etc/doxygen/pages/Overview.dox
@@ -54,5 +54,5 @@ Available GUI-plugins provide access to the kinematic robot state, end effectors
RobotAPI also provides a GUI-plugin for robot visualization.
\par
-\link RobotAPI-ArmarXGuiPlugins Read more \endlink
+\link RobotAPI-GuiPlugins Read more \endlink
*/
diff --git a/etc/doxygen/pages/mainpage.dox b/etc/doxygen/pages/mainpage.dox
index 9e9610cf5..367b9a764 100644
--- a/etc/doxygen/pages/mainpage.dox
+++ b/etc/doxygen/pages/mainpage.dox
@@ -1,3 +1,4 @@
+/**
\mainpage
RobotAPI description
@@ -11,4 +12,4 @@ RobotAPI description
\li \subpage RobotAPI-GuiPlugins "RobotAPI Gui Plugins"
\li \subpage RobotAPI-About "RobotAPI About"
\li \subpage RobotAPI-License "RobotAPI License"
-
+*/
diff --git a/source/RobotAPI/gui-plugins/HandUnitPlugin/HandUnitGuiPlugin.h b/source/RobotAPI/gui-plugins/HandUnitPlugin/HandUnitGuiPlugin.h
index 931d4713d..60f53f01f 100644
--- a/source/RobotAPI/gui-plugins/HandUnitPlugin/HandUnitGuiPlugin.h
+++ b/source/RobotAPI/gui-plugins/HandUnitPlugin/HandUnitGuiPlugin.h
@@ -61,7 +61,7 @@ namespace armarx
};
/*!
- * \class HandUnitWidget
+ * \page RobotAPI-GuiPlugins-HandUnitWidget HandUnitGuiPlugin
* \brief With this widget the HandUnit can be controlled.
* \image html HandUnitGUI.png
* You can either select a preshape from the drop-down-menu on top or set each
@@ -71,9 +71,6 @@ namespace armarx
* Parameter Name | Example Value | Required? | Description
* :---------------- | :-------------: | :-------------- |:--------------------
* Proxy | LeftHandUnit | Yes | The hand unit you want to control.
- *
- * \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
- * \see HandUnitGuiPlugin
*/
class HandUnitWidget :
public ArmarXComponentWidgetController,
diff --git a/source/RobotAPI/gui-plugins/HapticUnitPlugin/HapticUnitGuiPlugin.h b/source/RobotAPI/gui-plugins/HapticUnitPlugin/HapticUnitGuiPlugin.h
index 21e5c7781..6b2a9f629 100644
--- a/source/RobotAPI/gui-plugins/HapticUnitPlugin/HapticUnitGuiPlugin.h
+++ b/source/RobotAPI/gui-plugins/HapticUnitPlugin/HapticUnitGuiPlugin.h
@@ -45,12 +45,6 @@ namespace armarx
{
class HapticUnitConfigDialog;
- /*!
- \class HapticUnitGuiPlugin
- \brief This plugin provides a widget with which the HapticUnit can be controlled.
-
- \see HapticUnitWidget
- */
class HapticUnitGuiPlugin :
public ArmarXGuiPlugin
{
@@ -63,11 +57,8 @@ namespace armarx
};
/*!
- \class HapticUnitWidget
+ \page RobotAPI-GuiPlugins-HapticUnitPlugin HapticUnitPlugin
\brief With this widget the HapticUnit can be controlled.
-
- \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
- \see HapticUnitGuiPlugin
*/
class HapticUnitWidget :
public ArmarXComponentWidgetController
diff --git a/source/RobotAPI/gui-plugins/KinematicUnitPlugin/KinematicUnitGuiPlugin.h b/source/RobotAPI/gui-plugins/KinematicUnitPlugin/KinematicUnitGuiPlugin.h
index 8dae7b5fb..2b93b13f8 100644
--- a/source/RobotAPI/gui-plugins/KinematicUnitPlugin/KinematicUnitGuiPlugin.h
+++ b/source/RobotAPI/gui-plugins/KinematicUnitPlugin/KinematicUnitGuiPlugin.h
@@ -85,7 +85,8 @@ namespace armarx
};
/*!
- \class KinematicUnitWidget
+ \page RobotAPI-GuiPlugins-KinematicUnitPlugin KinematicUnitPlugin
+
\brief This widget shows position and velocity of all joints. Optionally a 3d robot model can be visualized.
\image html KinematicUnitGUI.png
@@ -103,9 +104,6 @@ namespace armarx
On the top you can select the joint you wish to control and the control mode. You can control
a joint with the slider below.
-
- \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
- \see KinematicUnitGuiPlugin
*/
class KinematicUnitWidgetController :
public ArmarXComponentWidgetController,
diff --git a/source/RobotAPI/gui-plugins/PlatformUnitPlugin/PlatformUnitGuiPlugin.h b/source/RobotAPI/gui-plugins/PlatformUnitPlugin/PlatformUnitGuiPlugin.h
index fa3eb3426..162846e8e 100644
--- a/source/RobotAPI/gui-plugins/PlatformUnitPlugin/PlatformUnitGuiPlugin.h
+++ b/source/RobotAPI/gui-plugins/PlatformUnitPlugin/PlatformUnitGuiPlugin.h
@@ -61,7 +61,7 @@ namespace armarx
};
/*!
- \class PlatformUnitWidget
+ \page RobotAPI-GuiPlugins-PlatformUnitPlugin PlatformUnitPlugin
\brief With this widget the PlatformUnit can be controlled.
\image html PlatformUnitGUI.png "The plugin's ui." width=300px
@@ -76,8 +76,6 @@ namespace armarx
:---------------- | :-------------: | :-------------- |:--------------------
PlatformUnit - Proxy | PlatformUnit | Yes | The name of the platform unit.
Platform | Platform | Yes | The name of the platform.
- \see PlatformUnitGuiPlugin
- \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
*/
class PlatformUnitWidget :
public ArmarXComponentWidgetController,
diff --git a/source/RobotAPI/gui-plugins/RobotViewerPlugin/RobotViewerGuiPlugin.h b/source/RobotAPI/gui-plugins/RobotViewerPlugin/RobotViewerGuiPlugin.h
index e2e9cfac5..d879a300a 100644
--- a/source/RobotAPI/gui-plugins/RobotViewerPlugin/RobotViewerGuiPlugin.h
+++ b/source/RobotAPI/gui-plugins/RobotViewerPlugin/RobotViewerGuiPlugin.h
@@ -73,7 +73,8 @@ namespace armarx
};
/**
- \class RobotViewerWidget
+ \page RobotAPI-GuiPlugins-RobotViewerPlugin RobotViewerPlugin
+
\brief This widget shows a 3D model of the robot. The robot is articulated and moved according to the corresponding RemoteRobot.
Further, DebugDrawer methods are available.
\image html RobotViewerGUI.png
@@ -82,9 +83,6 @@ namespace armarx
Parameter Name | Example Value | Required? | Description
:---------------- | :-------------: | :-------------- |:--------------------
Proxy | RobotStateComponent | Yes | The name of the robot state component.
-
- \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
- \see RobotViewerGuiPlugin
*/
class RobotViewerWidgetController :
public ArmarXComponentWidgetController
diff --git a/source/RobotAPI/gui-plugins/SensorActorWidgetsPlugin/ArmarXPlotter/ArmarXPlotter.h b/source/RobotAPI/gui-plugins/SensorActorWidgetsPlugin/ArmarXPlotter/ArmarXPlotter.h
index d8d9e76f4..6481b5953 100644
--- a/source/RobotAPI/gui-plugins/SensorActorWidgetsPlugin/ArmarXPlotter/ArmarXPlotter.h
+++ b/source/RobotAPI/gui-plugins/SensorActorWidgetsPlugin/ArmarXPlotter/ArmarXPlotter.h
@@ -63,7 +63,7 @@ namespace armarx
class ArmarXPlotterDialog;
/*!
- * \class ArmarXPlotter
+ * \page RobotAPI-GuiPlugins-ArmarXPlotter ArmarXPlotter
* \brief The plotter widget allows the user to plot any sensor channel.
* \image html PlotterGUI.png
* A sensor channel can be selected for plotting by clicking the wrench button at the bottom.
diff --git a/source/RobotAPI/gui-plugins/SensorActorWidgetsPlugin/ArmarXTCPMover/TCPMover.h b/source/RobotAPI/gui-plugins/SensorActorWidgetsPlugin/ArmarXTCPMover/TCPMover.h
index c566dae48..2bf6e416d 100644
--- a/source/RobotAPI/gui-plugins/SensorActorWidgetsPlugin/ArmarXTCPMover/TCPMover.h
+++ b/source/RobotAPI/gui-plugins/SensorActorWidgetsPlugin/ArmarXTCPMover/TCPMover.h
@@ -69,10 +69,10 @@ namespace armarx {
};*/
- /*
+ /**
+ * \page RobotAPI-GuiPlugins-TCPMover TCPMover
* @brief The TCPMover widget...
- * @ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
- */
+ */
class TCPMover :
public ArmarXComponentWidgetController
{
--
GitLab