diff options
| author | Andreas Eliasson <andreas.eliasson@qt.io> | 2022-12-21 13:47:06 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-12-27 13:29:11 +0000 |
| commit | 82312adb926a3df1b58498486039d1decd3ff330 (patch) | |
| tree | 9999a9d18340cfcf31ec56c57cc6fe0ee9a3c58e | |
| parent | 8867edb583f4144e5521872ab15a8546258c24a3 (diff) | |
Doc: Revise Qt Serial Port module landing page
For consistency, make the module landing page follow the same structure
as seen in most other modules.
Change-Id: I2e870890b520483e17e88202cd86f0c5e3f6ad75
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
(cherry picked from commit 35bfd24ebf0e479de005f0ad5466e649f592905a)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/serialport/doc/src/index.qdoc | 28 |
1 files changed, 9 insertions, 19 deletions
diff --git a/src/serialport/doc/src/index.qdoc b/src/serialport/doc/src/index.qdoc index 2c349e44..54e25c90 100644 --- a/src/serialport/doc/src/index.qdoc +++ b/src/serialport/doc/src/index.qdoc @@ -31,9 +31,9 @@ \title Qt Serial Port \brief Provides an API to make serial programming simple and portable. - Qt Serial Port provides the basic functionality, which includes - configuring, I/O operations, getting and setting the control signals of the - RS-232 pinouts. + 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 @@ -43,27 +43,17 @@ \li Pinout signal change notification. \endlist - To use the serial port in your application, add the following include - statement: + \section1 Using the Module - \code - #include <QSerialPort> - \endcode + \include {module-use.qdocinc} {using the c++ api} - For information about available serial ports, use the following include - statement: + \section2 Building with Cmake - \code - #include <QSerialPortInfo> - \endcode + \include {module-use.qdocinc} {building with cmake} {SerialPort} - To use the module with cmake, use the \c{find_package()} command to locate - the needed module components in the \c{Qt6} package: - \include qtserialport-module-use.qdocinc cmakebuild + \section2 Building with qmake - To use the module for building with qmake, add the module as a value of the - \c QT variable in the project's .pro file: - \include qtserialport-module-use.qdocinc qmakebuild + \include {module-use.qdocinc} {building_with_qmake} {serialport} \section1 Module Evolution \l{Changes to Qt SerialPort} lists important changes in the module API |