diff --git a/etc/doxygen/pages/HowTos.dox b/etc/doxygen/pages/HowTos.dox index b593cde9f08189207a34c78af21da8cb26ecd427..2fe48c81ed35c95d80515081fe3adf118d0fd89b 100644 --- a/etc/doxygen/pages/HowTos.dox +++ b/etc/doxygen/pages/HowTos.dox @@ -145,7 +145,7 @@ You can use the component \ref Component-MemoryToDebugObserver to query data fro and send them to the \ref Component-DebugObserver. These values can then be viewed using the \ref ArmarXGui-GuiPlugins-ObserverWidget -or the \ref ArmarXGui-GuiPlugins-PlotterPlugin . +or the \ref ArmarXGui-GuiPlugins-PlotterPlugin. To use this functionality in your own code, use the class armarx::armem::client::util::MemoryToDebugObserver. diff --git a/source/RobotAPI/components/armem/client/MemoryToDebugObserver/Component.h b/source/RobotAPI/components/armem/client/MemoryToDebugObserver/Component.h index 07965a053c07dac9b113c891ebe915aa174f9709..7ce514c96ec2a4554e04f81244a0c6e48a58f603 100644 --- a/source/RobotAPI/components/armem/client/MemoryToDebugObserver/Component.h +++ b/source/RobotAPI/components/armem/client/MemoryToDebugObserver/Component.h @@ -38,8 +38,11 @@ namespace armarx::memory_to_debug_observer * @defgroup Component-MemoryToDebugObserver MemoryToDebugObserver * @ingroup RobotAPI-Components * - * Transfers data from the memory system to the DebugObserver, allowing to visualize them in - * the LivePlotter. + * Transfers data from the memory system to the \ref Component-DebugObserver "Debug Observer", + * allowing to visualize them in the \ref ArmarXGui-GuiPlugins-PlotterPlugin "Live Plotter". + * + * @see armarx::armem::client::util::MemoryToDebugObserver for the business logic + * implementation. * * @class Component * @ingroup Component-MemoryToDebugObserver diff --git a/source/RobotAPI/libraries/armem/client/util/MemoryToDebugObserver.h b/source/RobotAPI/libraries/armem/client/util/MemoryToDebugObserver.h index 918b78f9028e31e056fd0400451e30e3b7597f4a..f1628bc09025c99ec6b3d6c8382ad30c79973977 100644 --- a/source/RobotAPI/libraries/armem/client/util/MemoryToDebugObserver.h +++ b/source/RobotAPI/libraries/armem/client/util/MemoryToDebugObserver.h @@ -45,7 +45,8 @@ namespace armarx::armem::client::util /** * @brief Transfers data from memory servers to the DebugObserver. * - * This allows to visualize the values in the LivePlotter. + * Transfers data from the memory system to the \ref Component-DebugObserver "Debug Observer", + * allowing to visualize them in the \ref ArmarXGui-GuiPlugins-PlotterPlugin "Live Plotter". */ class MemoryToDebugObserver {