From 25cc2a94a8c756a8871fa667a8da0169d29a8c55 Mon Sep 17 00:00:00 2001
From: Peter Albrecht <albrecpe@gmail.com>
Date: Fri, 29 Dec 2023 17:39:22 +0100
Subject: [PATCH] Added documentation for ProfileMenuWidget
---
.../libraries/skills_gui/skill_details/ProfileMenuWidget.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/source/RobotAPI/libraries/skills_gui/skill_details/ProfileMenuWidget.h b/source/RobotAPI/libraries/skills_gui/skill_details/ProfileMenuWidget.h
index 2041c2e9f..90857d0d2 100644
--- a/source/RobotAPI/libraries/skills_gui/skill_details/ProfileMenuWidget.h
+++ b/source/RobotAPI/libraries/skills_gui/skill_details/ProfileMenuWidget.h
@@ -9,6 +9,9 @@
namespace armarx::skills::gui
{
+ /**
+ * @brief The ProfileMenuWidget class is a convenience wrapper for a group of buttons shown in the GUI.
+ */
class ProfileMenuWidget : public QWidget, public MemoryCommunicatorBase
{
Q_OBJECT
@@ -18,7 +21,7 @@ namespace armarx::skills::gui
static const constexpr char* RESET_ARGS_BUTTON_TEXT = "Reset Args to Profile";
static const constexpr char* DEFAULT_PROFILE_TEXT = "<No Profile selected. Using root>";
- // contents are public, as this class is just a convenience wrapper
+ // contents are exposed, as this class is just a convenience wrapper
QPushButton* setArgsFromClipboard = nullptr;
QPushButton* copyArgsToClipboard = nullptr;
QPushButton* resetArgsToProfile = nullptr;
--
GitLab