summaryrefslogtreecommitdiffstats
path: root/src/corelib
diff options
context:
space:
mode:
authorVolker Hilsheimer <volker.hilsheimer@qt.io>2020-09-22 16:40:50 +0200
committerVolker Hilsheimer <volker.hilsheimer@qt.io>2020-09-22 20:55:22 +0200
commit55f4a4e6f02febdb7732fdc7b193293555242237 (patch)
tree9c534805dd568b2c157ae2222aebf9ca3790e7ac /src/corelib
parentfc8f5afc874073f91d3770273e0a9164182d7897 (diff)
Fix various qdoc warnings
Parameter types and names, missing enum values, and \since 6.0. Change-Id: I1b028fcf2ef0b57accb1ef7cebf17dab9f6d571e Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/corelib')
-rw-r--r--src/corelib/kernel/qabstracteventdispatcher.cpp2
-rw-r--r--src/corelib/kernel/qvariant.cpp8
-rw-r--r--src/corelib/serialization/qdatastream.cpp13
-rw-r--r--src/corelib/tools/qrect.cpp4
4 files changed, 16 insertions, 11 deletions
diff --git a/src/corelib/kernel/qabstracteventdispatcher.cpp b/src/corelib/kernel/qabstracteventdispatcher.cpp
index 4552e819de..3c18ff95eb 100644
--- a/src/corelib/kernel/qabstracteventdispatcher.cpp
+++ b/src/corelib/kernel/qabstracteventdispatcher.cpp
@@ -249,7 +249,7 @@ int QAbstractEventDispatcher::registerTimer(qint64 interval, Qt::TimerType timer
}
/*!
- \fn void QAbstractEventDispatcher::registerTimer(int timerId, int interval, Qt::TimerType timerType, QObject *object)
+ \fn void QAbstractEventDispatcher::registerTimer(int timerId, qint64 interval, Qt::TimerType timerType, QObject *object)
Register a timer with the specified \a timerId, \a interval, and \a
timerType for the given \a object.
diff --git a/src/corelib/kernel/qvariant.cpp b/src/corelib/kernel/qvariant.cpp
index e36e926e7b..e97ea3570d 100644
--- a/src/corelib/kernel/qvariant.cpp
+++ b/src/corelib/kernel/qvariant.cpp
@@ -1984,7 +1984,7 @@ QVariantList QVariant::toList() const
\since 6.0
Returns \c true if the variant's type can be cast to the requested
- type, \a targetTypeId. Such casting is done automatically when calling the
+ type, \a type. Such casting is done automatically when calling the
toInt(), toBool(), ... methods.
\sa QMetaType::canConvert()
@@ -2015,7 +2015,7 @@ QVariantList QVariant::toList() const
*/
/*!
- Casts the variant to the requested type, \a targetTypeId. If the cast cannot be
+ Casts the variant to the requested type, \a targetType. If the cast cannot be
done, the variant is still changed to the requested type, but is left in a cleared
null state similar to that constructed by QVariant(Type).
@@ -2024,7 +2024,7 @@ QVariantList QVariant::toList() const
A QVariant containing a pointer to a type derived from QObject will also convert
and return true for this function if a qobject_cast to the type described
- by \a targetTypeId would succeed. Note that this only works for QObject subclasses
+ by \a targetType would succeed. Note that this only works for QObject subclasses
which use the Q_OBJECT macro.
\note converting QVariants that are null due to not being initialized or having
@@ -2141,7 +2141,7 @@ bool QVariant::view(int type, void *ptr)
\li If one type is numeric and the other one a QString, Qt will try to
convert the QString to a matching numeric type and if successful compare
those.
- \i If both variants contain pointers to QObject derived types, QVariant
+ \li If both variants contain pointers to QObject derived types, QVariant
will check whether the types are related and point to the same object.
\endlist
*/
diff --git a/src/corelib/serialization/qdatastream.cpp b/src/corelib/serialization/qdatastream.cpp
index c490bfa70d..0c38e1c247 100644
--- a/src/corelib/serialization/qdatastream.cpp
+++ b/src/corelib/serialization/qdatastream.cpp
@@ -554,6 +554,7 @@ void QDataStream::setByteOrder(ByteOrder bo)
\value Qt_5_13 Version 19 (Qt 5.13)
\value Qt_5_14 Same as Qt_5_13
\value Qt_5_15 Same as Qt_5_13
+ \value Qt_6_0 Version 20 (Qt 6.0)
\omitvalue Qt_DefaultCompiledVersion
\sa setVersion(), version()
@@ -1021,9 +1022,11 @@ QDataStream &QDataStream::operator>>(char *&s)
}
/*!
- \overload
+ \overload
+ \since 6.0
- Reads a char from the stream into char \a chr.
+ Reads a 16bit wide char from the stream into \a c and
+ returns a reference to the stream.
*/
QDataStream &QDataStream::operator>>(char16_t &c)
{
@@ -1034,9 +1037,11 @@ QDataStream &QDataStream::operator>>(char16_t &c)
}
/*!
- \overload
+ \overload
+ \since 6.0
- Reads a char from the stream into char \a chr.
+ Reads a 32bit wide character from the stream into \a c and
+ returns a reference to the stream.
*/
QDataStream &QDataStream::operator>>(char32_t &c)
{
diff --git a/src/corelib/tools/qrect.cpp b/src/corelib/tools/qrect.cpp
index 45af85a4df..79d00a6fde 100644
--- a/src/corelib/tools/qrect.cpp
+++ b/src/corelib/tools/qrect.cpp
@@ -1228,8 +1228,8 @@ bool QRect::intersects(const QRect &r) const noexcept
/*!
\fn static QRect QRect::span(const QPoint &p1, const QPoint &p2)
- Returns a rectangle spanning the two points, including both and everything
- in between.
+ Returns a rectangle spanning the two points \a p1 and \a p2, including both and
+ everything in between.
\since 6.0
*/