From 65a539b7e63524b8d410200b770621bb9e554c9b Mon Sep 17 00:00:00 2001
From: Rainer Kartmann <rainer.kartmann@kit.edu>
Date: Tue, 30 Nov 2021 14:49:48 +0100
Subject: [PATCH] Revise doc for ArVizExample
---
.../RobotAPI/components/ArViz/ArVizStorage.h | 2 +-
.../components/ArViz/Example/ArVizExample.h | 24 ++++++++++++-------
2 files changed, 16 insertions(+), 10 deletions(-)
diff --git a/source/RobotAPI/components/ArViz/ArVizStorage.h b/source/RobotAPI/components/ArViz/ArVizStorage.h
index 220bc12b3..02ebc9815 100644
--- a/source/RobotAPI/components/ArViz/ArVizStorage.h
+++ b/source/RobotAPI/components/ArViz/ArVizStorage.h
@@ -49,7 +49,7 @@ namespace armarx
* visualization episodes and restore.
*
*
- * @class ArViz
+ * @class ArVizStorage
* @ingroup Component-ArVizStorage
*
* @brief Stores visualization elements drawn by ArViz clients.
diff --git a/source/RobotAPI/components/ArViz/Example/ArVizExample.h b/source/RobotAPI/components/ArViz/Example/ArVizExample.h
index 953dd1577..252a0c6f2 100644
--- a/source/RobotAPI/components/ArViz/Example/ArVizExample.h
+++ b/source/RobotAPI/components/ArViz/Example/ArVizExample.h
@@ -47,22 +47,28 @@ namespace armarx
* \li Open the gui plugin `ArViz`
* \li Start the component `ArVizExample`
*
- * The scenario `ArVizExample` starts the necessary components including
- * the example component.
+ * The scenario `ArVizExample` starts the necessary components,
+ * including the example component.
*
*
+ * A component which wants to visualize data via ArViz should:
+ * \li `#include <RobotAPI/libraries/RobotAPIComponentPlugins/ArVizComponentPlugin.h>`
+ * \li Inherit from the `armarx::ArVizComponentPluginUser`. This adds the
+ * necessary properties (e.g. the topic name) and provides a
+ * ready-to-use ArViz client called `arviz`.
+ * \li Use the inherited ArViz client variable `arviz` of type `viz::Client`
+ * to create layers, add visualization elements to the layers,
+ * and commit the layers to the ArViz topic.
+ *
+ * \see ArVizExample
+ *
*
* @class ArVizExample
* @ingroup Component-ArVizExample
- * @brief Brief description of class ArVizExample.
*
- * A component which wants to visualize data via ArViz should inherit from
- * the `armarx::ArVizComponentPluginUser`.
- * This adds the necessary properties (e.g. the topic name) and provides a
- * ready-to-use ArViz client called `arviz`.
- * The ArViz client can be used to create layers and commit them to the
- * ArViz topic.
+ * @brief An example for how to use ArViz.
*
+ * @see @ref Component-ArVizExample
*/
class ArVizExample :
virtual public armarx::Component,
--
GitLab