From 24518d5552a1235201cc1792f8b41860cadc6fbf Mon Sep 17 00:00:00 2001
From: Alex Spataru <alex_spataru@outlook.com>
Date: Fri, 1 Oct 2021 04:14:34 -0500
Subject: [PATCH] Add documentation for WidgetLoader.cpp

---
 src/Widgets/WidgetLoader.cpp | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/src/Widgets/WidgetLoader.cpp b/src/Widgets/WidgetLoader.cpp
index 5deed38a..d55a0f47 100644
--- a/src/Widgets/WidgetLoader.cpp
+++ b/src/Widgets/WidgetLoader.cpp
@@ -185,6 +185,13 @@ QString WidgetLoader::widgetTitle() const
     return tr("Invalid");
 }
 
+/**
+ * If set to @c true, then the widget visibility shall be controlled
+ * directly by the QML interface.
+ *
+ * If set to @c false, then the widget visbility shall be controlled
+ * by the UI::Dashboard class via the SIGNAL/SLOT system.
+ */
 bool WidgetLoader::isExternalWindow() const
 {
     return m_isExternalWindow;
@@ -198,6 +205,9 @@ UI::Dashboard::WidgetType WidgetLoader::widgetType() const
     return UI::Dashboard::getInstance()->widgetType(widgetIndex());
 }
 
+/**
+ * Changes the visibility & enabled status of the widget
+ */
 void WidgetLoader::setVisible(const bool visible)
 {
     if (m_widget)
@@ -269,6 +279,15 @@ void WidgetLoader::setWidgetIndex(const int index)
     }
 }
 
+/**
+ * Changes the widget visibility controller source.
+ *
+ * If set to @c true, then the widget visibility shall be controlled
+ * directly by the QML interface.
+ *
+ * If set to @c false, then the widget visbility shall be controlled
+ * by the UI::Dashboard class via the SIGNAL/SLOT system.
+ */
 void WidgetLoader::setIsExternalWindow(const bool isWindow)
 {
     m_isExternalWindow = isWindow;