From b50ee930c74dfd1137d26b91fb4eb17ee7a6a340 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Wed, 20 Oct 2021 14:50:02 +0200 Subject: Doc: Fix qdoc warnings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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ö --- src/corelib/kernel/qmetatype.cpp | 8 ++++---- src/corelib/text/qbytearraymatcher.cpp | 2 +- src/corelib/thread/qsemaphore.cpp | 11 ++++++++--- src/corelib/time/qdatetime.cpp | 2 +- 4 files changed, 14 insertions(+), 9 deletions(-) diff --git a/src/corelib/kernel/qmetatype.cpp b/src/corelib/kernel/qmetatype.cpp index 4a04e55726..3758d3c941 100644 --- a/src/corelib/kernel/qmetatype.cpp +++ b/src/corelib/kernel/qmetatype.cpp @@ -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 */ /*! diff --git a/src/corelib/text/qbytearraymatcher.cpp b/src/corelib/text/qbytearraymatcher.cpp index 52c77bb267..9f89ef084f 100644 --- a/src/corelib/text/qbytearraymatcher.cpp +++ b/src/corelib/text/qbytearraymatcher.cpp @@ -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 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() */ diff --git a/src/corelib/time/qdatetime.cpp b/src/corelib/time/qdatetime.cpp index 30c83e09d9..a9bd59a156 100644 --- a/src/corelib/time/qdatetime.cpp +++ b/src/corelib/time/qdatetime.cpp @@ -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 -- cgit v1.2.3