5 files changed, 69 insertions, 103 deletions
diff --git a/src/serialport/doc/src/index.qdoc b/src/serialport/doc/src/index.qdoc
index 041188e..d91f25c 100644
--- a/src/serialport/doc/src/index.qdoc
+++ b/src/serialport/doc/src/index.qdoc
@@ -1,29 +1,5 @@
-/****************************************************************************
-**
-** 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$
-**
-****************************************************************************/
+// Copyright (C) 2011 - 2012 Denis Shienkov <denis.shienkov@gmail.com>
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
 
 /*!
     \page qtserialport-index.html
@@ -31,9 +7,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,26 +19,21 @@
     \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 link against the module, add this line to your \l qmake \c
-    .pro file:
+    \section2 Building with qmake
 
-    \code
-    QT += serialport
-    \endcode
+    \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
diff --git a/src/serialport/doc/src/qt6-changes.qdoc b/src/serialport/doc/src/qt6-changes.qdoc
new file mode 100644
index 0000000..d3ded94
--- /dev/null
+++ b/src/serialport/doc/src/qt6-changes.qdoc
@@ -0,0 +1,26 @@
+// Copyright (C) 2021 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+/*!
+    \page qtserialport-changes-qt6.html
+
+    \title Changes to Qt SerialPort
+    \ingroup changes-qt-5-to-6
+    \brief Migrate Qt SerialPort to Qt 6.
+
+    Qt 6 is a result of the conscious effort to make the framework more
+    efficient and easy to use.
+    We try to maintain binary and source compatibility for all the public
+    APIs in each release. But some changes were inevitable in an effort to
+    make Qt a better framework.
+    In this topic we summarize those changes in Qt SerialPort module, and
+    provide guidance to handle them.
+
+    \section1 Changes overview
+    The Qt SerialPort module is generally speaking source compatible with the
+    Qt5 version and users of the library should be able to continue with no or
+    minor changes to their project.
+
+    \section1 Build system
+    As with Qt6 in general, the Qt SerialPort module has cmake support in
+    addition to qmake.
+*/
diff --git a/src/serialport/doc/src/qtserialport-examples.qdoc b/src/serialport/doc/src/qtserialport-examples.qdoc
index c680224..51bd949 100644
--- a/src/serialport/doc/src/qtserialport-examples.qdoc
+++ b/src/serialport/doc/src/qtserialport-examples.qdoc
@@ -1,31 +1,7 @@
-/****************************************************************************
-**
-** Copyright (C) 2011-2012 Denis Shienkov <denis.shienkov@gmail.com>
-** Copyright (C) 2012 Laszlo Papp <lpapp@kde.org>
-** Copyright (C) 2016 The Qt Company Ltd.
-** 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$
-**
-****************************************************************************/
+// Copyright (C) 2011-2012 Denis Shienkov <denis.shienkov@gmail.com>
+// Copyright (C) 2012 Laszlo Papp <lpapp@kde.org>
+// Copyright (C) 2016 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
 
 /*!
     \title Qt Serial Port Examples
diff --git a/src/serialport/doc/src/qtserialport-module-use.qdocinc b/src/serialport/doc/src/qtserialport-module-use.qdocinc
new file mode 100644
index 0000000..e723fd9
--- /dev/null
+++ b/src/serialport/doc/src/qtserialport-module-use.qdocinc
@@ -0,0 +1,15 @@
+// Copyright (C) 2021 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+//! [cmakebuild]
+    \code
+    find_package(Qt6 REQUIRED COMPONENTS SerialPort)
+    target_link_libraries(mytarget PRIVATE Qt6::SerialPort)
+    \endcode
+//! [cmakebuild]
+
+//! [qmakebuild]
+    \code
+    QT += serialport
+    \endcode
+//! [qmakebuild]
diff --git a/src/serialport/doc/src/qtserialport-module.qdoc b/src/serialport/doc/src/qtserialport-module.qdoc
index 6c153a0..cf4523b 100644
--- a/src/serialport/doc/src/qtserialport-module.qdoc
+++ b/src/serialport/doc/src/qtserialport-module.qdoc
@@ -1,35 +1,12 @@
-/****************************************************************************
-**
-** 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$
-**
-****************************************************************************/
+// Copyright (C) 2011 - 2012 Denis Shienkov <denis.shienkov@gmail.com>
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
 
 /*!
     \module QtSerialPort
     \title Qt Serial Port C++ Classes
     \ingroup modules
     \qtvariable serialport
+    \qtcmakepackage SerialPort
     \brief List of C++ classes that enable access to a serial port.
 
     To use QSerialPort in your application, add the following include
@@ -45,10 +22,11 @@
     #include <QSerialPortInfo>
     \endcode
 
-    To link against the module, add this line to your \l qmake \c
-    .pro file:
+    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
 
-    \code
-    QT += serialport
-    \endcode
+    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
 */