diff options
author | Nico Vertriest <nico.vertriest@digia.com> | 2013-04-08 13:57:07 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-04-12 14:09:05 +0200 |
commit | bcdcf261e3a56de38f23297c1dd784c0c654d0fb (patch) | |
tree | b1106d6d91eb36078cc8ca1f3529bb8371948a96 /src/x11extras/doc | |
parent | bd82bff721810a678c2302552a6f673cd148996f (diff) | |
download | qtx11extras-bcdcf261e3a56de38f23297c1dd784c0c654d0fb.tar.gz |
Doc: landing and module page for Qt X11 Extras
Ingroup statement in qx11info_x11.cpp
Removed trailing whitespace
Change-Id: I03c16014f66a809f1c31b4501ffd1ca0691b5ee7
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/x11extras/doc')
-rw-r--r-- | src/x11extras/doc/src/qtx11extras-index.qdoc | 61 | ||||
-rw-r--r-- | src/x11extras/doc/src/qtx11extras-module.qdoc | 51 |
2 files changed, 112 insertions, 0 deletions
diff --git a/src/x11extras/doc/src/qtx11extras-index.qdoc b/src/x11extras/doc/src/qtx11extras-index.qdoc new file mode 100644 index 0000000..050c37f --- /dev/null +++ b/src/x11extras/doc/src/qtx11extras-index.qdoc @@ -0,0 +1,61 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** 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$ +** +****************************************************************************/ +/*! + \page qtx11extras-index.html + \title Qt X11 Extras + \brief A Qt module which provides tools for developing for the X11 platform. + + Qt X11 Extras enables the Qt programmer to write applications for the Linux/X11 + platform. Applications developed with Qt can also be deployed across several + other desktop and embedded operating systems without having to rewrite the source + code. + + \section1 Getting Started + + To include the definitions of the module's classes, use the + following directive: + + \code + #include <qx11info_x11.h> + \endcode + + To link against the module, add this line to your \l qmake \c + .pro file: + + \code + QT+=qtx11extras + \endcode + + Requirements for using X11 with Qt: \l{Qt for X11 Requirements} + + \section1 API Reference + + Links to the API reference materials: + \list + \li \l{Qt X11 Extras C++ Classes}{C++ Classes} + \endlist +*/ diff --git a/src/x11extras/doc/src/qtx11extras-module.qdoc b/src/x11extras/doc/src/qtx11extras-module.qdoc new file mode 100644 index 0000000..3b38b5a --- /dev/null +++ b/src/x11extras/doc/src/qtx11extras-module.qdoc @@ -0,0 +1,51 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** 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 QtX11Extras + \title Qt X11 Extras C++ Classes + \ingroup modules + + \brief Provides classes for developing for the X11 platform. + + To include the definitions of the module's classes, use the + following directive: + + \code + #include <qx11info_x11.h> + \endcode + + To link against the module, add this line to your \l qmake \c + .pro file: + + \code + QT+=qtx11extras + \endcode + + +*/ + |