diff options
author | Ivan Solovev <ivan.solovev@qt.io> | 2023-02-08 14:15:24 +0100 |
---|---|---|
committer | Ivan Solovev <ivan.solovev@qt.io> | 2023-02-10 11:44:02 +0100 |
commit | 603ba31a1c0bc78e8189e402c581d3d1a7fc19b2 (patch) | |
tree | 60a27952053ce138c56dc1834d9e8fc458400573 | |
parent | 811c0f319862f15bfcf5799298e0fbc22516c94c (diff) | |
download | qtserialport-603ba31a1c0bc78e8189e402c581d3d1a7fc19b2.tar.gz |
More improvements on Blocking Sender and Receiver examples
* Do not use Example in the name
* add Connectivity category
Fixes: QTBUG-108871
Task-number: QTBUG-108868
Pick-to: 6.5
Change-Id: Ia4b0f577b31611fd15aadbc2dff6ff0f82399894
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
-rw-r--r-- | examples/serialport/doc/blockingreceiver.qdoc | 10 | ||||
-rw-r--r-- | examples/serialport/doc/blockingsender.qdoc | 12 | ||||
-rw-r--r-- | examples/serialport/doc/terminal.qdoc | 2 |
3 files changed, 14 insertions, 10 deletions
diff --git a/examples/serialport/doc/blockingreceiver.qdoc b/examples/serialport/doc/blockingreceiver.qdoc index d8b08a4..ad8feee 100644 --- a/examples/serialport/doc/blockingreceiver.qdoc +++ b/examples/serialport/doc/blockingreceiver.qdoc @@ -4,8 +4,10 @@ /*! \example blockingreceiver - \title Blocking Receiver Example + \title Blocking Receiver \ingroup qtserialport-examples + \meta category Connectivity + \brief Shows how to use the synchronous API of QSerialPort in a non-GUI thread. \e{Blocking Receiver} shows how to create an application for a serial interface @@ -42,8 +44,8 @@ But contrary to what many think, using threads with QThread does not necessarily add unmanageable complexity to your application. - This application is a Receiver, that demonstrate the work paired with Sender - application \l{Blocking Sender Example}. + This application is a Receiver, that demonstrate the work paired with the + sender application \l{blockingsender}{Blocking Sender example}. The Receiver application receives the request via serial port from the Sender application and send a response to it. @@ -137,7 +139,7 @@ \snippet blockingreceiver/receiverthread.cpp 13 - \sa {Serial Terminal}, {Blocking Sender Example} + \sa {Serial Terminal}, {Blocking Sender} \include examples-run.qdocinc */ diff --git a/examples/serialport/doc/blockingsender.qdoc b/examples/serialport/doc/blockingsender.qdoc index 5420dfc..bf2c367 100644 --- a/examples/serialport/doc/blockingsender.qdoc +++ b/examples/serialport/doc/blockingsender.qdoc @@ -1,12 +1,14 @@ // Copyright (C) 2011 - 2012 Denis Shienkov <denis.shienkov@gmail.com> // Copyright (C) 2012 - 2013 Laszlo Papp <lpapp@kde.org> -// Copyright (C) 2016 The Qt Company Ltd. +// Copyright (C) 2023 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \example blockingsender - \title Blocking Sender Example + \title Blocking Sender \ingroup qtserialport-examples + \meta category Connectivity + \brief Shows how to use the synchronous API of QSerialPort in a worker thread. \e{Blocking Sender} shows how to create an application for a serial @@ -41,8 +43,8 @@ should only be used in non-GUI threads to keep the user interface responsive. - This application is the sender which demonstrates the work paired with the receiver - application \l{blockingreceiver}{Blocking Receiver Example}. + This application is the sender which demonstrates the work paired with the + receiver application \l{blockingreceiver}{Blocking Receiver example}. The sender application initiates the transfer request via the serial port to the receiver application and waits for response. @@ -137,7 +139,7 @@ \snippet blockingsender/senderthread.cpp 13 - \sa {Serial Terminal}, {Blocking Receiver Example} + \sa {Serial Terminal}, {Blocking Receiver} \include examples-run.qdocinc */ diff --git a/examples/serialport/doc/terminal.qdoc b/examples/serialport/doc/terminal.qdoc index 5707a24..84f3a54 100644 --- a/examples/serialport/doc/terminal.qdoc +++ b/examples/serialport/doc/terminal.qdoc @@ -134,7 +134,7 @@ This slot reads the data from the serial port and displays that in the Console widget. - \sa {Blocking Receiver Example} + \sa {Blocking Receiver} \include examples-run.qdocinc */ |