diff --git a/source/RobotAPI/components/ArViz/ArVizStorage.h b/source/RobotAPI/components/ArViz/ArVizStorage.h index 220bc12b3c41eb17fdcf5110a4b237235ed5a7f7..02ebc981525bdc26ce277867950e79bbed39d17a 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 953dd1577cff25cb11dd0d6b055dbc92667192cc..252a0c6f2221b95872db648f05dcdbdf7d487c5f 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,