From 17962179bdd56fe50ec0ffcbdacc69ce6212435d Mon Sep 17 00:00:00 2001
From: Teo Mrnjavac <teo@kde.org>
Date: Fri, 3 Mar 2017 12:32:10 +0100
Subject: [PATCH] Documentation++

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

diff --git a/src/libcalamaresui/viewpages/ViewStep.h b/src/libcalamaresui/viewpages/ViewStep.h
index c9dadb18d..c68ae31f5 100644
--- a/src/libcalamaresui/viewpages/ViewStep.h
+++ b/src/libcalamaresui/viewpages/ViewStep.h
@@ -27,6 +27,14 @@
 namespace Calamares
 {
 
+/**
+ * @brief The ViewStep class is the base class for all view modules.
+ * A view module is a Calamares module which has at least one UI page (exposed as
+ * ViewStep::widget), and can optionally create Calamares jobs at runtime.
+ * As of early 2017, a view module can be implemented by deriving from ViewStep
+ * in C++ (as a Qt Plugin) or in Python with the PythonQt interface (which also
+ * mimics the ViewStep class).
+ */
 class UIDLLEXPORT ViewStep : public QObject
 {
     Q_OBJECT