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

Doc: QtCore: Fix documentation issues

Browse Source 
* 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 <andreas.eliasson@qt.io>
(cherry picked from commit f0f0a5ccb63b367934cc29d6091a782ffc746161)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Topi Reinio 2023-09-27 12:32:05 +00:00 committed by Qt Cherry-pick Bot
parent 2cd1f9f03d
commit c2164340bf
9 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -203,8 +203,8 @@ manifestmeta.thumbnail.attributes = "imageUrl:qthelp\://org.qt-project.qtdoc.$Q
manifestmeta.thumbnail.names = "QtCore/Contiguous Cache Example" \ manifestmeta.thumbnail.names = "QtCore/Contiguous Cache Example" \
"QtCore/Custom Type Example" \ "QtCore/Custom Type Example" \
"QtCore/JSON Save Game Example" \ "QtCore/JSON Save Game Example" \
"QtCore/Semaphores Example" \ "QtCore/Producer and Consumer using Semaphores" \
"QtCore/Wait Conditions Example" \ "QtCore/Producer and Consumer using Wait Conditions" \
"QtConcurrent/Word Count" \ "QtConcurrent/Word Count" \
"QtGui/Raster Window Example" \ "QtGui/Raster Window Example" \
"QtNetwork/Network Download*" \ "QtNetwork/Network Download*" \

2
examples/corelib/ipc/doc/src/sharedmemory.qdoc
View File

@ -3,7 +3,7 @@
/*! /*!
\example ipc/sharedmemory \example ipc/sharedmemory
\title Shared Memory \title IPC: Shared Memory
\ingroup examples-ipc \ingroup examples-ipc
\brief Demonstrates how to share image data between different processes \brief Demonstrates how to share image data between different processes
using the Shared Memory IPC mechanism. using the Shared Memory IPC mechanism.

2
examples/corelib/threads/doc/src/semaphores.qdoc
View File

@ -29,7 +29,7 @@
An alternative to using QSemaphore to solve the producer-consumer An alternative to using QSemaphore to solve the producer-consumer
problem is to use QWaitCondition and QMutex. This is what the 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 \section1 Global Variables

2
examples/corelib/threads/doc/src/waitconditions.qdoc
View File

@ -29,7 +29,7 @@
An alternative to using QWaitCondition and QMutex to solve the An alternative to using QWaitCondition and QMutex to solve the
producer-consumer problem is to use QSemaphore. This is what 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 \section1 Global Variables

2
src/corelib/doc/src/ipc.qdoc
View File

@ -86,7 +86,7 @@
\keyword ipc \keyword ipc
\keyword shared memory \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 Qt provides two techniques to share memory with other processes in the same
system: \l{QSharedMemory} and memory-mapped files using \l{QFile}. Memory system: \l{QSharedMemory} and memory-mapped files using \l{QFile}. Memory

1
src/corelib/global/qfloat16.cpp
View File

@ -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) \fn size_t qfloat16::qHash(qfloat16 key, size_t seed)
\since 6.5.3 \since 6.5.3
\relates qfloat16
Returns the hash value for the \a key, using \a seed to seed the Returns the hash value for the \a key, using \a seed to seed the
calculation. calculation.

2
src/corelib/mimetypes/qmimedatabase.cpp
View File

@ -560,7 +560,7 @@ bool QMimeDatabasePrivate::inherits(const QString &mime, const QString &parent)
\snippet code/src_corelib_mimetype_qmimedatabase.cpp 0 \snippet code/src_corelib_mimetype_qmimedatabase.cpp 0
\sa QMimeType, {MIME Type Browser Example} \sa QMimeType, {MIME Type Browser}
*/ */
/*! /*!

2
src/corelib/mimetypes/qmimetype.cpp
View File

@ -70,7 +70,7 @@ void QMimeTypePrivate::addGlobPattern(const QString &pattern)
MIME types can inherit from each other: for instance a C source file is 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. 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}
*/ */
/*! /*!

8
src/corelib/thread/qwaitcondition.qdoc
View File

@ -51,12 +51,12 @@
simultaneously are unpredictable. simultaneously are unpredictable.
Wait conditions are a powerful thread synchronization primitive. Wait conditions are a powerful thread synchronization primitive.
The \l{Wait Conditions Example} example shows how The \l{Producer and Consumer using Wait Conditions} example
to use QWaitCondition as an alternative to QSemaphore for shows how to use QWaitCondition as an alternative to QSemaphore
controlling access to a circular buffer shared by a producer for controlling access to a circular buffer shared by a producer
thread and a consumer thread. thread and a consumer thread.
\sa QMutex, QSemaphore, QThread, {Wait Conditions Example} \sa QMutex, QSemaphore, QThread, {Producer and Consumer using Wait Conditions}
*/ */
/*! /*!