Skip to content
Snippets Groups Projects
Commit 3ad4f10e authored by Rainer Kartmann's avatar Rainer Kartmann
Browse files

Update doc

parent 9b3850ae
No related branches found
No related tags found
No related merge requests found
......@@ -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.
......
......@@ -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
......
......@@ -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
{
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment