diff options
author | Laszlo Papp <lpapp@kde.org> | 2013-01-25 21:15:15 +0000 |
---|---|---|
committer | Denis Shienkov <denis.shienkov@gmail.com> | 2013-01-26 15:17:17 +0100 |
commit | 086698ce1ef923a45a784fa2f6b167185f7e740d (patch) | |
tree | 8b587a0946f30a32b52b19c252684911b40b0d6a /src/serialport/doc/src/index.qdoc | |
parent | 13e1bc161ce0359722eb81a3bebe24216d06dc93 (diff) | |
download | qtserialport-086698ce1ef923a45a784fa2f6b167185f7e740d.tar.gz |
Move the library and example documentations to the right places
Change-Id: Ia04d1f576b90ba705471b290b50f7adc2b13d00f
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Diffstat (limited to 'src/serialport/doc/src/index.qdoc')
-rw-r--r-- | src/serialport/doc/src/index.qdoc | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/src/serialport/doc/src/index.qdoc b/src/serialport/doc/src/index.qdoc new file mode 100644 index 0000000..e290804 --- /dev/null +++ b/src/serialport/doc/src/index.qdoc @@ -0,0 +1,62 @@ +/**************************************************************************** +** +** Copyright (C) 2011-2012 Denis Shienkov <scapig2@yandex.ru> +** 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 QtAddonSerialPort + \title Qt Addon SerialPort Reference Documentation + \page index.html + + \brief The QtAddonSerialPort module provides classes to make serial programming + easier and portable. + + To include the definitions of the module's classes, use the + following directive: + + \code + #include <QtAddOnSerialPort/QtAddOnSerialPort> + \endcode + + To link against the module, add this line to your \l qmake \c + .pro file: + + \code + QT += serialport + \endcode + + Table of contents: + + \list + \o \l {Introduction} + \o \l {Get source} + \o \l {Building and usage} + \o \l {Examples} + \endlist + + \section1 C++ Classes + + \generatelist annotatedclasses +*/ |