diff options
| author | Venugopal Shivashankar <venugopal.shivashankar@digia.com> | 2013-04-12 06:29:30 -0700 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-05-06 10:21:22 +0200 |
| commit | d424c1ee4494baffdc4715440f86ef80a94fd7a5 (patch) | |
| tree | 3d25bad5f88fc640cb95192762cac38aba78e7c9 /src/serialport/doc/src/index.qdoc | |
| parent | 5abd6a5afd5f1429df59b3d2b373b6dfad8070c2 (diff) | |
Doc: Updates based on sanity checkv5.1.0-beta1
- Removed redundant qdoc pages on supported
platforms, getting source, and building from source.
- Added a module page to list the C++ classes
- Removed unnecessary \module commands in several pages
- Made a few language edits to class documentation
- Updated the index page with some introductory content
- Fixed broken links to the examples
Change-Id: Ia7bd74b383f344426814db736f7bc4cd77c13992
Reviewed-by: Laszlo Papp <lpapp@kde.org>
Diffstat (limited to 'src/serialport/doc/src/index.qdoc')
| -rw-r--r-- | src/serialport/doc/src/index.qdoc | 32 |
1 files changed, 18 insertions, 14 deletions
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 */ |