From c843a22e5c69f2a17fa96f566e82cc9f6f1e284c Mon Sep 17 00:00:00 2001
From: Peter Albrecht <albrecpe@gmail.com>
Date: Wed, 3 Jan 2024 14:42:14 +0100
Subject: [PATCH] Added documentation for skill memory gui
---
source/RobotAPI/libraries/skills_gui/SkillMemoryGui.h | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/source/RobotAPI/libraries/skills_gui/SkillMemoryGui.h b/source/RobotAPI/libraries/skills_gui/SkillMemoryGui.h
index 14496f951..e4561242b 100644
--- a/source/RobotAPI/libraries/skills_gui/SkillMemoryGui.h
+++ b/source/RobotAPI/libraries/skills_gui/SkillMemoryGui.h
@@ -20,6 +20,11 @@
namespace armarx::skills::gui
{
+ /**
+ * @brief The SkillMemoryGUI class represents the entire GUI. To use it, one must first create some widgets,
+ * and construct this GUI with pointers to them. Afterwards, this class will replace/manage the
+ * given widgets itself. Aside from connectivity, no further management is required.
+ */
class SkillMemoryGUI : public QObject, public armarx::Logging
{
Q_OBJECT
--
GitLab