mirror of https://github.com/qt/qtbase.git
Doc: Fix documentation issues for Qt Core
* 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 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 commit96740ea3fe
) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit26c10a8863
) Reviewed-by: Ahmad Samir <a.samirh78@gmail.com>
This commit is contained in:
parent
239ded94d6
commit
619710e828
|
@ -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" \
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
{
|
||||
|
|
|
@ -132,7 +132,7 @@
|
|||
\since 6.1
|
||||
\overload
|
||||
\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.
|
||||
In particular, underflow and overflow may be avoided.
|
||||
|
|
|
@ -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
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
|
Loading…
Reference in New Issue