diff options
| author | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2023-05-15 12:28:35 +0200 |
|---|---|---|
| committer | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2023-05-24 07:04:31 +0200 |
| commit | 8e46ac8d05bec962f747a1334390ca90cc536acf (patch) | |
| tree | cef898d249cbdec5172aa828e049c9d1760266af /src/corelib/thread/qthreadpool.cpp | |
| parent | ecaf93c366f9009bcc2ba04700f16989c214677b (diff) | |
Doc: fix warnings from parameters not matching the documentation
Change-Id: I6588336e12db0a3af9b9dfd2ab22a3e1b7c54238
Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src/corelib/thread/qthreadpool.cpp')
| -rw-r--r-- | src/corelib/thread/qthreadpool.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/corelib/thread/qthreadpool.cpp b/src/corelib/thread/qthreadpool.cpp index a6c2a7e54b2..fb7ef030601 100644 --- a/src/corelib/thread/qthreadpool.cpp +++ b/src/corelib/thread/qthreadpool.cpp @@ -521,9 +521,9 @@ void QThreadPool::start(QRunnable *runnable, int priority) \overload \since 5.15 - Reserves a thread and uses it to run \a functionToRun, unless this thread will + Reserves a thread and uses it to run \a callableToRun, unless this thread will make the current thread count exceed maxThreadCount(). In that case, - \a functionToRun is added to a run queue instead. The \a priority argument can + \a callableToRun is added to a run queue instead. The \a priority argument can be used to control the run queue's order of execution. \note This function participates in overload resolution only if \c Callable @@ -566,10 +566,10 @@ bool QThreadPool::tryStart(QRunnable *runnable) \fn template<typename Callable, QRunnable::if_callable<Callable>> bool QThreadPool::tryStart(Callable &&callableToRun) \overload \since 5.15 - Attempts to reserve a thread to run \a functionToRun. + Attempts to reserve a thread to run \a callableToRun. If no threads are available at the time of calling, then this function - does nothing and returns \c false. Otherwise, \a functionToRun is run immediately + does nothing and returns \c false. Otherwise, \a callableToRun is run immediately using one available thread and this function returns \c true. \note This function participates in overload resolution only if \c Callable @@ -796,7 +796,7 @@ void QThreadPool::startOnReservedThread(QRunnable *runnable) \since 6.3 Releases a thread previously reserved with reserveThread() and uses it - to run \a functionToRun. + to run \a callableToRun. \note This function participates in overload resolution only if \c Callable is a function or function object which can be called with zero arguments. |