From df044de1bf29f174665f14d2880a074be01e3bbb Mon Sep 17 00:00:00 2001 From: skyjake Date: Mon, 5 Aug 2013 16:21:15 +0300 Subject: [PATCH] Documentation|libdeng2|TaskPool: Information about usage --- doomsday/libdeng2/include/de/concurrency/taskpool.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doomsday/libdeng2/include/de/concurrency/taskpool.h b/doomsday/libdeng2/include/de/concurrency/taskpool.h index af3793fe13..2cc08cf6e8 100644 --- a/doomsday/libdeng2/include/de/concurrency/taskpool.h +++ b/doomsday/libdeng2/include/de/concurrency/taskpool.h @@ -30,6 +30,11 @@ class Task; /** * Pool of concurrent tasks. * + * The application uses a single, shared pool of background threads regardless + * of how many instances of TaskPool are created. One should use a separate + * TaskPool instance for each group of concurrent tasks whose state needs to be + * observed as a whole. + * * While TaskPool allows the user to monitor whether all tasks are done and * block until that time arrives (TaskPool::waitForDone()), no facilities are * provided for interrupting any of the started tasks. If that is required, the