diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2021-10-20 14:50:02 +0200 |
|---|---|---|
| committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2021-10-23 03:08:58 +0200 |
| commit | b50ee930c74dfd1137d26b91fb4eb17ee7a6a340 (patch) | |
| tree | 759bc7b2dd50012c86f7559289ddda6620751193 /src/corelib/thread/qsemaphore.cpp | |
| parent | a7d1c48ca3162a805708d059da87ca3d742863f1 (diff) | |
Doc: Fix qdoc warnings
src/corelib/kernel/qmetatype.cpp:1605: (qdoc) warning: Command '\snippet (//! [[implicit]])' failed at end of file 'qmetatyp>
src/corelib/kernel/qmetatype.cpp:1615: (qdoc) warning: Command '\snippet (//! [[member]])' failed at end of file 'qmetatype/>
src/corelib/kernel/qmetatype.cpp:1626: (qdoc) warning: Command '\snippet (//! [[memberOk]])' failed at end of file 'qmetatyp>
src/corelib/kernel/qmetatype.cpp:1639: (qdoc) warning: Command '\snippet (//! [[unaryfunc]])' failed at end of file 'qmetaty>
src/corelib/text/qbytearraymatcher.cpp:233: (qdoc) warning: No such parameter 'view' in QByteArrayMatcher::indexIn()
src/corelib/time/qdatetime.cpp:1854: (qdoc) warning: Can't link to 'QLocaleie:pmText()'
src/corelib/thread/qsemaphore.cpp:494: (qdoc) warning: Undocumented return value (hint: use 'return' or 'returns' in the text
src/corelib/thread/qsemaphore.cpp:505: (qdoc) warning: Undocumented parameter 'timeout' in QSemaphore::try_acquire_for()
src/corelib/thread/qsemaphore.cpp:505: (qdoc) warning: Undocumented return value (hint: use 'return' or 'returns' in the text
src/corelib/thread/qsemaphore.cpp:516: (qdoc) warning: Undocumented parameter 'tp' in QSemaphore::try_acquire_until()
src/corelib/thread/qsemaphore.cpp:516: (qdoc) warning: Undocumented return value (hint: use 'return' or 'returns' in the text
Change-Id: Ib612c69525ec7542f2ad3dd9a07e89f266718fd8
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'src/corelib/thread/qsemaphore.cpp')
| -rw-r--r-- | src/corelib/thread/qsemaphore.cpp | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/src/corelib/thread/qsemaphore.cpp b/src/corelib/thread/qsemaphore.cpp index 898b15ae2d..0f1c7c2eb8 100644 --- a/src/corelib/thread/qsemaphore.cpp +++ b/src/corelib/thread/qsemaphore.cpp @@ -497,7 +497,8 @@ bool QSemaphore::tryAcquire(int n, int timeout) This function is provided for \c{std::counting_semaphore} compatibility. - It is equivalent to calling \c{tryAcquire(1)}. + It is equivalent to calling \c{tryAcquire(1)}, where the function returns + \c true on acquiring the resource successfully. \sa tryAcquire(), try_acquire_for(), try_acquire_until() */ @@ -508,7 +509,9 @@ bool QSemaphore::tryAcquire(int n, int timeout) This function is provided for \c{std::counting_semaphore} compatibility. - It is equivalent to calling \c{tryAcquire(1, timeout)}. + It is equivalent to calling \c{tryAcquire(1, timeout)}, where the call + times out on the given \a timeout value. The function returns \c true + on accquiring the resource successfully. \sa tryAcquire(), try_acquire(), try_acquire_until() */ @@ -520,7 +523,9 @@ bool QSemaphore::tryAcquire(int n, int timeout) This function is provided for \c{std::counting_semaphore} compatibility. It is equivalent to calling \c{tryAcquire(1, tp - Clock::now())}, - which means that adjustments to \c{Clock} are ignored while waiting. + which means that the \a tp (time point) is recorded, ignoring the + adjustments to \c{Clock} while waiting. The function returns \c true + on acquiring the resource successfully. \sa tryAcquire(), try_acquire(), try_acquire_for() */ |