From 57ec453993d5690dda2ddbc49fce73eeb2bd7c38 Mon Sep 17 00:00:00 2001
From: Alex Spataru <alex_spataru@outlook.com>
Date: Sat, 18 Dec 2021 03:17:30 -0500
Subject: [PATCH] Document EXEC_EVENT definition

---
 src/UI/DeclarativeWidget.cpp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/UI/DeclarativeWidget.cpp b/src/UI/DeclarativeWidget.cpp
index 44dab6c7..5ae81d13 100644
--- a/src/UI/DeclarativeWidget.cpp
+++ b/src/UI/DeclarativeWidget.cpp
@@ -25,6 +25,10 @@
 
 namespace UI
 {
+/**
+ * Creates a subclass of @c QWidget that allows us to call the given protected/private
+ * @a function and pass the given @a event as a parameter to the @a function.
+ */
 #define EXEC_EVENT(pointer, function, event)                                             \
     if (!pointer.isNull())                                                               \
     {                                                                                    \