diff --git a/doc/global/manifest-meta.qdocconf b/doc/global/manifest-meta.qdocconf index 32b8739215c..d1b069cd5d8 100644 --- a/doc/global/manifest-meta.qdocconf +++ b/doc/global/manifest-meta.qdocconf @@ -108,7 +108,7 @@ manifestmeta.android.tags = android manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \ "QtCore/Mandelbrot Example" \ - "QtCore/Queued Custom Type Example" \ + "QtCore/Queued Custom Type" \ "QtGui/OpenGL Window Example" \ "QtGui/Raster Window Example" \ "QtNetwork/Network Chat Example" \ @@ -201,7 +201,6 @@ manifestmeta.ios.tags = ios manifestmeta.thumbnail.attributes = "imageUrl:qthelp\://org.qt-project.qtdoc.$QT_VERSION_TAG/qtdoc/images/qt-codesample.png" manifestmeta.thumbnail.names = "QtCore/Contiguous Cache Example" \ - "QtCore/Custom Type Example" \ "QtCore/Saving and Loading a Game" \ "QtCore/Producer and Consumer using Semaphores" \ "QtCore/Producer and Consumer using Wait Conditions" \ diff --git a/examples/corelib/serialization/convert/doc/src/convert.qdoc b/examples/corelib/serialization/convert/doc/src/convert.qdoc index 2e10817fde6..187e81a85e3 100644 --- a/examples/corelib/serialization/convert/doc/src/convert.qdoc +++ b/examples/corelib/serialization/convert/doc/src/convert.qdoc @@ -19,7 +19,7 @@ \image convert.png - \sa {Parsing and displaying CBOR data}, {JSON Save Game} + \sa {Parsing and displaying CBOR data}, {Saving and Loading a Game} \section1 The Converter Class diff --git a/examples/corelib/threads/doc/src/queuedcustomtype.qdoc b/examples/corelib/threads/doc/src/queuedcustomtype.qdoc index 88105282009..8d56695c797 100644 --- a/examples/corelib/threads/doc/src/queuedcustomtype.qdoc +++ b/examples/corelib/threads/doc/src/queuedcustomtype.qdoc @@ -18,20 +18,15 @@ \section1 Overview - In the \l{Custom Type Example}, we showed how to integrate custom types with - the meta-object system, enabling them to be stored in QVariant objects, written - out in debugging information and used in signal-slot communication. - - In this example, we create a new value class, \c Block, and register it - with the meta-object system to enable us to send instances of it between - threads using queued signals and slots. + In this example, we create a value class, \c Block, and register it with + the meta-object system to enable us to send instances of it between threads + using queued signals and slots. \section1 The Block Class - The \c Block class is similar to the \c Message class described in the - \l{Custom Type Example}. It provides the default constructor, copy - constructor and destructor in the public section of the class that the - meta-object system requires. It describes a colored rectangle. + The \c Block class provides the default constructor, copy constructor, and + a destructor in the public section of the class as required by the + meta-object system. The class describes a colored rectangle. \snippet threads/queuedcustomtype/block.h custom type definition and meta-type declaration @@ -127,9 +122,7 @@ This example showed how a custom type can be registered with the meta-object system so that it can be used with signal-slot connections - between threads. For ordinary communication involving direct signals and - slots, it is enough to simply declare the type in the way described in the - \l{Custom Type Example}. + between threads. In practice, both the Q_DECLARE_METATYPE() macro and the qRegisterMetaType() template function can be used to register custom types, but diff --git a/src/corelib/global/qcompare.cpp b/src/corelib/global/qcompare.cpp index 87595eb1d15..fadcb0f1a26 100644 --- a/src/corelib/global/qcompare.cpp +++ b/src/corelib/global/qcompare.cpp @@ -1138,7 +1138,7 @@ CHECK(strong, equivalent); */ /*! - \fn template = true> Qt::compareThreeWay(LeftInt lhs, RightInt rhs) + \fn template = true, Qt::if_integral = true> auto Qt::compareThreeWay(LeftInt lhs, RightInt rhs) \since 6.7 \relates \overload @@ -1176,7 +1176,7 @@ CHECK(strong, equivalent); */ /*! - \fn template = true> Qt::compareThreeWay(LeftFloat lhs, RightFloat rhs) + \fn template = true, Qt::if_floating_point = true> auto Qt::compareThreeWay(LeftFloat lhs, RightFloat rhs) \since 6.7 \relates \overload @@ -1215,7 +1215,7 @@ CHECK(strong, equivalent); */ /*! - \fn template = true> Qt::compareThreeWay(IntType lhs, FloatType rhs) + \fn template = true, Qt::if_floating_point = true> auto Qt::compareThreeWay(IntType lhs, FloatType rhs) \since 6.7 \relates \overload @@ -1235,7 +1235,7 @@ CHECK(strong, equivalent); */ /*! - \fn template = true> Qt::compareThreeWay(FloatType lhs, IntType rhs) + \fn template = true, Qt::if_integral = true> auto Qt::compareThreeWay(FloatType lhs, IntType rhs) \since 6.7 \relates \overload diff --git a/src/corelib/io/qdebug.cpp b/src/corelib/io/qdebug.cpp index ca5da100229..ad967398fb5 100644 --- a/src/corelib/io/qdebug.cpp +++ b/src/corelib/io/qdebug.cpp @@ -985,8 +985,8 @@ QDebug &QDebug::resetFormat() */ /*! - \fn template > QDebug::operator<<(T i) - \fn template > QDebug::operator<<(T i) + \fn template > QDebug::operator<<(T i) + \fn template > QDebug::operator<<(T i) \since 6.7 Prints the textual representation of the 128-bit integer \a i. diff --git a/src/corelib/io/qfileinfo.cpp b/src/corelib/io/qfileinfo.cpp index ee0b2bcc0a8..8d252157f9b 100644 --- a/src/corelib/io/qfileinfo.cpp +++ b/src/corelib/io/qfileinfo.cpp @@ -1496,7 +1496,9 @@ qint64 QFileInfo::size() const (not the symlink). \since 6.6 - \sa lastModified(const QTimeZone &), lastRead(const QTimeZone &), metadataChangeTime(const QTimeZone &), fileTime(QFile::FileTime, const QTimeZone &) + \sa lastModified(const QTimeZone &), lastRead(const QTimeZone &), + metadataChangeTime(const QTimeZone &), + fileTime(QFileDevice::FileTime, const QTimeZone &) */ /*! @@ -1533,8 +1535,9 @@ qint64 QFileInfo::size() const (not the symlink). \since 6.6 - \sa birthTime(const QTimeZone &), lastModified(const QTimeZone &), lastRead(const QTimeZone &), - fileTime(QFile::FileTime time, const QTimeZone &) + \sa birthTime(const QTimeZone &), lastModified(const QTimeZone &), + lastRead(const QTimeZone &), + fileTime(QFileDevice::FileTime time, const QTimeZone &) */ /*! @@ -1562,7 +1565,9 @@ qint64 QFileInfo::size() const (not the symlink). \since 6.6 - \sa birthTime(const QTimeZone &), lastRead(const QTimeZone &), metadataChangeTime(const QTimeZone &), fileTime(QFile::FileTime, const QTimeZone &) + \sa birthTime(const QTimeZone &), lastRead(const QTimeZone &), + metadataChangeTime(const QTimeZone &), + fileTime(QFileDevice::FileTime, const QTimeZone &) */ /*! @@ -1596,7 +1601,9 @@ qint64 QFileInfo::size() const (not the symlink). \since 6.6 - \sa birthTime(const QTimeZone &), lastModified(const QTimeZone &), metadataChangeTime(const QTimeZone &), fileTime(QFile::FileTime, const QTimeZone &) + \sa birthTime(const QTimeZone &), lastModified(const QTimeZone &), + metadataChangeTime(const QTimeZone &), + fileTime(QFileDevice::FileTime, const QTimeZone &) */ #if QT_VERSION < QT_VERSION_CHECK(7, 0, 0) && !defined(QT_BOOTSTRAPPED) @@ -1609,7 +1616,7 @@ qint64 QFileInfo::size() const (not the symlink). This function overloads - \l{QFileInfo::fileTime(QFile::FileTime, const QTimeZone &)}, + \l{QFileInfo::fileTime(QFileDevice::FileTime, const QTimeZone &)}, and returns the same as \c{fileTime(time, QTimeZone::LocalTime)}. \since 5.10 @@ -1637,7 +1644,9 @@ QDateTime QFileInfo::fileTime(QFile::FileTime time) const { (not the symlink). \since 6.6 - \sa birthTime(const QTimeZone &), lastModified(const QTimeZone &), lastRead(const QTimeZone &), metadataChangeTime(const QTimeZone &), QDateTime::isValid() + \sa birthTime(const QTimeZone &), lastModified(const QTimeZone &), + lastRead(const QTimeZone &), metadataChangeTime(const QTimeZone &), + QDateTime::isValid() */ QDateTime QFileInfo::fileTime(QFile::FileTime time, const QTimeZone &tz) const { diff --git a/src/corelib/kernel/qmath.qdoc b/src/corelib/kernel/qmath.qdoc index c15a20d94f8..bc365f26fa6 100644 --- a/src/corelib/kernel/qmath.qdoc +++ b/src/corelib/kernel/qmath.qdoc @@ -132,7 +132,7 @@ \since 6.1 \overload \fn template auto qHypot(Tx x, Ty y) - Returns the distance of a point (x, y) from the origin (0, 0). + Returns the distance of a point (\a x, \a y) from the origin (0, 0). This is qSqrt(x * x + y * y), optimized. In particular, underflow and overflow may be avoided. diff --git a/src/corelib/kernel/qmetaobject.cpp b/src/corelib/kernel/qmetaobject.cpp index a400e2748cb..3d0eeb1683d 100644 --- a/src/corelib/kernel/qmetaobject.cpp +++ b/src/corelib/kernel/qmetaobject.cpp @@ -4150,7 +4150,7 @@ bool QMetaProperty::isBindable() const This mechanism is free for you to use in your Qt applications. \note It's also used by the \l[ActiveQt]{Active Qt}, - \l[QtDBus]{Qt D-Bus}, \l[QtQml]{Qt QML}, and \l{Qt Remote Objects} + \l[QtDBus]{Qt D-Bus}, \l[QtQml]{Qt Qml}, and \l{Qt Remote Objects} modules. Some keys might be set when using these modules. \sa QMetaObject diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp index 69265a42851..3fd588f47b5 100644 --- a/src/corelib/kernel/qobject.cpp +++ b/src/corelib/kernel/qobject.cpp @@ -4418,7 +4418,7 @@ QDebug operator<<(QDebug dbg, const QObject *o) This macro associates extra information to the class, which is available using QObject::metaObject(). Qt makes only limited use of this feature in - \l{Qt D-Bus} and \l{Qt QML} modules. + \l{Qt D-Bus} and \l{Qt Qml} modules. The extra information takes the form of a \a Name string and a \a Value literal string. diff --git a/src/corelib/tools/qcryptographichash.cpp b/src/corelib/tools/qcryptographichash.cpp index 5a321f3a0c4..2e82a394eeb 100644 --- a/src/corelib/tools/qcryptographichash.cpp +++ b/src/corelib/tools/qcryptographichash.cpp @@ -1420,7 +1420,7 @@ void QMessageAuthenticationCodePrivate::initMessageHash() noexcept Use the QMessageAuthenticationCode class to generate hash-based message authentication codes (HMACs). The class supports all cryptographic hash algorithms from \l QCryptographicHash (see also - \l{QCryptographicHash::Algorithms}). + \l{QCryptographicHash::Algorithm}). To generate a message authentication code, pass a suitable hash algorithm and secret key to the constructor. Then process the message @@ -1442,7 +1442,7 @@ void QMessageAuthenticationCodePrivate::initMessageHash() noexcept size of the secret key, and the security of the underlying hash function. - \sa QCryptographicHash, QCryptographicHash::Algorithms + \sa QCryptographicHash, QCryptographicHash::Algorithm */ /*! diff --git a/src/corelib/tools/qspan.qdoc b/src/corelib/tools/qspan.qdoc index 04c8315958e..4e9291adcfe 100644 --- a/src/corelib/tools/qspan.qdoc +++ b/src/corelib/tools/qspan.qdoc @@ -513,7 +513,7 @@ The span must hold at least \c{Count} elements (\c{E} >= \c{Count} \e{and} size() >= \c{Count}), otherwise the behavior is undefined. - \sa first(QSpan::size_type), last(), subspan() + \sa first(QSpan::size_type), last(), subspan() */ /*! @@ -525,7 +525,7 @@ The span must hold at least \c{Count} elements (\c{E} >= \c{Count} \e{and} size() >= \c{Count}), otherwise the behavior is undefined. - \sa last(QSpan::size_type), first(), subspan() + \sa last(QSpan::size_type), first(), subspan() */ /*! @@ -541,7 +541,7 @@ This span must hold at least \c{Offset} elements (\c{E} >= \c{Offset} \e{and} size() >= \c{Offset}), otherwise the behavior is undefined. - \sa subspan(QSpan::size_type), subspan(), first(), last() + \sa subspan(QSpan::size_type), subspan(), first(), last() */ #if 0 // needs fix for QTBUG-118080 integrated into qt5.git @@ -559,7 +559,7 @@ \c{Offset + Count} \e{and} size() >= \c{Offset + Count}), otherwise the behavior is undefined. - \sa subspan(QSpan::size_type, QSpan::size_type), subspan(), first(), last() + \sa subspan(QSpan::size_type, QSpan::size_type), subspan(), first(), last() */ #endif @@ -578,8 +578,8 @@ The span must hold at least \a n elements (\c{E} >= \a n \e{and} size() >= \a n), otherwise the behavior is undefined. - \sa {first-t}{first()}, last(QSpan::size_type), subspan(QSpan::size_type), - subspan(QSpan::size_type, QSpan::size_type) + \sa {first-t}{first()}, last(QSpan::size_type), subspan(QSpan::size_type), + subspan(QSpan::size_type, QSpan::size_type) \sa sliced() */ @@ -594,8 +594,8 @@ The span must hold at least \a n elements (\c{E} >= \a n \e{and} size() >= \a n), otherwise the behavior is undefined. - \sa last(), first(QSpan::size_type), subspan(QSpan::size_type), - subspan(QSpan::size_type, QSpan::size_type), sliced() + \sa last(), first(QSpan::size_type), subspan(QSpan::size_type), + subspan(QSpan::size_type, QSpan::size_type), sliced() */ /*! @@ -614,7 +614,7 @@ These functions do the same thing: subspan() is provided for STL compatibility and sliced() is provided for Qt compatibility. - \sa subspan(), first(QSpan::size_type), last(QSpan::size_type) + \sa subspan(), first(QSpan::size_type), last(QSpan::size_type) */ /*! @@ -634,6 +634,6 @@ These functions do the same thing: subspan() is provided for STL compatibility and sliced() is provided for Qt compatibility. - \sa subspan(), first(QSpan::size_type), last(QSpan::size_type) + \sa subspan(), first(QSpan::size_type), last(QSpan::size_type) */