diff options
Diffstat (limited to 'src/serialport/doc')
| -rw-r--r-- | src/serialport/doc/qtserialport.qdocconf | 7 | ||||
| -rw-r--r-- | src/serialport/doc/src/getsrc.qdoc | 63 | ||||
| -rw-r--r-- | src/serialport/doc/src/index.qdoc | 32 | ||||
| -rw-r--r-- | src/serialport/doc/src/intro.qdoc | 77 | ||||
| -rw-r--r-- | src/serialport/doc/src/qtserialport-module.qdoc (renamed from src/serialport/doc/src/build.qdoc) | 28 |
5 files changed, 29 insertions, 178 deletions
diff --git a/src/serialport/doc/qtserialport.qdocconf b/src/serialport/doc/qtserialport.qdocconf index cf7c0613..f095c2f1 100644 --- a/src/serialport/doc/qtserialport.qdocconf +++ b/src/serialport/doc/qtserialport.qdocconf @@ -17,12 +17,7 @@ qhp.QtSerialPort.filterAttributes = qtserialport $QT_VERSION qtrefdoc qhp.QtSerialPort.customFilters.Qt.name = QtSerialPort $QT_VERSION qhp.QtSerialPort.customFilters.Qt.filterAttributes = qtserialport $QT_VERSION -qhp.QtSerialPort.subprojects = overviews classes examples - -qhp.QtSerialPort.subprojects.overviews.title = Overview -qhp.QtSerialPort.subprojects.overviews.indexTitle = Qt Serial Port -qhp.QtSerialPort.subprojects.overviews.selectors = fake:page,group,module -qhp.QtSerialPort.subprojects.overviews.sortPages = true +qhp.QtSerialPort.subprojects = classes examples qhp.QtSerialPort.subprojects.classes.title = C++ Classes qhp.QtSerialPort.subprojects.classes.indexTitle = Qt Serial Port C++ Classes diff --git a/src/serialport/doc/src/getsrc.qdoc b/src/serialport/doc/src/getsrc.qdoc deleted file mode 100644 index 67d17b60..00000000 --- a/src/serialport/doc/src/getsrc.qdoc +++ /dev/null @@ -1,63 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2011 -2012 Denis Shienkov <denis.shienkov@gmail.com> -** Contact: http://www.qt-project.org/legal -** -** 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 Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \module QtSerialPort - \title Get source - \page getsrc.html - \previouspage Introduction - \contentspage {Get source} {Contents} - \nextpage Building and usage - - \section1 Users - - \code - $ git clone git://gitorious.org/qt/qtserialport.git - \endcode - - \section1 Developers - - Getting a Qt developer account is necessary to contribute to the project, - so that has to be obtained first. Once, that is done, see the following page - for further details about the Git and Gerrit usage: - - \l{http://wiki.qt-project.org/Setting_up_Gerrit}{Setting up Gerrit} - - The following command can be used to clone the project with push access: - - \code - $ git clone ssh://<username>@codereview.qt-project.org:29418/qt/qtserialport.git - \endcode - - If you are in a corporate environment (e.g. behind a firewall) which only - allows Ports 80 (HTTP) and 443 (HTTPS), use the following configuration - instead: - - \code - $ git clone ssh://<username>@codereview.qt-project.org:443/qt/qtserialport.git - \endcode -*/ diff --git a/src/serialport/doc/src/index.qdoc b/src/serialport/doc/src/index.qdoc index dab757fa..ae5faebc 100644 --- a/src/serialport/doc/src/index.qdoc +++ b/src/serialport/doc/src/index.qdoc @@ -26,14 +26,24 @@ ****************************************************************************/ /*! - \module QtSerialPort + \page qtserialport-index.html \title Qt Serial Port - \page index.html + \brief Provides API to make the serial programming simple and portable. - \brief The Qt Serial Port module provides classes to make the serial - programming simple and portable. + Qt Serial Port provides the basic functionality, which includes + configuring, I/O operations, get and set control signals of the + RS-232 pinouts. - Use this form to include Qt Serial Port headers: + The following 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. + \li Tracking and notification when the state of RS-232 pinout signals change. + \endlist + + To use these classes in your application, use the following include + statement: \code #include <QtSerialPort/QtSerialPort> @@ -46,16 +56,10 @@ QT += serialport \endcode - Table of contents: - + \section1 Related information \list - \li \l {Introduction} - \li \l {Get source} - \li \l {Building and usage} - \li \l {Examples} + \li \l{Qt Serial Port C++ Classes}{C++ Classes} + \li \l{Qt Serial Port Examples}{Examples} \endlist - \section1 C++ Classes - - \generatelist annotatedclasses */ diff --git a/src/serialport/doc/src/intro.qdoc b/src/serialport/doc/src/intro.qdoc deleted file mode 100644 index d89a3ce6..00000000 --- a/src/serialport/doc/src/intro.qdoc +++ /dev/null @@ -1,77 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2011 - 2012 Denis Shienkov <denis.shienkov@gmail.com> -** Contact: http://www.qt-project.org/legal -** -** 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 Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \module QtSerialPort - \title Introduction - \page intro.html - \contentspage {Introduction} {Contents} - \nextpage Get source - - \section1 History - - Qt Serial Port originated from the third-party library - \l{http://gitorious.org/qserialdevice/qserialdevice/trees/2.0}{QSerialDevice 2.0}. - - \section1 Supported platforms - - The primary goal is to support as many common platforms as possible. Please - find the information below about the support state for the various - platforms: - - \table - \header - \li Platform - \li Support state - \li Notes - \row - \li Windows x86/x64 NT based (2K, XP, Vista, 7, 8) - \li Complete support (Tier 1). - \li Support expected for Windows 8, but has not yet been tested. - \row - \li Windows CE - \li Partial support (Not Tier 1). - \li Tested only with platforms 5 and 6 by using the emulator. - \row - \li Symbian - \li Partial support, and only for legacy Qt4 (Not Tier 1). - \li The implementation is not complete and further support in doubt. - \row - \li Gnu/Linux - \li Complete support (Tier 1). - \li - \row - \li Mac OSX - \li Complete support (Tier 1). - \li - \row - \li Other *nix - \li Complete support (Tier 1). - \li All POSIX-compatible. - \endtable - -*/ diff --git a/src/serialport/doc/src/build.qdoc b/src/serialport/doc/src/qtserialport-module.qdoc index 13de5e60..b0fc506e 100644 --- a/src/serialport/doc/src/build.qdoc +++ b/src/serialport/doc/src/qtserialport-module.qdoc @@ -27,28 +27,20 @@ /*! \module QtSerialPort - \title Building and usage - \page build.html - \previouspage Get source - \contentspage {Building and usage} {Contents} - \nextpage Examples + \title Qt Serial Port C++ Classes + \brief List of C++ classes that enable access to a serial port. - \section1 Building + To use these classes in your application, use the following include + statement: - Make sure that when you build Qt, that you use the -developer-build option, - and do not do a \c{make install} as root. The same branch can be used for - building with Qt4 and Qt5. + \code + #include <QtSerialPort/QtSerialPort> + \endcode - Instructions for building against Qt4 are fundamentally the same as for - Qt5. See the information provided below what needs to be done after getting - the source by cloning the repository: + To link against the module, add this line to your \l qmake \c + .pro file: \code - $ cd qtserialport - $ qmake - $ make (Unix) or jom/nmake (Windows) + QT += serialport \endcode - - Once having successfully built, the examples can be run to see the intended - functionality provided by the module. */ |