blob: 54e25c90b297e7abbb3a65467ef3969a40f88f75 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/****************************************************************************
**
** Copyright (C) 2011 - 2012 Denis Shienkov <denis.shienkov@gmail.com>
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtserialport-index.html
\since 5.1
\title Qt Serial Port
\brief Provides an API to make serial programming simple and portable.
Qt Serial Port provides basic functionality for configuration, I/O
operations, and getting and setting the control signals of the RS-232
pinouts.
The following items are not supported by this module:
\list
\li Terminal features, such as echo, control CR/LF, and so on.
\li Text mode.
\li Configuring timeouts and delays while reading or writing.
\li Pinout signal change notification.
\endlist
\section1 Using the Module
\include {module-use.qdocinc} {using the c++ api}
\section2 Building with Cmake
\include {module-use.qdocinc} {building with cmake} {SerialPort}
\section2 Building with qmake
\include {module-use.qdocinc} {building_with_qmake} {serialport}
\section1 Module Evolution
\l{Changes to Qt SerialPort} lists important changes in the module API
and functionality that were done for the Qt 6 series of Qt.
\section1 Related Information
\list
\li \l{Qt Serial Port C++ Classes}{C++ Classes}
\li \l{Qt Serial Port Examples}{Examples}
\endlist
*/
|