[requirements] Document code

This commit is contained in:
Adriaan de Groot 2017-11-20 08:18:39 -05:00
parent 4f077d3b9a
commit 7d916f649d

View File

@ -27,6 +27,15 @@
class CheckerWidget; class CheckerWidget;
class QWidget; 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 struct PrepareEntry
{ {
QString name; QString name;