feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

TaskTree: Update Storage docs

Browse Source 
After recent changes, the Storage object isn't derived from
GroupItem class anymore. Instead, there is a Group constructor
taking the Storage object. Make docs precise, that Storage
isn't a GroupItem, but we may have a GroupItem containing a
Storage.

Make it clear, that the running task tree doesn't instantiate
the storage itself, but it's data type.

Add more links.

Change-Id: I1569602cabae39215c48824b6897387e631b90a8
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Jarek Kobus
2023-12-10 18:46:57 +01:00
parent 7ec55f89f1
commit 88b9268315
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/libs/solutions/tasking/tasktree.cpp
View File

@@ -334,18 +334,18 @@ private:
\li \l CustomTask \li \l CustomTask
\li Defines asynchronous task type and task's start, done, and error handlers. \li Defines asynchronous task type and task's start, done, and error handlers.
Aliased with a unique task name, such as, \c ConcurrentCallTask<ResultType> Aliased with a unique task name, such as, \c ConcurrentCallTask<ResultType>
or NetworkQueryTask. Asynchronous tasks are the main reason for using a task tree. or \c NetworkQueryTask. Asynchronous tasks are the main reason for using a task tree.
\row \row
\li \l {Tasking::Group} {Group} \li \l {Tasking::Group} {Group}
\li A container for other group items. Since the group is of the GroupItem type, \li A container for other group items. Since the group is of the GroupItem type,
it's possible to nest it inside another group. The group is seen by its parent it's possible to nest it inside another group. The group is seen by its parent
as a single asynchronous task. as a single asynchronous task.
\row \row
\li Storage \li GroupItem containing \l {Tasking::Storage} {Storage}
\li Enables the child tasks of a group to exchange data. \li Enables the child tasks of a group to exchange data. When GroupItem containing
When Storage is placed inside a group, the task tree instantiates \l {Tasking::Storage} {Storage} is placed inside a group, the task tree instantiates
the storage object just before the group is entered, the storage's data object just before the group is entered,
and destroys it just after the group is finished. and destroys it just after the group is left.
\row \row
\li Other group control items \li Other group control items
\li The items returned by \l {Tasking::parallelLimit()} {parallelLimit()} or \li The items returned by \l {Tasking::parallelLimit()} {parallelLimit()} or