From 4d136b7f20a107aa1c38230fc61e4395831692bf Mon Sep 17 00:00:00 2001
From: Peter Kaiser <peter.kaiser@kit.edu>
Date: Thu, 23 Jul 2015 15:38:23 +0200
Subject: [PATCH] Documentation: Gui plugins
---
etc/doxygen/pages/0.Overview.dox | 2 +-
etc/doxygen/pages/RobotApi-Gui-plugins.dox | 5 +++--
source/RobotAPI/gui-plugins/RobotIKPlugin/RobotIKGuiPlugin.h | 5 +++++
3 files changed, 9 insertions(+), 3 deletions(-)
diff --git a/etc/doxygen/pages/0.Overview.dox b/etc/doxygen/pages/0.Overview.dox
index b9cb80eb4..6504037bb 100644
--- a/etc/doxygen/pages/0.Overview.dox
+++ b/etc/doxygen/pages/0.Overview.dox
@@ -32,7 +32,7 @@ Available GUI-plugins provide access to the kinematic robot state, end effectors
RobotAPI also provides a GUI-plugin for robot visualization.
\par
-\link RobotAPI-GuiPlugins Read more \endlink
+\link RobotAPI-ArmarXGuiPlugins Read more \endlink
\par Statecharts
RobotAPI contains a set of robot-independent statecharts that can be used in other ArmarX packages.
diff --git a/etc/doxygen/pages/RobotApi-Gui-plugins.dox b/etc/doxygen/pages/RobotApi-Gui-plugins.dox
index 7867bcb82..7af77799e 100644
--- a/etc/doxygen/pages/RobotApi-Gui-plugins.dox
+++ b/etc/doxygen/pages/RobotApi-Gui-plugins.dox
@@ -1,4 +1,5 @@
/**
* \defgroup RobotAPI-ArmarXGuiPlugins RobotAPI GUI plugins
- * \ingroup ArmarXGuiPlugins
- */
\ No newline at end of file
+ * \ingroup ArmarXGuiPlugins RobotAPI
+ * \brief
+ */
diff --git a/source/RobotAPI/gui-plugins/RobotIKPlugin/RobotIKGuiPlugin.h b/source/RobotAPI/gui-plugins/RobotIKPlugin/RobotIKGuiPlugin.h
index 68fc4d94b..3ad05d929 100644
--- a/source/RobotAPI/gui-plugins/RobotIKPlugin/RobotIKGuiPlugin.h
+++ b/source/RobotAPI/gui-plugins/RobotIKPlugin/RobotIKGuiPlugin.h
@@ -64,6 +64,11 @@ namespace armarx
}
};
+ /**
+ * \class RobotIKWidget
+ * \ingroup RobotAPI-ArmarXGuiPlugins ArmarXGuiPlugins
+ * \brief Widget for IK computation.
+ */
class RobotIKWidgetController : public ArmarXComponentWidgetController
{
Q_OBJECT
--
GitLab