From ab420484e7566bb0ccfbb06b98e4b88a49048a71 Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Fri, 16 Jun 2017 16:18:16 +0200 Subject: Fix some qdoc warnings for 5.10 Fix comments for QRandomGenerator. src/corelib/io/qprocess.cpp:453: warning: Cannot find 'startDetached(...)' in '\fn' bool QProcessPrivate::startDetached(const QString &program, const QStringList &arguments, const QString &workingDirectory, qint64 *pid) src/corelib/tools/qstringiterator.qdoc:122: warning: Cannot find 'QStringIterator(...)' in '\fn' QStringIterator::QStringIterator(QStringView string, QStringView::size_type idx) src/corelib/global/qrandom.cpp:902: warning: Can't link to 'QRandomGenerator' src/sql/kernel/qsqlerror.cpp:123: warning: Unknown command '\other' src/network/kernel/qhostinfo.cpp:296: warning: Unknown command '\other' src/gui/kernel/qplatformcursor.cpp:97: warning: Cannot find 'QPlatformCursor::OverrideCursor' specified with '\enum' in any header file src/network/access/qnetworkreply.cpp:307: warning: Can't link to 'QNetworkAccessManager::setRedirectsPolicy()' src/network/access/qnetworkreply.cpp:307: warning: Can't link to 'QNetworkRequest::RedirectsPolicyAttribute' Change-Id: Ibc2455b1b657716dfb6192615738dc7f924dbab3 Reviewed-by: Thiago Macieira --- src/corelib/global/qrandom.cpp | 54 +++++++++++++++++----------------- src/corelib/io/qprocess.cpp | 5 ---- src/corelib/tools/qstringiterator.qdoc | 2 +- src/gui/kernel/qplatformcursor.cpp | 2 +- src/network/access/qnetworkreply.cpp | 4 +-- src/network/kernel/qhostinfo.cpp | 2 +- src/sql/kernel/qsqlerror.cpp | 2 +- 7 files changed, 33 insertions(+), 38 deletions(-) diff --git a/src/corelib/global/qrandom.cpp b/src/corelib/global/qrandom.cpp index 0601dbdb30..83a309b143 100644 --- a/src/corelib/global/qrandom.cpp +++ b/src/corelib/global/qrandom.cpp @@ -381,7 +381,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) } } -/** +/*! \class QRandomGenerator \inmodule QtCore \since 5.10 @@ -482,13 +482,13 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa QRandomGenerator64, qrand() */ -/** +/*! \fn QRandomGenerator::QRandomGenerator() \internal Defaulted constructor, does nothing. */ -/** +/*! \typedef QRandomGenerator::result_type A typedef to the type that operator()() returns. That is, quint32. @@ -496,7 +496,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa operator()() */ -/** +/*! \fn result_type QRandomGenerator::operator()() Generates a 32-bit random quantity and returns it. @@ -504,7 +504,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa QRandomGenerator::get32(), QRandomGenerator::get64() */ -/** +/*! \fn double QRandomGenerator::entropy() const Returns the estimate of the entropy in the random generator source. @@ -521,7 +521,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) this function always returns 0.0. */ -/** +/*! \fn result_type QRandomGenerator::min() Returns the minimum value that QRandomGenerator may ever generate. That is, 0. @@ -529,7 +529,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa max(), QRandomGenerator64::max() */ -/** +/*! \fn result_type QRandomGenerator::max() Returns the maximum value that QRandomGenerator may ever generate. That is, @@ -538,7 +538,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa min(), QRandomGenerator64::max() */ -/** +/*! \fn void QRandomGenerator::generate(ForwardIterator begin, ForwardIterator end) Generates 32-bit quantities and stores them in the range between \a begin @@ -567,7 +567,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa fillRange() */ -/** +/*! \fn void QRandomGenerator::generate(quint32 *begin, quint32 *end) \overload \internal @@ -575,7 +575,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) Same as the other overload, but more efficiently fills \a begin to \a end. */ -/** +/*! \fn void QRandomGenerator::fillRange(UInt *buffer, qssize_t count) Generates \a count 32- or 64-bit quantities (depending on the type \c UInt) @@ -595,7 +595,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa generate() */ -/** +/*! \fn void QRandomGenerator::fillRange(UInt (&buffer)[N}) Generates \c N 32- or 64-bit quantities (depending on the type \c UInt) and @@ -616,7 +616,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa generate() */ -/** +/*! \fn qreal QRandomGenerator::getReal() Generates one random qreal in the canonical range [0, 1) (that is, @@ -635,7 +635,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa get32(), get64(), bounded() */ -/** +/*! \fn qreal QRandomGenerator::bounded(qreal sup) Generates one random qreal in the range between 0 (inclusive) and \a @@ -648,7 +648,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa getReal(), bounded() */ -/** +/*! \fn quint32 QRandomGenerator::bounded(quint32 sup) \overload @@ -673,7 +673,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa get32(), get64(), getReal() */ -/** +/*! \fn quint32 QRandomGenerator::bounded(int sup) \overload @@ -686,7 +686,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa get32(), get64(), getReal() */ -/** +/*! \fn quint32 QRandomGenerator::bounded(quint32 min, quint32 sup) \overload @@ -710,7 +710,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa get32(), get64(), getReal() */ -/** +/*! \fn quint32 QRandomGenerator::bounded(int min, int sup) \overload @@ -723,7 +723,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa get32(), get64(), getReal() */ -/** +/*! \class QRandomGenerator64 \inmodule QtCore \since 5.10 @@ -743,13 +743,13 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa QRandomGenerator */ -/** +/*! \fn QRandomGenerator64::QRandomGenerator64() \internal Defaulted constructor, does nothing. */ -/** +/*! \typedef QRandomGenerator64::result_type A typedef to the type that operator()() returns. That is, quint64. @@ -757,7 +757,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa operator()() */ -/** +/*! \fn result_type QRandomGenerator64::operator()() Generates a 64-bit random quantity and returns it. @@ -765,7 +765,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa QRandomGenerator::get32(), QRandomGenerator::get64() */ -/** +/*! \fn double QRandomGenerator64::entropy() const Returns the estimate of the entropy in the random generator source. @@ -782,7 +782,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) this function always returns 0.0. */ -/** +/*! \fn result_type QRandomGenerator64::min() Returns the minimum value that QRandomGenerator64 may ever generate. That is, 0. @@ -790,7 +790,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa max(), QRandomGenerator::max() */ -/** +/*! \fn result_type QRandomGenerator64::max() Returns the maximum value that QRandomGenerator64 may ever generate. That is, @@ -799,7 +799,7 @@ static Q_NEVER_INLINE void fill(void *buffer, void *bufferEnd) \sa min(), QRandomGenerator::max() */ -/** +/*! Generates one 32-bit random value and returns it. \sa get64(), getReal() @@ -811,7 +811,7 @@ quint32 QRandomGenerator::get32() return ret; } -/** +/*! Generates one 64-bit random value and returns it. \sa get32(), getReal(), QRandomGenerator64 @@ -823,7 +823,7 @@ quint64 QRandomGenerator::get64() return ret; } -/** +/*! \internal Fills the range pointed by \a buffer and \a bufferEnd with 32-bit random diff --git a/src/corelib/io/qprocess.cpp b/src/corelib/io/qprocess.cpp index 9da0fe59b5..e3e26654b1 100644 --- a/src/corelib/io/qprocess.cpp +++ b/src/corelib/io/qprocess.cpp @@ -450,11 +450,6 @@ void QProcessPrivate::Channel::clear() process = 0; } -/*! \fn bool QProcessPrivate::startDetached(const QString &program, const QStringList &arguments, const QString &workingDirectory, qint64 *pid) - -\internal - */ - /*! \class QProcess \inmodule QtCore diff --git a/src/corelib/tools/qstringiterator.qdoc b/src/corelib/tools/qstringiterator.qdoc index ae3ad53653..95c2247bc1 100644 --- a/src/corelib/tools/qstringiterator.qdoc +++ b/src/corelib/tools/qstringiterator.qdoc @@ -120,7 +120,7 @@ */ /*! - \fn QStringIterator::QStringIterator(QStringView string, QStringView::size_type idx) + \fn QStringIterator::QStringIterator(QStringView string, qssize_t idx) Constructs an iterator over the contents of \a string. The iterator will point before position \a idx in the string. diff --git a/src/gui/kernel/qplatformcursor.cpp b/src/gui/kernel/qplatformcursor.cpp index 9d2d65246e..e6cf6a8216 100644 --- a/src/gui/kernel/qplatformcursor.cpp +++ b/src/gui/kernel/qplatformcursor.cpp @@ -95,7 +95,7 @@ QT_BEGIN_NAMESPACE */ /*! - \enum QPlatformCursor::OverrideCursor + \enum QPlatformCursor::Capability \since 5.10 \value OverrideCursor Indicates that the platform implements diff --git a/src/network/access/qnetworkreply.cpp b/src/network/access/qnetworkreply.cpp index 8671086351..cabea86521 100644 --- a/src/network/access/qnetworkreply.cpp +++ b/src/network/access/qnetworkreply.cpp @@ -314,8 +314,8 @@ QNetworkReplyPrivate::QNetworkReplyPrivate() QNetworkRequest::UserVerifiedRedirectPolicy \sa QNetworkRequest::UserVerifiedRedirectPolicy, - QNetworkAccessManager::setRedirectsPolicy(), - QNetworkRequest::RedirectsPolicyAttribute + QNetworkAccessManager::setRedirectPolicy(), + QNetworkRequest::RedirectPolicyAttribute */ /*! diff --git a/src/network/kernel/qhostinfo.cpp b/src/network/kernel/qhostinfo.cpp index d2e61778ec..0156e22d41 100644 --- a/src/network/kernel/qhostinfo.cpp +++ b/src/network/kernel/qhostinfo.cpp @@ -293,7 +293,7 @@ int QHostInfo::lookupHost(const QString &name, QObject *receiver, /*! \fn void QHostInfo::swap(QHostInfo &other) - Swaps host-info \other with this host-info. This operation is + Swaps host-info \a other with this host-info. This operation is very fast and never fails. \since 5.10 diff --git a/src/sql/kernel/qsqlerror.cpp b/src/sql/kernel/qsqlerror.cpp index 1427f58327..50b10aab40 100644 --- a/src/sql/kernel/qsqlerror.cpp +++ b/src/sql/kernel/qsqlerror.cpp @@ -120,7 +120,7 @@ public: */ /*! \fn QSqlError::swap(QSqlError &other) - Swaps error \other with this error. This operation is very fast + Swaps error \a other with this error. This operation is very fast and never fails. \since 5.10 -- cgit v1.2.3