summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndre Hartmann <aha_1980@gmx.de>2017-11-03 06:23:27 (GMT)
committerAndré Hartmann <aha_1980@gmx.de>2017-11-03 07:13:17 (GMT)
commitc48e84e97ec5bf03ffc85625fe884042aa6b2e26 (patch)
treee4875e8b4b16bfba98d334007d036c1918dc90ff
parent77ba093c613217304782114b5f78fa9ad5512c38 (diff)
downloadqtserialport-c48e84e97ec5bf03ffc85625fe884042aa6b2e26.tar.gz
Update include instructions in documentation overview pagesv5.10.0-beta4
The examples were already adopted to use <QSerialPort> instead <QtSerialPort/QtSerialPort>. Change-Id: Id9d3b0b04f31ac3d32554aa34941696903511577 Reviewed-by: Alex Blasche <alexander.blasche@qt.io> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
-rw-r--r--src/serialport/doc/src/index.qdoc11
-rw-r--r--src/serialport/doc/src/qtserialport-module.qdoc10
2 files changed, 17 insertions, 4 deletions
diff --git a/src/serialport/doc/src/index.qdoc b/src/serialport/doc/src/index.qdoc
index 3b0f762..041188e 100644
--- a/src/serialport/doc/src/index.qdoc
+++ b/src/serialport/doc/src/index.qdoc
@@ -43,11 +43,18 @@
\li Pinout signal change notification.
\endlist
- To use these classes in your application, use the following include
+ To use the serial port in your application, add the following include
statement:
\code
- #include <QtSerialPort/QtSerialPort>
+ #include <QSerialPort>
+ \endcode
+
+ For information about available serial ports, use the following include
+ statement:
+
+ \code
+ #include <QSerialPortInfo>
\endcode
To link against the module, add this line to your \l qmake \c
diff --git a/src/serialport/doc/src/qtserialport-module.qdoc b/src/serialport/doc/src/qtserialport-module.qdoc
index 325b780..6c153a0 100644
--- a/src/serialport/doc/src/qtserialport-module.qdoc
+++ b/src/serialport/doc/src/qtserialport-module.qdoc
@@ -32,11 +32,17 @@
\qtvariable serialport
\brief List of C++ classes that enable access to a serial port.
- To use these classes in your application, use the following include
+ To use QSerialPort in your application, add the following include
statement:
\code
- #include <QtSerialPort/QtSerialPort>
+ #include <QSerialPort>
+ \endcode
+
+ For QSerialPortInfo, use the following include statement:
+
+ \code
+ #include <QSerialPortInfo>
\endcode
To link against the module, add this line to your \l qmake \c