From c2164340bf6eaf3968fdbb8765fa33d7ec4b0310 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 27 Sep 2023 12:32:05 +0000 Subject: [PATCH] Doc: QtCore: Fix documentation issues * Fix references to Wait Conditions Example, Semaphores Example, and MIME Type Browser Example as they were renamed. * Rename 'Shared Memory' example as its title clashes with the title of another page (sharedmemory.html). src/corelib/global/qfloat16.cpp: * warning: Invalid '\relates' (already a member of 'qfloat16') Pick-to: 6.5 Change-Id: Ia28be8e3882a7ad1fadcdbd50a657705d58526bd Reviewed-by: Andreas Eliasson (cherry picked from commit f0f0a5ccb63b367934cc29d6091a782ffc746161) Reviewed-by: Qt Cherry-pick Bot --- doc/global/manifest-meta.qdocconf | 4 ++-- examples/corelib/ipc/doc/src/sharedmemory.qdoc | 2 +- examples/corelib/threads/doc/src/semaphores.qdoc | 2 +- examples/corelib/threads/doc/src/waitconditions.qdoc | 2 +- src/corelib/doc/src/ipc.qdoc | 2 +- src/corelib/global/qfloat16.cpp | 1 - src/corelib/mimetypes/qmimedatabase.cpp | 2 +- src/corelib/mimetypes/qmimetype.cpp | 2 +- src/corelib/thread/qwaitcondition.qdoc | 8 ++++---- 9 files changed, 12 insertions(+), 13 deletions(-) diff --git a/doc/global/manifest-meta.qdocconf b/doc/global/manifest-meta.qdocconf index b757ae9a809..0a66e7477d1 100644 --- a/doc/global/manifest-meta.qdocconf +++ b/doc/global/manifest-meta.qdocconf @@ -203,8 +203,8 @@ manifestmeta.thumbnail.attributes = "imageUrl:qthelp\://org.qt-project.qtdoc.$Q manifestmeta.thumbnail.names = "QtCore/Contiguous Cache Example" \ "QtCore/Custom Type Example" \ "QtCore/JSON Save Game Example" \ - "QtCore/Semaphores Example" \ - "QtCore/Wait Conditions Example" \ + "QtCore/Producer and Consumer using Semaphores" \ + "QtCore/Producer and Consumer using Wait Conditions" \ "QtConcurrent/Word Count" \ "QtGui/Raster Window Example" \ "QtNetwork/Network Download*" \ diff --git a/examples/corelib/ipc/doc/src/sharedmemory.qdoc b/examples/corelib/ipc/doc/src/sharedmemory.qdoc index b06849cee36..cc02c3b50b0 100644 --- a/examples/corelib/ipc/doc/src/sharedmemory.qdoc +++ b/examples/corelib/ipc/doc/src/sharedmemory.qdoc @@ -3,7 +3,7 @@ /*! \example ipc/sharedmemory - \title Shared Memory + \title IPC: Shared Memory \ingroup examples-ipc \brief Demonstrates how to share image data between different processes using the Shared Memory IPC mechanism. diff --git a/examples/corelib/threads/doc/src/semaphores.qdoc b/examples/corelib/threads/doc/src/semaphores.qdoc index 964225ffeed..20c518df70f 100644 --- a/examples/corelib/threads/doc/src/semaphores.qdoc +++ b/examples/corelib/threads/doc/src/semaphores.qdoc @@ -29,7 +29,7 @@ An alternative to using QSemaphore to solve the producer-consumer problem is to use QWaitCondition and QMutex. This is what the - \l{Wait Conditions Example} does. + \l{Producer and Consumer using Wait Conditions} example does. \section1 Global Variables diff --git a/examples/corelib/threads/doc/src/waitconditions.qdoc b/examples/corelib/threads/doc/src/waitconditions.qdoc index b840043f630..b74abb35546 100644 --- a/examples/corelib/threads/doc/src/waitconditions.qdoc +++ b/examples/corelib/threads/doc/src/waitconditions.qdoc @@ -29,7 +29,7 @@ An alternative to using QWaitCondition and QMutex to solve the producer-consumer problem is to use QSemaphore. This is what the - \l{Semaphores Example} does. + \l{Producer and Consumer using Semaphores} example does. \section1 Global Variables diff --git a/src/corelib/doc/src/ipc.qdoc b/src/corelib/doc/src/ipc.qdoc index e60dae82b55..b04443e2db1 100644 --- a/src/corelib/doc/src/ipc.qdoc +++ b/src/corelib/doc/src/ipc.qdoc @@ -86,7 +86,7 @@ \keyword ipc \keyword shared memory - \brief Overview of the techniques for sharing memory between processes + \brief Overview of the techniques for sharing memory between processes. Qt provides two techniques to share memory with other processes in the same system: \l{QSharedMemory} and memory-mapped files using \l{QFile}. Memory diff --git a/src/corelib/global/qfloat16.cpp b/src/corelib/global/qfloat16.cpp index bba7ad07fb1..b64c0b800da 100644 --- a/src/corelib/global/qfloat16.cpp +++ b/src/corelib/global/qfloat16.cpp @@ -366,7 +366,6 @@ Q_CORE_EXPORT void qFloatFromFloat16(float *out, const qfloat16 *in, qsizetype l /*! \fn size_t qfloat16::qHash(qfloat16 key, size_t seed) \since 6.5.3 - \relates qfloat16 Returns the hash value for the \a key, using \a seed to seed the calculation. diff --git a/src/corelib/mimetypes/qmimedatabase.cpp b/src/corelib/mimetypes/qmimedatabase.cpp index eb6fb718cf4..e39ca68fe1e 100644 --- a/src/corelib/mimetypes/qmimedatabase.cpp +++ b/src/corelib/mimetypes/qmimedatabase.cpp @@ -560,7 +560,7 @@ bool QMimeDatabasePrivate::inherits(const QString &mime, const QString &parent) \snippet code/src_corelib_mimetype_qmimedatabase.cpp 0 - \sa QMimeType, {MIME Type Browser Example} + \sa QMimeType, {MIME Type Browser} */ /*! diff --git a/src/corelib/mimetypes/qmimetype.cpp b/src/corelib/mimetypes/qmimetype.cpp index b824a42049c..1ad41ac4314 100644 --- a/src/corelib/mimetypes/qmimetype.cpp +++ b/src/corelib/mimetypes/qmimetype.cpp @@ -70,7 +70,7 @@ void QMimeTypePrivate::addGlobPattern(const QString &pattern) MIME types can inherit from each other: for instance a C source file is a specific type of plain text file, so text/x-csrc inherits text/plain. - \sa QMimeDatabase, {MIME Type Browser Example} + \sa QMimeDatabase, {MIME Type Browser} */ /*! diff --git a/src/corelib/thread/qwaitcondition.qdoc b/src/corelib/thread/qwaitcondition.qdoc index 435771e1d84..8466eb13d22 100644 --- a/src/corelib/thread/qwaitcondition.qdoc +++ b/src/corelib/thread/qwaitcondition.qdoc @@ -51,12 +51,12 @@ simultaneously are unpredictable. Wait conditions are a powerful thread synchronization primitive. - The \l{Wait Conditions Example} example shows how - to use QWaitCondition as an alternative to QSemaphore for - controlling access to a circular buffer shared by a producer + The \l{Producer and Consumer using Wait Conditions} example + shows how to use QWaitCondition as an alternative to QSemaphore + for controlling access to a circular buffer shared by a producer thread and a consumer thread. - \sa QMutex, QSemaphore, QThread, {Wait Conditions Example} + \sa QMutex, QSemaphore, QThread, {Producer and Consumer using Wait Conditions} */ /*!