diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-04-17 12:21:10 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2018-04-20 10:17:14 +0000 |
commit | bb09fa7b64b288a68edc61c52ea8467f96eb3924 (patch) | |
tree | a34ce86e2112890f99f762639997e326c5fb5f8e /src/quick3d | |
parent | c5fb8786d31fa0e257c9c50a7ea74610073b2c85 (diff) |
Revert "Doc: Divide documentation into submodules"
This reverts commit c8964b8f1cf56718a189b0f57bad446cec30a8b8.
QDoc now supports documentation-specific custom module headers
and include headers that allow us to keep using a single
documentation project that covers multiple modules.
Change-Id: I84706a7149097a6b03f0f266e55d6f712a6c773e
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/quick3d')
-rw-r--r-- | src/quick3d/quick3dscene2d/doc/qt3dscene2d.qdocconf | 45 | ||||
-rw-r--r-- | src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc | 99 | ||||
-rw-r--r-- | src/quick3d/quick3dscene2d/quick3dscene2d.pro | 2 |
3 files changed, 0 insertions, 146 deletions
diff --git a/src/quick3d/quick3dscene2d/doc/qt3dscene2d.qdocconf b/src/quick3d/quick3dscene2d/doc/qt3dscene2d.qdocconf deleted file mode 100644 index 06e67daa5..000000000 --- a/src/quick3d/quick3dscene2d/doc/qt3dscene2d.qdocconf +++ /dev/null @@ -1,45 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -include(../../../doc/qt3d-config.qdocconf) - -project = Qt3DScene2D -description = Qt 3D Scene2D Reference Documentation -version = $QT_VERSION - -qhp.projects = Qt3DScene2D - -qhp.Qt3DScene2D.file = qt3dscene2d.qhp -qhp.Qt3DScene2D.namespace = org.qt-project.qt3dscene2d.$QT_VERSION_TAG -qhp.Qt3DScene2D.virtualFolder = qt3dscene2d -qhp.Qt3DScene2D.indexTitle = Qt 3D Scene2D -qhp.Qt3DScene2D.indexRoot = - -qhp.Qt3DScene2D.filterAttributes = qt3dscene2d $QT_VERSION qtrefdoc -qhp.Qt3DScene2D.customFilters.Qt.name = Qt3DScene2D $QT_VERSION -qhp.Qt3DScene2D.customFilters.Qt.filterAttributes = qt3dscene2d $QT_VERSION - -qhp.Qt3DScene2D.subprojects = classes qmltypes - -qhp.Qt3DScene2D.subprojects.classes.title = C++ Classes -qhp.Qt3DScene2D.subprojects.classes.indexTitle = Qt 3D Scene2D C++ Classes -qhp.Qt3DScene2D.subprojects.classes.selectors = class doc:headerfile -qhp.Qt3DScene2D.subprojects.classes.sortPages = true - -qhp.Qt3DScene2D.subprojects.qmltypes.title = QML Types -qhp.Qt3DScene2D.subprojects.qmltypes.indexTitle = Qt 3D Scene2D QML Types -qhp.Qt3DScene2D.subprojects.qmltypes.selectors = qmltype -qhp.Qt3DScene2D.subprojects.qmltypes.sortPages = true - -tagfile = qt3dscene2d.tags - -depends += qtcore qtgui qtqml qtquick qtdoc qmake - -# dependencies to other Qt 3D modules -depends += qt3d qt3dcore qt3drender qt3dlogic \ - qt3dinput qt3dextras qt3danimation - -sourcedirs += .. - -headerdirs += .. - -imagedirs += images -exampledirs += snippets diff --git a/src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc b/src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc deleted file mode 100644 index 8809f469a..000000000 --- a/src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc +++ /dev/null @@ -1,99 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2017 The Qt Company Ltd and/or its subsidiary(-ies). -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt3D module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** 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 The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \module Qt3DScene2D - \title Qt 3D Scene2D C++ Classes - \keyword Qt 3D Scene2D - \preliminary - - \brief The Qt 3D Scene2D module provides a way to render Quick2 qml content - to a Qt 3D texture. - - This module is still in development but is available as a technology preview. - This means it is unstable, likely to change and provided as a convenience only. - - \ingroup modules - \ingroup qt3d-modules-preliminary - \qtvariable 3dquickscene2d - - \code - #include <Qt3DQuickScene2D> - \endcode - - To link against the corresponding C++ library, add the following to your qmake project file: - - \badcode - QT += 3dquickscene2d - \endcode - - Classes, types, and functions are declared under the \l [Qt3DScene2D]{Qt3DScene2D} namespace. - - \section1 Overview - - \section2 Scene2D - - \list - \li Qt3DRender::Quick::QScene2D - \endlist - - \section1 Reference - \list - \li \l {Qt 3D Extras C++ Classes} - \li \l {Qt 3D Examples} - \endlist - */ - -/*! - \qmlmodule Qt3D.Scene2D 2.9 - \preliminary - \title Qt 3D Scene2D QML Types - \ingroup qmlmodules - \ingroup qt3d-qmlmodules-preliminary - - \brief Provides Qt 3D QML types for the scene2d module. - - To import and use the module's QML types, use the following statement: - - \badcode - import Qt3D.Scene2D 2.9 - \endcode - - \section1 QML Types -*/ diff --git a/src/quick3d/quick3dscene2d/quick3dscene2d.pro b/src/quick3d/quick3dscene2d/quick3dscene2d.pro index b85863328..fb599187b 100644 --- a/src/quick3d/quick3dscene2d/quick3dscene2d.pro +++ b/src/quick3d/quick3dscene2d/quick3dscene2d.pro @@ -25,6 +25,4 @@ HEADERS += \ include(./items/items.pri) -QMAKE_DOCS = $$PWD/doc/qt3dscene2d.qdocconf - load(qt_module) |