From 3ad4f10e065eeb9237af800a1c3a7eb828f9bbf3 Mon Sep 17 00:00:00 2001
From: Rainer Kartmann <rainer.kartmann@kit.edu>
Date: Wed, 29 Nov 2023 16:57:40 +0100
Subject: [PATCH] Update doc
---
etc/doxygen/pages/HowTos.dox | 2 +-
.../armem/client/MemoryToDebugObserver/Component.h | 7 +++++--
.../libraries/armem/client/util/MemoryToDebugObserver.h | 3 ++-
3 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/etc/doxygen/pages/HowTos.dox b/etc/doxygen/pages/HowTos.dox
index b593cde9f..2fe48c81e 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 07965a053..7ce514c96 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 918b78f90..f1628bc09 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
{
--
GitLab