From 7d916f649dda983fdbe9fe92099fe00d1bd127f4 Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Mon, 20 Nov 2017 08:18:39 -0500
Subject: [PATCH] [requirements] Document code

---
 src/modules/welcome/checker/RequirementsChecker.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/modules/welcome/checker/RequirementsChecker.h b/src/modules/welcome/checker/RequirementsChecker.h
index 1e52d9fc5..f2f63f7e0 100644
--- a/src/modules/welcome/checker/RequirementsChecker.h
+++ b/src/modules/welcome/checker/RequirementsChecker.h
@@ -27,6 +27,15 @@
 class CheckerWidget;
 class QWidget;
 
+/**
+ * An indication of a requirement, which is checked in preparation
+ * for system installation. An entry has a name and some explanation,
+ * as well as three meaningful states:
+ *  - checked = true, the requirement is met (green)
+ *  - checked = false, the requirement is not met
+ *      - required = false, warn about it (yellow), no failure
+ *      - required = true, prohibit installation (red)
+ */
 struct PrepareEntry
 {
     QString name;