summaryrefslogtreecommitdiffstats
path: root/src/concurrent/qtconcurrentrun.cpp
diff options
context:
space:
mode:
authorAlexei Cazacov <alexei.cazacov@qt.io>2025-09-03 15:50:47 +0300
committerAlexei Cazacov <alexei.cazacov@qt.io>2025-09-09 15:35:39 +0300
commiteba48b0c21d467237aee347a5906b5b2623e777d (patch)
treee924c73bca8c9c54fb65f7d424022f642c9bcee9 /src/concurrent/qtconcurrentrun.cpp
parente6ddf72279a36c25a83ea057698345e15e18c04c (diff)
Doc: Document the specific headers for the Qt Concurrent module
This commit makes the Image Scaling example use the optimized header and updates documentation to include optimized header inclusion for QtConcurrent functions. Fixes: QTBUG-114663 Pick-to: 6.10 6.9 6.8 Change-Id: I50e4137ea3bc22bf88a3c9e4856043ba3d02f06e Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
Diffstat (limited to 'src/concurrent/qtconcurrentrun.cpp')
-rw-r--r--src/concurrent/qtconcurrentrun.cpp12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/concurrent/qtconcurrentrun.cpp b/src/concurrent/qtconcurrentrun.cpp
index 513699cdc5d..4217fbf8185 100644
--- a/src/concurrent/qtconcurrentrun.cpp
+++ b/src/concurrent/qtconcurrentrun.cpp
@@ -23,6 +23,18 @@
This function is a part of the Qt Concurrent framework.
+ \section1 Optimize includes
+
+ If you include the \c <QtConcurrent> header, the entire Qt Concurrent
+ module with the entire Qt Core module will be included, which may increase
+ compilation times and binary sizes. To use the
+ \l {QtConcurrent::run}{QtConcurrent::run()} function, you can include a
+ more specific header:
+
+ \code
+ #include <QtConcurrentRun>
+ \endcode
+
\section1 Concurrent Run (basic mode)
The function passed to QtConcurrent::run() may report the result