From bcdcf261e3a56de38f23297c1dd784c0c654d0fb Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Mon, 8 Apr 2013 13:57:07 +0200 Subject: 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 Reviewed-by: Jerome Pasion --- src/x11extras/doc/src/qtx11extras-index.qdoc | 61 +++++++++++++++++++++++++++ src/x11extras/doc/src/qtx11extras-module.qdoc | 51 ++++++++++++++++++++++ src/x11extras/qx11info_x11.cpp | 5 ++- 3 files changed, 115 insertions(+), 2 deletions(-) create mode 100644 src/x11extras/doc/src/qtx11extras-index.qdoc create mode 100644 src/x11extras/doc/src/qtx11extras-module.qdoc 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 + \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 + \endcode + + To link against the module, add this line to your \l qmake \c + .pro file: + + \code + QT+=qtx11extras + \endcode + + +*/ + diff --git a/src/x11extras/qx11info_x11.cpp b/src/x11extras/qx11info_x11.cpp index a7499e4..aa35ff1 100644 --- a/src/x11extras/qx11info_x11.cpp +++ b/src/x11extras/qx11info_x11.cpp @@ -62,8 +62,9 @@ QT_BEGIN_NAMESPACE /*! \class QX11Info - \brief The QX11Info class provides information about the X display - configuration. + \inmodule QtX11Extras + \since 5.1 + \brief Provides information about the X display configuration. The class provides two APIs: a set of non-static functions that provide information about a specific widget or pixmap, and a set -- cgit v1.2.1 From a03d4ddf0a8eda87e6a9043259f224a03d4bc68c Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Fri, 19 Apr 2013 13:15:03 +0200 Subject: Doc: Fix module name in .qdocconf Use CamelCase for module name(s) used in in .qdocconf - this is required as qdoc will generate visible output (tags in example manifest files) based on these names. Change-Id: I11ddda5e3c15e9986ce132314d6acfa6839cab1b Reviewed-by: Jerome Pasion --- src/x11extras/doc/qtx11extras.qdocconf | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/src/x11extras/doc/qtx11extras.qdocconf b/src/x11extras/doc/qtx11extras.qdocconf index c2c9611..df6f718 100644 --- a/src/x11extras/doc/qtx11extras.qdocconf +++ b/src/x11extras/doc/qtx11extras.qdocconf @@ -1,27 +1,27 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -project = qtx11extras +project = QtX11Extras description = Qt X11 Extras Reference Documentation url = http://qt-project.org/doc/qt-$QT_VER/qtx11extras version = $QT_VERSION -qhp.projects = qtx11extras +qhp.projects = QtX11Extras -qhp.qtx11extras.file = qtx11extras.qhp -qhp.qtx11extras.namespace = org.qt-project.qtx11extras.$QT_VERSION_TAG -qhp.qtx11extras.virtualFolder = qtx11extras -qhp.qtx11extras.indexTitle = Qt X11 Extras -qhp.qtx11extras.indexRoot = +qhp.QtX11Extras.file = qtx11extras.qhp +qhp.QtX11Extras.namespace = org.qt-project.qtx11extras.$QT_VERSION_TAG +qhp.QtX11Extras.virtualFolder = qtx11extras +qhp.QtX11Extras.indexTitle = Qt X11 Extras +qhp.QtX11Extras.indexRoot = -qhp.qtx11extras.filterAttributes = qtx11extras $QT_VERSION qtrefdoc -qhp.qtx11extras.customFilters.Qt.name = QtX11Extras $QT_VERSION -qhp.qtx11extras.customFilters.Qt.filterAttributes = qtx11extras $QT_VERSION +qhp.QtX11Extras.filterAttributes = qtx11extras $QT_VERSION qtrefdoc +qhp.QtX11Extras.customFilters.Qt.name = QtX11Extras $QT_VERSION +qhp.QtX11Extras.customFilters.Qt.filterAttributes = qtx11extras $QT_VERSION -qhp.qtx11extras.subprojects = classes -qhp.qtx11extras.subprojects.classes.title = C++ Classes -qhp.qtx11extras.subprojects.classes.indexTitle = Qt X11 Extras C++ Classes -qhp.qtx11extras.subprojects.classes.selectors = class fake:headerfile -qhp.qtx11extras.subprojects.classes.sortPages = true +qhp.QtX11Extras.subprojects = classes +qhp.QtX11Extras.subprojects.classes.title = C++ Classes +qhp.QtX11Extras.subprojects.classes.indexTitle = Qt X11 Extras C++ Classes +qhp.QtX11Extras.subprojects.classes.selectors = class fake:headerfile +qhp.QtX11Extras.subprojects.classes.sortPages = true depends += qtcore qtwidgets -- cgit v1.2.1