From 99aadadb0f65ccb02e40a17db5d85a91bc685550 Mon Sep 17 00:00:00 2001
From: Clemens Wallrath <uagzs@student.kit.edu>
Date: Fri, 10 Jun 2016 17:21:02 +0200
Subject: [PATCH] Add documentation on how to document gui plugins
---
etc/doxygen/pages/HowTos.dox | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/etc/doxygen/pages/HowTos.dox b/etc/doxygen/pages/HowTos.dox
index 0d70b14d..c45f0fb6 100644
--- a/etc/doxygen/pages/HowTos.dox
+++ b/etc/doxygen/pages/HowTos.dox
@@ -33,6 +33,31 @@ The corresponding cpp file (MyGuiPluginWidgetController.cpp) :
A CMakeLists.txt file to compile this gui plugin:
\include CMakeLists.txt.dox
+To add proper documentation for your gui plugin, create a doxygen page in your MyGuiPluginWidgetController.h:
+\code{.unparsed}
+namespace armarx
+{
+ /**
+ * \page ${PACKAGENAME}-GuiPlugins-MyGuiPlugin MyGuiPlugin
+ * \brief The MyGuiPlugin allows you to ...
+ *
+ * \image html MyGuiPlugin.png
+ *
+ * This is a detailled description of the MyGuiPlugin
+ * gui plugin. It is very awesome.
+ *
+ * \see MyGuiPluginGuiPlugin
+ */
+...
+\endcode
+
+and add it as subpage to ${PACKAGENAME}/etc/doxygen/pages/GuiPlugins.dox:
+\code
+\subpage ${PACKAGENAME}-GuiPlugins-MyGuiPlugin "MyGuiPlugin"
+\endcode
+
+Images (e.g. a screenshot of the widget) go to ${PACKAGENAME}/etc/doxygen/images/.
+
\note All network calls (e.g. with Ice) should be in a seperate thread like armarx::RunningTask, armarx::PeriodicTask or QThread
since they can take a long time to complete and block the complete GUI if executed in the qt main-event-loop.
QTimer or timerEvent(QTimerEvent) are running in the same thread as the main application loop, so they are not
--
GitLab