1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Fix qdoc warnings

Browse Source 
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>
This commit is contained in:
Venugopal Shivashankar 2021-10-20 14:50:02 +02:00
parent a7d1c48ca3
commit b50ee930c7
4 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/corelib/kernel/qmetatype.cpp
View File

@ -1601,7 +1601,7 @@ Q_GLOBAL_STATIC(QMetaTypeMutableViewRegistry, customTypesMutableViewRegistry)
Registers the possibility of an implicit conversion from type From to type To in the meta
type system. Returns \c true if the registration succeeded, otherwise false.
\snippet qmetatype/registerConverters.cpp [implicit]
\snippet qmetatype/registerConverters.cpp implicit
*/
/*!
@ -1611,7 +1611,7 @@ Q_GLOBAL_STATIC(QMetaTypeMutableViewRegistry, customTypesMutableViewRegistry)
Registers a method \a function like To From::function() const as converter from type From
to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false.
\snippet qmetatype/registerConverters.cpp [member]
\snippet qmetatype/registerConverters.cpp member
*/
/*!
@ -1622,7 +1622,7 @@ Q_GLOBAL_STATIC(QMetaTypeMutableViewRegistry, customTypesMutableViewRegistry)
to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false.
The \a ok pointer can be used by the function to indicate whether the conversion succeeded.
\snippet qmetatype/registerConverters.cpp [memberOk]
\snippet qmetatype/registerConverters.cpp memberOk
*/
@ -1635,7 +1635,7 @@ Q_GLOBAL_STATIC(QMetaTypeMutableViewRegistry, customTypesMutableViewRegistry)
\a function must take an instance of type \a From and return an instance of \a To. It can be a function
pointer, a lambda or a functor object.
\snippet qmetatype/registerConverters.cpp [unaryfunc]
\snippet qmetatype/registerConverters.cpp unaryfunc
*/
/*!

2
src/corelib/text/qbytearraymatcher.cpp
View File

@ -240,7 +240,7 @@ qsizetype QByteArrayMatcher::indexIn(const char *str, qsizetype len, qsizetype f
\since 6.3
\overload
Searches the byte array \a view, from byte position \a from (default
Searches the byte array \a data, from byte position \a from (default
0, i.e. from the first byte), for the byte array pattern() that
was set in the constructor or in the most recent call to
setPattern(). Returns the position where the pattern() matched in

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

@ -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()
*/

2
src/corelib/time/qdatetime.cpp
View File

@ -1900,7 +1900,7 @@ QString QTime::toString(Qt::DateFormat format) const
\li Use AM/PM display (since 6.3). \c aP/Ap will be replaced by 'AM' or
'PM'. In localized forms (only relevant to
\l{QLocale::toString()}), the locale-appropriate text (returned by
\l{QLocale::amText()} or \l{QLocaleie:pmText()}) is used without
\l{QLocale::amText()} or \l{QLocale::pmText()}) is used without
change of case.
\row \li t \li The timezone (for example "CEST")
\endtable