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

[libcalamares] Document JobWeight

Browse Source
This commit is contained in:
Adriaan de Groot 2020-01-25 01:10:04 +01:00
parent b0b9073b40
commit 0c9188ee83
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/libcalamares/Job.h
View File

@ -96,6 +96,14 @@ public:
explicit Job( QObject* parent = nullptr ); explicit Job( QObject* parent = nullptr );
virtual ~Job(); virtual ~Job();
/** @brief The job's (relative) weight.
*
* The default implementation returns 1.0, which gives all jobs
* the same weight, so they advance the overall progress the same
* amount. This is nonsense, since some jobs take much longer than
* others; it's up to the individual jobs to say something about
* how much work is (relatively) done.
*/
virtual qreal getJobWeight() const; virtual qreal getJobWeight() const;
virtual QString prettyName() const = 0; virtual QString prettyName() const = 0;
virtual QString prettyDescription() const; virtual QString prettyDescription() const;