From 616fbb08f3098fb06432de4d580652d71bc560a3 Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Mon, 11 May 2020 11:19:08 +0200
Subject: [PATCH] [libcalamares] Improve docs of RequirementsModel

---
 src/libcalamares/modulesystem/RequirementsModel.h | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/src/libcalamares/modulesystem/RequirementsModel.h b/src/libcalamares/modulesystem/RequirementsModel.h
index 2acf785e7..b288b9d49 100644
--- a/src/libcalamares/modulesystem/RequirementsModel.h
+++ b/src/libcalamares/modulesystem/RequirementsModel.h
@@ -27,7 +27,15 @@
 
 namespace Calamares
 {
-
+/** @brief System requirements from each module and their checked-status
+ *
+ * A Calamares module can have system requirements (e.g. check for
+ * internet, or amount of RAM, or an available disk) which can
+ * be stated and checked.
+ *
+ * This model collects those requirements, can run the checks, and
+ * reports on the overall status of those checks.
+ */
 class DLLEXPORT RequirementsModel : public QAbstractListModel
 {
     Q_OBJECT
@@ -70,10 +78,9 @@ protected:
     QHash< int, QByteArray > roleNames() const override;
 
 private:
-    Calamares::RequirementsList m_requirements;
+    RequirementsList m_requirements;
     bool m_satisfiedRequirements = false;
     bool m_satisfiedMandatory = false;
-
 };
 
 }  // namespace Calamares