From 1c8f7082f70af934ddc46b9687a88e02233e1082 Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Tue, 16 Jan 2018 12:38:23 +0100 Subject: doc: Add missing return types to \fn commands, fix mis-specified ones MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This update corrects several qdoc warnings about undocumented parameters, which are actually caused when the return type is not included in the \fn command, or when the return type is mis-specified (includes static, or lacks needed template parameters). Change-Id: Ic49139b88424e93609fbd01bc0836436d13a8f9a Reviewed-by: Topi Reiniö Reviewed-by: Edward Welbourne --- src/corelib/animation/qabstractanimation.cpp | 8 ++++---- src/corelib/thread/qfuture.qdoc | 2 +- src/corelib/thread/qthread.cpp | 4 ++-- src/corelib/tools/qdatetime.cpp | 6 +++--- src/corelib/tools/qline.cpp | 2 +- src/corelib/tools/qlist.cpp | 2 +- src/corelib/tools/qtimeline.cpp | 8 ++++---- src/corelib/tools/qvarlengtharray.qdoc | 4 ++-- src/corelib/tools/qvector.qdoc | 2 +- 9 files changed, 19 insertions(+), 19 deletions(-) (limited to 'src/corelib') diff --git a/src/corelib/animation/qabstractanimation.cpp b/src/corelib/animation/qabstractanimation.cpp index e445037efb..b3db200ed1 100644 --- a/src/corelib/animation/qabstractanimation.cpp +++ b/src/corelib/animation/qabstractanimation.cpp @@ -103,7 +103,7 @@ */ /*! - \fn QAbstractAnimation::finished() + \fn void QAbstractAnimation::finished() QAbstractAnimation emits this signal after the animation has stopped and has reached the end. @@ -114,7 +114,7 @@ */ /*! - \fn QAbstractAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState) + \fn void QAbstractAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState) QAbstractAnimation emits this signal whenever the state of the animation has changed from \a oldState to \a newState. This signal is emitted after the virtual @@ -124,7 +124,7 @@ */ /*! - \fn QAbstractAnimation::currentLoopChanged(int currentLoop) + \fn void QAbstractAnimation::currentLoopChanged(int currentLoop) QAbstractAnimation emits this signal whenever the current loop changes. \a currentLoop is the current loop. @@ -133,7 +133,7 @@ */ /*! - \fn QAbstractAnimation::directionChanged(QAbstractAnimation::Direction newDirection); + \fn void QAbstractAnimation::directionChanged(QAbstractAnimation::Direction newDirection); QAbstractAnimation emits this signal whenever the direction has been changed. \a newDirection is the new direction. diff --git a/src/corelib/thread/qfuture.qdoc b/src/corelib/thread/qfuture.qdoc index 8d5b7c776c..e607d090c5 100644 --- a/src/corelib/thread/qfuture.qdoc +++ b/src/corelib/thread/qfuture.qdoc @@ -590,7 +590,7 @@ \sa operator=() */ -/*! \fn template QFutureIterator &QFutureIterator::operator=(const QFuture &future) +/*! \fn template QFutureIterator &QFutureIterator::operator=(const QFuture &future) Makes the iterator operate on \a future. The iterator is set to be at the front of the result list (before the first result). diff --git a/src/corelib/thread/qthread.cpp b/src/corelib/thread/qthread.cpp index adff853669..8c9cbbff63 100644 --- a/src/corelib/thread/qthread.cpp +++ b/src/corelib/thread/qthread.cpp @@ -892,7 +892,7 @@ bool QThread::isInterruptionRequested() const } /* - \fn template static QThread *QThread::create(Function &&f, Args &&... args) + \fn template QThread *QThread::create(Function &&f, Args &&... args) \since 5.10 Creates a new QThread object that will execute the function \a f with the @@ -916,7 +916,7 @@ bool QThread::isInterruptionRequested() const */ /* - \fn template static QThread *QThread::create(Function &&f) + \fn template QThread *QThread::create(Function &&f) \since 5.10 Creates a new QThread object that will execute the function \a f. diff --git a/src/corelib/tools/qdatetime.cpp b/src/corelib/tools/qdatetime.cpp index fccf1c4afa..df5e4e44e4 100644 --- a/src/corelib/tools/qdatetime.cpp +++ b/src/corelib/tools/qdatetime.cpp @@ -1272,7 +1272,7 @@ QDate QDate::fromString(const QString& string, Qt::DateFormat format) } /*! - \fn QDate::fromString(const QString &string, const QString &format) + \fn QDate QDate::fromString(const QString &string, const QString &format) Returns the QDate represented by the \a string, using the \a format given, or an invalid date if the string cannot be parsed. @@ -2000,7 +2000,7 @@ QTime QTime::fromString(const QString& string, Qt::DateFormat format) } /*! - \fn QTime::fromString(const QString &string, const QString &format) + \fn QTime QTime::fromString(const QString &string, const QString &format) Returns the QTime represented by the \a string, using the \a format given, or an invalid time if the string cannot be parsed. @@ -4944,7 +4944,7 @@ QDateTime QDateTime::fromString(const QString& string, Qt::DateFormat format) } /*! - \fn QDateTime::fromString(const QString &string, const QString &format) + \fn QDateTime QDateTime::fromString(const QString &string, const QString &format) Returns the QDateTime represented by the \a string, using the \a format given, or an invalid datetime if the string cannot be parsed. diff --git a/src/corelib/tools/qline.cpp b/src/corelib/tools/qline.cpp index 8942292a3d..9704a00b85 100644 --- a/src/corelib/tools/qline.cpp +++ b/src/corelib/tools/qline.cpp @@ -508,7 +508,7 @@ QDataStream &operator>>(QDataStream &stream, QLine &line) */ /*! - \fn QLineF::setLength(qreal length) + \fn void QLineF::setLength(qreal length) Sets the length of the line to the given \a length. QLineF will move the end point - p2() - of the line to give the line its new length. diff --git a/src/corelib/tools/qlist.cpp b/src/corelib/tools/qlist.cpp index c01d0c2d61..33835e3d28 100644 --- a/src/corelib/tools/qlist.cpp +++ b/src/corelib/tools/qlist.cpp @@ -757,7 +757,7 @@ void **QListData::erase(void **xi) Same as at(). This function runs in \l{Algorithmic Complexity}{constant time}. */ -/*! \fn template QList::reserve(int alloc) +/*! \fn template void QList::reserve(int alloc) Reserve space for \a alloc elements. diff --git a/src/corelib/tools/qtimeline.cpp b/src/corelib/tools/qtimeline.cpp index e70e7f8e16..fa6c45aa11 100644 --- a/src/corelib/tools/qtimeline.cpp +++ b/src/corelib/tools/qtimeline.cpp @@ -269,7 +269,7 @@ void QTimeLinePrivate::setCurrentTime(int msecs) */ /*! - \fn QTimeLine::valueChanged(qreal value) + \fn void QTimeLine::valueChanged(qreal value) QTimeLine emits this signal at regular intervals when in \l Running state, but only if the current value changes. \a value is the current value. \a value is @@ -279,7 +279,7 @@ void QTimeLinePrivate::setCurrentTime(int msecs) */ /*! - \fn QTimeLine::frameChanged(int frame) + \fn void QTimeLine::frameChanged(int frame) QTimeLine emits this signal at regular intervals when in \l Running state, but only if the current frame changes. \a frame is the current frame number. @@ -288,14 +288,14 @@ void QTimeLinePrivate::setCurrentTime(int msecs) */ /*! - \fn QTimeLine::stateChanged(QTimeLine::State newState) + \fn void QTimeLine::stateChanged(QTimeLine::State newState) This signal is emitted whenever QTimeLine's state changes. The new state is \a newState. */ /*! - \fn QTimeLine::finished() + \fn void QTimeLine::finished() This signal is emitted when QTimeLine finishes (i.e., reaches the end of its time line), and does not loop. diff --git a/src/corelib/tools/qvarlengtharray.qdoc b/src/corelib/tools/qvarlengtharray.qdoc index 7c63871ea9..ef2fffa44c 100644 --- a/src/corelib/tools/qvarlengtharray.qdoc +++ b/src/corelib/tools/qvarlengtharray.qdoc @@ -818,7 +818,7 @@ of \c operator<(). */ -/*! \fn template QVarLengthArray &QVarLengthArray::operator<<(const T &value) +/*! \fn template QVarLengthArray &QVarLengthArray::operator<<(const T &value) \since 4.8 Appends \a value to the array and returns a reference to this @@ -827,7 +827,7 @@ \sa append(), operator+=() */ -/*! \fn template QVarLengthArray &QVarLengthArray::operator+=(const T &value) +/*! \fn template QVarLengthArray &QVarLengthArray::operator+=(const T &value) \since 4.8 Appends \a value to the array and returns a reference to this vector. diff --git a/src/corelib/tools/qvector.qdoc b/src/corelib/tools/qvector.qdoc index 1068de76d5..089aaec3fd 100644 --- a/src/corelib/tools/qvector.qdoc +++ b/src/corelib/tools/qvector.qdoc @@ -795,7 +795,7 @@ */ -/*! \fn template QVector &QVector::fill(const T &value, int size = -1) +/*! \fn template QVector &QVector::fill(const T &value, int size = -1) Assigns \a value to all items in the vector. If \a size is different from -1 (the default), the vector is resized to size \a -- cgit v1.2.3