add documentation for Task and ConcurrentTask

This commit is contained in:
iTrooz
2024-11-25 23:49:03 +01:00
parent 7d2da19418
commit ca6d66970e
2 changed files with 22 additions and 2 deletions

View File

@ -43,6 +43,10 @@
#include "tasks/Task.h"
/*!
* Runs a list of tasks concurrently (according to `max_concurrent` parameter).
* Behaviour is the same as regular Task (e.g. starts using start())
*/
class ConcurrentTask : public Task {
Q_OBJECT
public:
@ -59,6 +63,7 @@ class ConcurrentTask : public Task {
inline auto isMultiStep() const -> bool override { return totalSize() > 1; }
auto getStepProgress() const -> TaskStepProgressList override;
//! Adds a task to execute in this ConcurrentTask
void addTask(Task::Ptr task);
public slots: