From fa2f91aa46c1c354bde59ac4b9c49ae296c60286 Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Thu, 25 Jun 2020 14:04:49 +0200
Subject: [PATCH] [libcalamaresui] Minor documentation improvements

---
 src/libcalamaresui/viewpages/QmlViewStep.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/libcalamaresui/viewpages/QmlViewStep.h b/src/libcalamaresui/viewpages/QmlViewStep.h
index e1f4caf28..b15fbfa5c 100644
--- a/src/libcalamaresui/viewpages/QmlViewStep.h
+++ b/src/libcalamaresui/viewpages/QmlViewStep.h
@@ -35,6 +35,15 @@ namespace Calamares
  * This is generally a **base** class for other view steps, but
  * it can be used stand-alone for viewsteps that don't really have
  * any functionality.
+ *
+ * Most subclasses will override the following methods:
+ * - prettyName() to provide a meaningful human-readable name
+ * - jobs() if there is real work to be done during installation
+ * - getConfig() to return a meaningful configuration object
+ *
+ * For details on the interaction between the config object and
+ * the QML in the module, see the Calamares wiki:
+ *      https://github.com/calamares/calamares/wiki/Develop-Design
  */
 class QmlViewStep : public Calamares::ViewStep
 {