From 88b9268315f57ce5f1bec7607912905e4a2b9767 Mon Sep 17 00:00:00 2001 From: Jarek Kobus Date: Sun, 10 Dec 2023 18:46:57 +0100 Subject: [PATCH] TaskTree: Update Storage docs 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 --- src/libs/solutions/tasking/tasktree.cpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/libs/solutions/tasking/tasktree.cpp b/src/libs/solutions/tasking/tasktree.cpp index 7db21ecd7d8..066a57aa52b 100644 --- a/src/libs/solutions/tasking/tasktree.cpp +++ b/src/libs/solutions/tasking/tasktree.cpp @@ -334,18 +334,18 @@ private: \li \l CustomTask \li Defines asynchronous task type and task's start, done, and error handlers. Aliased with a unique task name, such as, \c ConcurrentCallTask - 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 \li \l {Tasking::Group} {Group} \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 as a single asynchronous task. \row - \li Storage - \li Enables the child tasks of a group to exchange data. - When Storage is placed inside a group, the task tree instantiates - the storage object just before the group is entered, - and destroys it just after the group is finished. + \li GroupItem containing \l {Tasking::Storage} {Storage} + \li Enables the child tasks of a group to exchange data. When GroupItem containing + \l {Tasking::Storage} {Storage} is placed inside a group, the task tree instantiates + the storage's data object just before the group is entered, + and destroys it just after the group is left. \row \li Other group control items \li The items returned by \l {Tasking::parallelLimit()} {parallelLimit()} or