From c48e84e97ec5bf03ffc85625fe884042aa6b2e26 Mon Sep 17 00:00:00 2001 From: Andre Hartmann Date: Fri, 3 Nov 2017 07:23:27 +0100 Subject: Update include instructions in documentation overview pages The examples were already adopted to use instead . Change-Id: Id9d3b0b04f31ac3d32554aa34941696903511577 Reviewed-by: Alex Blasche Reviewed-by: Denis Shienkov --- src/serialport/doc/src/index.qdoc | 11 +++++++++-- src/serialport/doc/src/qtserialport-module.qdoc | 10 ++++++++-- 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 + #include + \endcode + + For information about available serial ports, use the following include + statement: + + \code + #include \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 + #include + \endcode + + For QSerialPortInfo, use the following include statement: + + \code + #include \endcode To link against the module, add this line to your \l qmake \c -- cgit v1.2.1