From ef7c71b39539c891a8e664f4d30f613e5dd0bf04 Mon Sep 17 00:00:00 2001
From: Peter Albrecht <albrecpe@gmail.com>
Date: Fri, 29 Dec 2023 17:22:08 +0100
Subject: [PATCH] Added documentation to MemoryCommunicatorBase
---
.../libraries/skills_gui/memory/MemoryCommunicatorBase.h | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/source/RobotAPI/libraries/skills_gui/memory/MemoryCommunicatorBase.h b/source/RobotAPI/libraries/skills_gui/memory/MemoryCommunicatorBase.h
index adefacd93..4166cfc81 100644
--- a/source/RobotAPI/libraries/skills_gui/memory/MemoryCommunicatorBase.h
+++ b/source/RobotAPI/libraries/skills_gui/memory/MemoryCommunicatorBase.h
@@ -9,7 +9,9 @@ namespace armarx::skills::gui
{
/*
* This is a convenience base class to prevent repeatedly putting the SkillManagerWrapper in
- * every widget.
+ * every widget. All widgets communicating with the skill manager should be derived from this class.
+ *
+ * @see SkillManagerWrapper
*/
class MemoryCommunicatorBase
{
@@ -19,7 +21,9 @@ namespace armarx::skills::gui
{
}
- // The interface of the memory, used by the skill memory gui
+ /**
+ * @brief The pointer to the manager wrapper.
+ */
std::shared_ptr<SkillManagerWrapper> memory;
};
} // namespace armarx::skills::gui
--
GitLab