diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-11-11 19:15:28 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-11-12 06:54:53 +0100 |
| commit | d01b9ac6af60679c5d18dbacbbac9a5afcd8079d (patch) | |
| tree | d7c4e0566cbd884326fed9b9cc85e5812451ce80 /src/corelib/thread | |
| parent | 328cad011e48a033d235c323fbe575c92c228027 (diff) | |
Doc: Add missing brief statements for \property documentation
... where applicable.
Fixes: QTBUG-88232
Change-Id: I835df434765caededd35d5114965b4a1663e7942
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/corelib/thread')
| -rw-r--r-- | src/corelib/thread/qthreadpool.cpp | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/src/corelib/thread/qthreadpool.cpp b/src/corelib/thread/qthreadpool.cpp index 99e33cab48..6d258af9df 100644 --- a/src/corelib/thread/qthreadpool.cpp +++ b/src/corelib/thread/qthreadpool.cpp @@ -582,8 +582,9 @@ bool QThreadPool::tryStart(std::function<void()> functionToRun) } /*! \property QThreadPool::expiryTimeout + \brief the thread expiry timeout value in milliseconds. - Threads that are unused for \a expiryTimeout milliseconds are considered + Threads that are unused for \e expiryTimeout milliseconds are considered to have expired and will exit. Such threads will be restarted as needed. The default \a expiryTimeout is 30000 milliseconds (30 seconds). If \a expiryTimeout is negative, newly created threads will not expire, e.g., @@ -611,8 +612,7 @@ void QThreadPool::setExpiryTimeout(int expiryTimeout) /*! \property QThreadPool::maxThreadCount - This property represents the maximum number of threads used by the thread - pool. + \brief the maximum number of threads used by the thread pool. \note The thread pool will always use at least 1 thread, even if \a maxThreadCount limit is zero or negative. @@ -640,7 +640,7 @@ void QThreadPool::setMaxThreadCount(int maxThreadCount) /*! \property QThreadPool::activeThreadCount - This property represents the number of active threads in the thread pool. + \brief the number of active threads in the thread pool. \note It is possible for this function to return a value that is greater than maxThreadCount(). See reserveThread() for more details. @@ -675,9 +675,7 @@ void QThreadPool::reserveThread() } /*! \property QThreadPool::stackSize - - This property contains the stack size for the thread pool worker - threads. + \brief the stack size for the thread pool worker threads. The value of the property is only used when the thread pool creates new threads. Changing it has no effect for already created |