From a912f8e63ae3bdb119182fd4080c7efd6f9ee822 Mon Sep 17 00:00:00 2001
From: Peter Albrecht <albrecpe@gmail.com>
Date: Fri, 29 Dec 2023 17:07:18 +0100
Subject: [PATCH] Added documentation for memory abstraction
---
.../libraries/skills_gui/memory/SkillManagerWrapper.h | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/source/RobotAPI/libraries/skills_gui/memory/SkillManagerWrapper.h b/source/RobotAPI/libraries/skills_gui/memory/SkillManagerWrapper.h
index a4f1407e0..96f140509 100644
--- a/source/RobotAPI/libraries/skills_gui/memory/SkillManagerWrapper.h
+++ b/source/RobotAPI/libraries/skills_gui/memory/SkillManagerWrapper.h
@@ -16,6 +16,15 @@ namespace armarx::skills::gui
using SkillMap =
std::map<skills::ProviderID, std::map<skills::SkillID, skills::SkillDescription>>;
+ /**
+ * @brief The SkillManagerWrapper class is an abstraction of the `SkillManagerInterfacePrx`.
+ * All widgets in the skill memory gui should interact with the memory only through a shared pointer
+ * to an instance of this class. For this purpose, a `MemoryCommunicatorBase` is available.\n
+ * This wrapper handles conversions from- and to Ice types by itself.
+ *
+ * @see MemoryCommunicatorBase
+ * @see SkillManagerInterface
+ */
class SkillManagerWrapper : public QObject
{
Q_OBJECT
--
GitLab