applications/calamares
2
0
Fork 0
mirror of https://github.com/parchlinux/calamares.git synced 2025-06-30 10:55:37 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

[libcalamares] Document the pretty*() functions for Jobs

Browse source
This commit is contained in:
Adriaan de Groot 2020-03-05 08:54:42 -05:00
parent 6d29c19e3e
commit 3025c5383b
1 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/libcalamares/Job.h
View file

@ -105,8 +105,20 @@ public:
* how much work is (relatively) done.
*/
virtual qreal getJobWeight() const;
/** @brief The human-readable name of this job
*
* This should be a very short statement of what the job does.
* For status and state information, see prettyStatusMessage().
*/
virtual QString prettyName() const = 0;
// TODO: Unused
virtual QString prettyDescription() const;
/** @brief A human-readable status for progress reporting
*
* This is called from the JobQueue when progress is made, and should
* return a not-too-long description of the job's status. This
* is made visible in the progress bar of the execution view step.
*/
virtual QString prettyStatusMessage() const;
virtual JobResult exec() = 0;