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

Revamp Queued Custom Type Ex: Revisit the documentation

Browse Source 
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 <ivan.solovev@qt.io>
(cherry picked from commit 4aab2ef0ac3b126b0af67b9f946bf49b79fe6968)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Rym Bouabid 2023-09-21 11:59:28 +02:00 committed by Qt Cherry-pick Bot
parent a6dcdcde99
commit d199a00696
3 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,8 +3,8 @@
/*! /*!
\example threads/queuedcustomtype \example threads/queuedcustomtype
\title Queued Custom Type Example \examplecategory {Data Processing & I/O}
\brief Demonstrates multi-thread programming using Qt. \title Queued Custom Type
\ingroup qtconcurrent-mtexamples \ingroup qtconcurrent-mtexamples
\brief The Queued Custom Type example shows how to send custom types between \brief The Queued Custom Type example shows how to send custom types between

2
examples/corelib/tools/doc/src/customtype.qdoc
View File

@ -104,7 +104,7 @@
To register a custom type for use with queued signals and slots, such as To register a custom type for use with queued signals and slots, such as
those used in cross-thread communication, see the 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 More information on using custom types with Qt can be found in the
\l{Creating Custom Qt Types} document. \l{Creating Custom Qt Types} document.

7
src/corelib/doc/src/custom-types.qdoc
View File

@ -77,7 +77,7 @@
available for queued signal-slot communication as long as you call it before you available for queued signal-slot communication as long as you call it before you
make the first connection that uses the type. 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: in the \c{main.cpp} file:
\snippet threads/queuedcustomtype/main.cpp main start \snippet threads/queuedcustomtype/main.cpp main start
@ -131,9 +131,8 @@
The Q_DECLARE_METATYPE() macro and qRegisterMetaType() function documentation The Q_DECLARE_METATYPE() macro and qRegisterMetaType() function documentation
contain more detailed information about their uses and limitations. contain more detailed information about their uses and limitations.
The \l{Custom Type Example}{Custom Type} and \l{Queued Custom Type Example} The \l{Custom Type Example}{Custom Type} and \l{Queued Custom Type} examples
{Queued Custom Type} examples show how to implement a custom type with the show how to implement a custom type with the features outlined in this document.
features outlined in this document.
The \l{Debugging Techniques} document provides an overview of the debugging The \l{Debugging Techniques} document provides an overview of the debugging
mechanisms discussed above. mechanisms discussed above.