1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Fix documentation issues for Qt Core

Browse Source 
* Fix template arguments in \fn signatures for Qt::compareThreeWay()
  functions.

* Fix template arguments in \fn signatures for QDebug::operator<<()
  functions.

* Fix \sa links to specific overloads of QSpan functions.

* Fix \sa links to specific overloads of QFileInfo::fileTime().

* Remove references to 'Custom Type Example' (example has been removed).

* Fix linking to 'JSON Save Game' example.

* Fix references to 'Queued Custom Type' example.

* Fix linking to QCryptographicHash::Algorithm.

* Fix linking to Qt Qml module.

* Fix undocumented parameters in qHypot().

Change-Id: If9eb9978a14e147f003672a682972b319454c311
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
(cherry picked from commit 96740ea3fed8a7837dc282135661723858fff198)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Topi Reinio 2023-12-19 11:09:32 +00:00 committed by Qt Cherry-pick Bot
parent fa41643a7e
commit 26c10a8863
11 changed files with 46 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/global/manifest-meta.qdocconf
View File

@ -108,7 +108,7 @@ manifestmeta.android.tags = android
manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \ manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \
"QtCore/Mandelbrot Example" \ "QtCore/Mandelbrot Example" \
"QtCore/Queued Custom Type Example" \ "QtCore/Queued Custom Type" \
"QtGui/OpenGL Window Example" \ "QtGui/OpenGL Window Example" \
"QtGui/Raster Window Example" \ "QtGui/Raster Window Example" \
"QtNetwork/Network Chat 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.attributes = "imageUrl:qthelp\://org.qt-project.qtdoc.$QT_VERSION_TAG/qtdoc/images/qt-codesample.png"
manifestmeta.thumbnail.names = "QtCore/Contiguous Cache Example" \ manifestmeta.thumbnail.names = "QtCore/Contiguous Cache Example" \
"QtCore/Custom Type Example" \
"QtCore/Saving and Loading a Game" \ "QtCore/Saving and Loading a Game" \
"QtCore/Producer and Consumer using Semaphores" \ "QtCore/Producer and Consumer using Semaphores" \
"QtCore/Producer and Consumer using Wait Conditions" \ "QtCore/Producer and Consumer using Wait Conditions" \

2
examples/corelib/serialization/convert/doc/src/convert.qdoc
View File

@ -19,7 +19,7 @@
\image convert.png \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 \section1 The Converter Class

21
examples/corelib/threads/doc/src/queuedcustomtype.qdoc
View File

@ -18,20 +18,15 @@
\section1 Overview \section1 Overview
In the \l{Custom Type Example}, we showed how to integrate custom types with In this example, we create a value class, \c Block, and register it with
the meta-object system, enabling them to be stored in QVariant objects, written the meta-object system to enable us to send instances of it between threads
out in debugging information and used in signal-slot communication. using queued signals and slots.
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.
\section1 The Block Class \section1 The Block Class
The \c Block class is similar to the \c Message class described in the The \c Block class provides the default constructor, copy constructor, and
\l{Custom Type Example}. It provides the default constructor, copy a destructor in the public section of the class as required by the
constructor and destructor in the public section of the class that the meta-object system. The class describes a colored rectangle.
meta-object system requires. It describes a colored rectangle.
\snippet threads/queuedcustomtype/block.h custom type definition and meta-type declaration \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 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 meta-object system so that it can be used with signal-slot connections
between threads. For ordinary communication involving direct signals and between threads.
slots, it is enough to simply declare the type in the way described in the
\l{Custom Type Example}.
In practice, both the Q_DECLARE_METATYPE() macro and the qRegisterMetaType() In practice, both the Q_DECLARE_METATYPE() macro and the qRegisterMetaType()
template function can be used to register custom types, but template function can be used to register custom types, but

8
src/corelib/global/qcompare.cpp
View File

