AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: fix qdoc warning from wrong function prototypes

Browse Source 
std::chrono values are passed by const reference.

Still warnings from undocumented parameters, but rephrasing
the documentation doesn't make it better in this case, so perhaps
qdoc needs a way to suppress the warning. Adding an \omit block
where the parameters or return values are mentioned doesn't help.

Change-Id: I7d495d73d8367d9d90dd33a4880ac7c978382d19
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Volker Hilsheimer 2021-09-03 16:54:41 +02:00
parent c8dbb177f0
commit eb39b5fd36
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/corelib/thread/qsemaphore.cpp
View File

@ -492,7 +492,7 @@ bool QSemaphore::tryAcquire(int n, int timeout)
*/
/*!
\fn QSemaphore::try_acquire()
\fn bool QSemaphore::try_acquire()
\since 6.3
This function is provided for \c{std::counting_semaphore} compatibility.
@ -503,7 +503,7 @@ bool QSemaphore::tryAcquire(int n, int timeout)
*/
/*!
\fn template <typename Rep, typename Period> QSemaphore::try_acquire_for(std::chrono::duration<Rep, Period> timeout)
\fn template <typename Rep, typename Period> bool QSemaphore::try_acquire_for(const std::chrono::duration<Rep, Period> &timeout)
\since 6.3
This function is provided for \c{std::counting_semaphore} compatibility.
@ -514,12 +514,12 @@ bool QSemaphore::tryAcquire(int n, int timeout)
*/
/*!
\fn template <typename Clock, typename Duration> QSemaphore::try_acquire_until(std::chrono::time_point<Clock, Duration> timeout)
\fn template <typename Clock, typename Duration> bool QSemaphore::try_acquire_until(const std::chrono::time_point<Clock, Duration> &tp)
\since 6.3
This function is provided for \c{std::counting_semaphore} compatibility.
It is equivalent to calling \c{tryAcquire(1, timeout - Clock::now())},
It is equivalent to calling \c{tryAcquire(1, tp - Clock::now())},
which means that adjustments to \c{Clock} are ignored while waiting.
\sa tryAcquire(), try_acquire(), try_acquire_for()