[libcalamaresui] Add documentation to ViewStep methods

This commit is contained in:
Adriaan de Groot 2019-02-25 07:20:35 -05:00
parent 40a7082bfc
commit c3d13e3451

View File

@ -92,6 +92,12 @@ public:
*/
virtual void onLeave();
/**
* @brief Jobs needed to run this viewstep
*
* When a ViewStep is listed in the exec section, its jobs are executed instead.
* This function returns that list of jobs; an empty list is ok.
*/
virtual JobList jobs() const = 0;
void setModuleInstanceKey( const QString& instanceKey );
@ -102,9 +108,17 @@ public:
virtual void setConfigurationMap( const QVariantMap& configurationMap );
/**
* @brief Can this module proceed, on this machine?
*
* This is called asynchronously at startup, and returns a list of
* the requirements that the module has checked, and their status.
* See Calamares::RequirementEntry for details.
*/
virtual RequirementsList checkRequirements();
signals:
/// @brief Tells the viewmanager to enable the *next* button according to @p status
void nextStatusChanged( bool status );
void done();