From d199a0069622cee12ab59740245c4625a2bc63b0 Mon Sep 17 00:00:00 2001 From: Rym Bouabid Date: Thu, 21 Sep 2023 11:59:28 +0200 Subject: [PATCH] Revamp Queued Custom Type Ex: Revisit the documentation Remove "Example" from the title. Add \examplecategory {Data Processing & I/O}. Task-number: QTBUG-117147 Pick-to: 6.5 Change-Id: Ieaab75dedb60329dcdcbbcfe6e2ad360df4d98df Reviewed-by: Ivan Solovev (cherry picked from commit 4aab2ef0ac3b126b0af67b9f946bf49b79fe6968) Reviewed-by: Qt Cherry-pick Bot --- examples/corelib/threads/doc/src/queuedcustomtype.qdoc | 4 ++-- examples/corelib/tools/doc/src/customtype.qdoc | 2 +- src/corelib/doc/src/custom-types.qdoc | 7 +++---- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/examples/corelib/threads/doc/src/queuedcustomtype.qdoc b/examples/corelib/threads/doc/src/queuedcustomtype.qdoc index df904cc4380..88105282009 100644 --- a/examples/corelib/threads/doc/src/queuedcustomtype.qdoc +++ b/examples/corelib/threads/doc/src/queuedcustomtype.qdoc @@ -3,8 +3,8 @@ /*! \example threads/queuedcustomtype - \title Queued Custom Type Example - \brief Demonstrates multi-thread programming using Qt. + \examplecategory {Data Processing & I/O} + \title Queued Custom Type \ingroup qtconcurrent-mtexamples \brief The Queued Custom Type example shows how to send custom types between diff --git a/examples/corelib/tools/doc/src/customtype.qdoc b/examples/corelib/tools/doc/src/customtype.qdoc index 55d29609ce2..63c30d62081 100644 --- a/examples/corelib/tools/doc/src/customtype.qdoc +++ b/examples/corelib/tools/doc/src/customtype.qdoc @@ -104,7 +104,7 @@ To register a custom type for use with queued signals and slots, such as those used in cross-thread communication, see the - \l{Queued Custom Type Example}. + \l{Queued Custom Type} example. More information on using custom types with Qt can be found in the \l{Creating Custom Qt Types} document. diff --git a/src/corelib/doc/src/custom-types.qdoc b/src/corelib/doc/src/custom-types.qdoc index 352a43549da..53885e51363 100644 --- a/src/corelib/doc/src/custom-types.qdoc +++ b/src/corelib/doc/src/custom-types.qdoc @@ -77,7 +77,7 @@ available for queued signal-slot communication as long as you call it before you make the first connection that uses the type. - The \l{Queued Custom Type Example} declares a \c Block class which is registered + The \l{Queued Custom Type} example declares a \c Block class which is registered in the \c{main.cpp} file: \snippet threads/queuedcustomtype/main.cpp main start @@ -131,9 +131,8 @@ The Q_DECLARE_METATYPE() macro and qRegisterMetaType() function documentation contain more detailed information about their uses and limitations. - The \l{Custom Type Example}{Custom Type} and \l{Queued Custom Type Example} - {Queued Custom Type} examples show how to implement a custom type with the - features outlined in this document. + The \l{Custom Type Example}{Custom Type} and \l{Queued Custom Type} examples + show how to implement a custom type with the features outlined in this document. The \l{Debugging Techniques} document provides an overview of the debugging mechanisms discussed above.