napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[libcalamaresui] Minor documentation improvements

Browse Source
This commit is contained in:
Adriaan de Groot 2020-06-25 14:04:49 +02:00
parent 3c48bbdb9c
commit fa2f91aa46
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/libcalamaresui/viewpages/QmlViewStep.h
View File

@ -35,6 +35,15 @@ namespace Calamares
* This is generally a **base** class for other view steps, but * This is generally a **base** class for other view steps, but
* it can be used stand-alone for viewsteps that don't really have * it can be used stand-alone for viewsteps that don't really have
* any functionality. * 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 class QmlViewStep : public Calamares::ViewStep
{ {