@ -1138,7 +1138,7 @@ CHECK(strong, equivalent);
*/ */
/*! /*!
\fn template <typename LeftInt, typename RightInt, Qt::if_integral<LeftInt, RightInt> = true> Qt::compareThreeWay(LeftInt lhs, RightInt rhs) \fn template <typename LeftInt, typename RightInt, Qt::if_integral<LeftInt> = true, Qt::if_integral<RightInt> = true> auto Qt::compareThreeWay(LeftInt lhs, RightInt rhs)
\since 6.7 \since 6.7
\relates <QtCompare> \relates <QtCompare>
\overload \overload
@ -1176,7 +1176,7 @@ CHECK(strong, equivalent);
*/ */
/*! /*!
\fn template <typename LeftFloat, typename RightFloat, Qt::if_floating_point<LeftFloat, RightFloat> = true> Qt::compareThreeWay(LeftFloat lhs, RightFloat rhs) \fn template <typename LeftFloat, typename RightFloat, Qt::if_floating_point<LeftFloat> = true, Qt::if_floating_point<RightFloat> = true> auto Qt::compareThreeWay(LeftFloat lhs, RightFloat rhs)
\since 6.7 \since 6.7
\relates <QtCompare> \relates <QtCompare>
\overload \overload
@ -1215,7 +1215,7 @@ CHECK(strong, equivalent);
*/ */
/*! /*!
\fn template <typename IntType, typename FloatType, Qt::if_integral_and_floating_point<IntType, FloatType> = true> Qt::compareThreeWay(IntType lhs, FloatType rhs) \fn template <typename IntType, typename FloatType, Qt::if_integral<IntType> = true, Qt::if_floating_point<FloatType> = true> auto Qt::compareThreeWay(IntType lhs, FloatType rhs)
\since 6.7 \since 6.7
\relates <QtCompare> \relates <QtCompare>
\overload \overload
@ -1235,7 +1235,7 @@ CHECK(strong, equivalent);
*/ */
/*! /*!
\fn template <typename FloatType, typename IntType, Qt::if_integral_and_floating_point<IntType, FloatType> = true> Qt::compareThreeWay(FloatType lhs, IntType rhs) \fn template <typename FloatType, typename IntType, Qt::if_floating_point<FloatType> = true, Qt::if_integral<IntType> = true> auto Qt::compareThreeWay(FloatType lhs, IntType rhs)
\since 6.7 \since 6.7
\relates <QtCompare> \relates <QtCompare>
\overload \overload

4
src/corelib/io/qdebug.cpp
View File

@ -985,8 +985,8 @@ QDebug &QDebug::resetFormat()
*/ */
/*! /*!
\fn template <typename T, if_qint128<T>> QDebug::operator<<(T i) \fn template <typename T, QDebug::if_qint128<T>> QDebug::operator<<(T i)
\fn template <typename T, if_quint128<T>> QDebug::operator<<(T i) \fn template <typename T, QDebug::if_quint128<T>> QDebug::operator<<(T i)
\since 6.7 \since 6.7
Prints the textual representation of the 128-bit integer \a i. Prints the textual representation of the 128-bit integer \a i.

23
src/corelib/io/qfileinfo.cpp
View File

@ -1496,7 +1496,9 @@ qint64 QFileInfo::size() const
(not the symlink). (not the symlink).
\since 6.6 \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). (not the symlink).
\since 6.6 \since 6.6
\sa birthTime(const QTimeZone &), lastModified(const QTimeZone &), lastRead(const QTimeZone &), \sa birthTime(const QTimeZone &), lastModified(const QTimeZone &),
fileTime(QFile::FileTime time, const QTimeZone &) lastRead(const QTimeZone &),
fileTime(QFileDevice::FileTime time, const QTimeZone &)
*/ */
/*! /*!
@ -1562,7 +1565,9 @@ qint64 QFileInfo::size() const
(not the symlink). (not the symlink).
\since 6.6 \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). (not the symlink).
\since 6.6 \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) #if QT_VERSION < QT_VERSION_CHECK(7, 0, 0) && !defined(QT_BOOTSTRAPPED)
@ -1609,7 +1616,7 @@ qint64 QFileInfo::size() const
(not the symlink). (not the symlink).
This function overloads 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)}. and returns the same as \c{fileTime(time, QTimeZone::LocalTime)}.
\since 5.10 \since 5.10
@ -1637,7 +1644,9 @@ QDateTime QFileInfo::fileTime(QFile::FileTime time) const {
(not the symlink). (not the symlink).
\since 6.6 \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 QDateTime QFileInfo::fileTime(QFile::FileTime time, const QTimeZone &tz) const
{ {

2
src/corelib/kernel/qmath.qdoc
View File

@ -132,7 +132,7 @@
\since 6.1 \since 6.1
\overload \overload
\fn template <typename Tx, typename Ty> auto qHypot(Tx x, Ty y) \fn template <typename Tx, typename Ty> 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. This is qSqrt(x * x + y * y), optimized.
In particular, underflow and overflow may be avoided. In particular, underflow and overflow may be avoided.

2
src/corelib/kernel/qmetaobject.cpp
View File

@ -4150,7 +4150,7 @@ bool QMetaProperty::isBindable() const
This mechanism is free for you to use in your Qt applications. This mechanism is free for you to use in your Qt applications.
\note It's also used by the \l[ActiveQt]{Active Qt}, \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. modules. Some keys might be set when using these modules.
\sa QMetaObject \sa QMetaObject

2
src/corelib/kernel/qobject.cpp
View File

@ -4418,7 +4418,7 @@ QDebug operator<<(QDebug dbg, const QObject *o)
This macro associates extra information to the class, which is available This macro associates extra information to the class, which is available
using QObject::metaObject(). Qt makes only limited use of this feature in 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 The extra information takes the form of a \a Name string and a \a Value
literal string. literal string.

4
src/corelib/tools/qcryptographichash.cpp
View File

@ -1420,7 +1420,7 @@ void QMessageAuthenticationCodePrivate::initMessageHash() noexcept
Use the QMessageAuthenticationCode class to generate hash-based message Use the QMessageAuthenticationCode class to generate hash-based message
authentication codes (HMACs). The class supports all cryptographic authentication codes (HMACs). The class supports all cryptographic
hash algorithms from \l QCryptographicHash (see also hash algorithms from \l QCryptographicHash (see also
\l{QCryptographicHash::Algorithms}). \l{QCryptographicHash::Algorithm}).
To generate a message authentication code, pass a suitable hash To generate a message authentication code, pass a suitable hash
algorithm and secret key to the constructor. Then process the message 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 size of the secret key, and the security of the
underlying hash function. underlying hash function.
\sa QCryptographicHash, QCryptographicHash::Algorithms \sa QCryptographicHash, QCryptographicHash::Algorithm
*/ */
/*! /*!

20
src/corelib/tools/qspan.qdoc
View File

@ -513,7 +513,7 @@
The span must hold at least \c{Count} elements (\c{E} >= \c{Count} \e{and} The span must hold at least \c{Count} elements (\c{E} >= \c{Count} \e{and}
size() >= \c{Count}), otherwise the behavior is undefined. size() >= \c{Count}), otherwise the behavior is undefined.
\sa first(QSpan::size_type), last(), subspan() \sa first(QSpan<T,E>::size_type), last(), subspan()
*/ */
/*! /*!
@ -525,7 +525,7 @@
The span must hold at least \c{Count} elements (\c{E} >= \c{Count} \e{and} The span must hold at least \c{Count} elements (\c{E} >= \c{Count} \e{and}
size() >= \c{Count}), otherwise the behavior is undefined. size() >= \c{Count}), otherwise the behavior is undefined.
\sa last(QSpan::size_type), first(), subspan() \sa last(QSpan<T,E>::size_type), first(), subspan()
*/ */
/*! /*!
@ -541,7 +541,7 @@
This span must hold at least \c{Offset} elements (\c{E} >= \c{Offset} \e{and} This span must hold at least \c{Offset} elements (\c{E} >= \c{Offset} \e{and}
size() >= \c{Offset}), otherwise the behavior is undefined. size() >= \c{Offset}), otherwise the behavior is undefined.
\sa subspan(QSpan::size_type), subspan(), first(), last() \sa subspan(QSpan<T,E>::size_type), subspan(), first(), last()
*/ */
#if 0 // needs fix for QTBUG-118080 integrated into qt5.git #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 \c{Offset + Count} \e{and} size() >= \c{Offset + Count}), otherwise the
behavior is undefined. behavior is undefined.
\sa subspan(QSpan::size_type, QSpan::size_type), subspan(), first(), last() \sa subspan(QSpan<T,E>::size_type, QSpan<T,E>::size_type), subspan(), first(), last()
*/ */
#endif #endif
@ -578,8 +578,8 @@
The span must hold at least \a n elements (\c{E} >= \a n \e{and} size() >= The span must hold at least \a n elements (\c{E} >= \a n \e{and} size() >=
\a n), otherwise the behavior is undefined. \a n), otherwise the behavior is undefined.
\sa {first-t}{first<N>()}, last(QSpan::size_type), subspan(QSpan::size_type), \sa {first-t}{first<N>()}, last(QSpan<T,E>::size_type), subspan(QSpan<T,E>::size_type),
subspan(QSpan::size_type, QSpan::size_type) subspan(QSpan<T,E>::size_type, QSpan<T,E>::size_type)
\sa sliced() \sa sliced()
*/ */
@ -594,8 +594,8 @@
The span must hold at least \a n elements (\c{E} >= \a n \e{and} The span must hold at least \a n elements (\c{E} >= \a n \e{and}
size() >= \a n), otherwise the behavior is undefined. size() >= \a n), otherwise the behavior is undefined.
\sa last(), first(QSpan::size_type), subspan(QSpan::size_type), \sa last(), first(QSpan<T,E>::size_type), subspan(QSpan<T,E>::size_type),
subspan(QSpan::size_type, QSpan::size_type), sliced() subspan(QSpan<T,E>::size_type, QSpan<T,E>::size_type), sliced()
*/ */
/*! /*!
@ -614,7 +614,7 @@
These functions do the same thing: subspan() is provided for STL These functions do the same thing: subspan() is provided for STL
compatibility and sliced() is provided for Qt compatibility. compatibility and sliced() is provided for Qt compatibility.
\sa subspan(), first(QSpan::size_type), last(QSpan::size_type) \sa subspan(), first(QSpan<T,E>::size_type), last(QSpan<T,E>::size_type)
*/ */
/*! /*!
@ -634,6 +634,6 @@
These functions do the same thing: subspan() is provided for STL These functions do the same thing: subspan() is provided for STL
compatibility and sliced() is provided for Qt compatibility. compatibility and sliced() is provided for Qt compatibility.
\sa subspan(), first(QSpan::size_type), last(QSpan::size_type) \sa subspan(), first(QSpan<T,E>::size_type), last(QSpan<T,E>::size_type)
*/ */