From 301be51c4c53668de48ed18040e12c74896c58e4 Mon Sep 17 00:00:00 2001 From: Sean Harmer Date: Thu, 11 Jun 2015 12:35:31 +0100 Subject: Use Qt3DRenderer consistently for documentation configuration Change-Id: Ibea422bfe658c89dad919f98b7269bc801c9c295 Reviewed-by: Kai Koehne Reviewed-by: Paul Lemire --- src/core/doc/qt3dcore.qdocconf | 2 +- src/render/doc/qt3drender.qdocconf | 44 ----------------- src/render/doc/qt3drenderer.qdocconf | 44 +++++++++++++++++ src/render/doc/src/qt3drender-index.qdoc | 77 ----------------------------- src/render/doc/src/qt3drender-module.qdoc | 63 ----------------------- src/render/doc/src/qt3drenderer-index.qdoc | 77 +++++++++++++++++++++++++++++ src/render/doc/src/qt3drenderer-module.qdoc | 63 +++++++++++++++++++++++ src/render/render.pro | 2 +- 8 files changed, 186 insertions(+), 186 deletions(-) delete mode 100644 src/render/doc/qt3drender.qdocconf create mode 100644 src/render/doc/qt3drenderer.qdocconf delete mode 100644 src/render/doc/src/qt3drender-index.qdoc delete mode 100644 src/render/doc/src/qt3drender-module.qdoc create mode 100644 src/render/doc/src/qt3drenderer-index.qdoc create mode 100644 src/render/doc/src/qt3drenderer-module.qdoc diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf index db2848ae8..251c0ab67 100644 --- a/src/core/doc/qt3dcore.qdocconf +++ b/src/core/doc/qt3dcore.qdocconf @@ -32,7 +32,7 @@ qhp.Qt3DCore.subprojects.qmltypes.sortPages = true tagfile = ../../../doc/qt3dcore/qt3dcore.tags -depends += qtcore qtqml qtquick qtdoc qt3drender +depends += qtcore qtqml qtquick qtdoc qt3drenderer headerdirs += .. \ ../../plugins \ diff --git a/src/render/doc/qt3drender.qdocconf b/src/render/doc/qt3drender.qdocconf deleted file mode 100644 index 204f96baa..000000000 --- a/src/render/doc/qt3drender.qdocconf +++ /dev/null @@ -1,44 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) - -project = Qt3DRender -description = Qt3D Render Reference Documentation -version = $QT_VERSION - -examplesinstallpath = qt3d - -qhp.projects = Qt3DRender - -qhp.Qt3DRender.file = qt3drender.qhp -qhp.Qt3DRender.namespace = org.qt-project.qt3drender.$QT_VERSION_TAG -qhp.Qt3DRender.virtualFolder = qt3drender -qhp.Qt3DRender.indexTitle = Qt3D Render -qhp.Qt3DRender.indexRoot = - -qhp.Qt3DRender.filterAttributes = qt3drender $QT_VERSION qtrefdoc -qhp.Qt3DRender.customFilters.Qt.name = Qt3DRender $QT_VERSION -qhp.Qt3DRender.customFilters.Qt.filterAttributes = qt3drender $QT_VERSION - -qhp.Qt3DRender.subprojects = classes -qhp.Qt3DRender.subprojects.classes.title = C++ Classes -qhp.Qt3DRender.subprojects.classes.indexTitle = Qt3D Render C++ Classes -qhp.Qt3DRender.subprojects.classes.selectors = class fake:headerfile -qhp.Qt3DRender.subprojects.classes.sortPages = true - -tagfile = ../../../doc/qt3drender/qt3drender.tags - -depends += qtcore qtqml qtquick qt3dcore qtdoc - -headerdirs += .. -sourcedirs += .. -exampledirs += ../../../examples/qt3d \ - src/snippets - -imagedirs += images - -Cpp.ignoretokens += QT3DRENDERERSHARED_EXPORT \ - QT3DRENDERERSHARED_PRIVATE_EXPORT - -Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY - -navigation.landingpage = "Qt3D Render" -navigation.cppclassespage = "Qt3D Render C++ Classes" diff --git a/src/render/doc/qt3drenderer.qdocconf b/src/render/doc/qt3drenderer.qdocconf new file mode 100644 index 000000000..4214188db --- /dev/null +++ b/src/render/doc/qt3drenderer.qdocconf @@ -0,0 +1,44 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = Qt3DRenderer +description = Qt3D Renderer Reference Documentation +version = $QT_VERSION + +examplesinstallpath = qt3d + +qhp.projects = Qt3DRenderer + +qhp.Qt3DRenderer.file = qt3drenderer.qhp +qhp.Qt3DRenderer.namespace = org.qt-project.qt3drenderer.$QT_VERSION_TAG +qhp.Qt3DRenderer.virtualFolder = qt3drenderer +qhp.Qt3DRenderer.indexTitle = Qt3D Renderer +qhp.Qt3DRenderer.indexRoot = + +qhp.Qt3DRenderer.filterAttributes = qt3drenderer $QT_VERSION qtrefdoc +qhp.Qt3DRenderer.customFilters.Qt.name = Qt3DRenderer $QT_VERSION +qhp.Qt3DRenderer.customFilters.Qt.filterAttributes = qt3drenderer $QT_VERSION + +qhp.Qt3DRenderer.subprojects = classes +qhp.Qt3DRenderer.subprojects.classes.title = C++ Classes +qhp.Qt3DRenderer.subprojects.classes.indexTitle = Qt3D Renderer C++ Classes +qhp.Qt3DRenderer.subprojects.classes.selectors = class fake:headerfile +qhp.Qt3DRenderer.subprojects.classes.sortPages = true + +tagfile = ../../../doc/qt3drenderer/qt3drenderer.tags + +depends += qtcore qtqml qtquick qt3dcore qtdoc + +headerdirs += .. +sourcedirs += .. +exampledirs += ../../../examples/qt3d \ + src/snippets + +imagedirs += images + +Cpp.ignoretokens += QT3DRENDERERSHARED_EXPORT \ + QT3DRENDERERSHARED_PRIVATE_EXPORT + +Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY + +navigation.landingpage = "Qt3D Renderer" +navigation.cppclassespage = "Qt3D Renderer C++ Classes" diff --git a/src/render/doc/src/qt3drender-index.qdoc b/src/render/doc/src/qt3drender-index.qdoc deleted file mode 100644 index 2a517ac81..000000000 --- a/src/render/doc/src/qt3drender-index.qdoc +++ /dev/null @@ -1,77 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB). -** Contact: http://www.qt-project.org/legal -** -** This file is part of the Qt3D module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL3$ -** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free -** Software Foundation and appearing in the file LICENSE.GPL included in -** the packaging of this file. Please review the following information to -** ensure the GNU General Public License version 2.0 requirements will be -** met: http://www.gnu.org/licenses/gpl-2.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \page qt3drender-index.html - \title Qt3D Render - \ingroup qt3d-modules - \brief The Qt3D Render module contains functionality to support 2D and 3D rendering using Qt3D. - - \section1 Getting Started - - To use Qt3D classes, add this directive into the C++ files: - - \code - #include - \endcode - - To link against the corresponding C++ libraries, add the following to your qmake project file: - - \code - QT += 3drenderer - \endcode - - \section1 Reference - \list - \li \l {Qt3D Render C++ Classes} - \li \l {Qt3D Examples} - \endlist -*/ - -/*! - \page qt3d-examples.html - \ingroup all-examples - \title Qt3D Examples - \brief Examples that demostrate 2D and 3D rendering using Qt3D. - - The following examples demonstrate 2D and 3D rendering using Qt3D. - - \section1 QML Examples - \annotatedlist qt3d-examples-qml - - \section1 C++ Examples - \annotatedlist qt3d-examples-cpp -*/ diff --git a/src/render/doc/src/qt3drender-module.qdoc b/src/render/doc/src/qt3drender-module.qdoc deleted file mode 100644 index 1deb4bff8..000000000 --- a/src/render/doc/src/qt3drender-module.qdoc +++ /dev/null @@ -1,63 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB). -** Contact: http://www.qt-project.org/legal -** -** This file is part of the Qt3D module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL3$ -** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free -** Software Foundation and appearing in the file LICENSE.GPL included in -** the packaging of this file. Please review the following information to -** ensure the GNU General Public License version 2.0 requirements will be -** met: http://www.gnu.org/licenses/gpl-2.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \module Qt3DRender - \title Qt3D Render C++ Classes - \brief The Qt3D Render module contains functionality to support 2D and 3D rendering using Qt3D. - - \ingroup modules - \qtvariable 3drender - - The Qt3D Render module provides an aspect, components, and other supporting types necessary - to implement 2D and 3D rendering as part of the Qt3D framework. - - Classes, types, and functions are declared under the \l [Qt3DCore]{Qt3D} namespace. -*/ - -/*! - \qmlmodule Qt3D.Render 2.0 - \title Qt3D Render QML Types - \ingroup qmlmodules - - \brief Provides Qt3D QML types for rendering. - - To import and use the module's QML types, use the following statement: - - \badcode - import Qt3D.Render 2.0 - \endcode -*/ diff --git a/src/render/doc/src/qt3drenderer-index.qdoc b/src/render/doc/src/qt3drenderer-index.qdoc new file mode 100644 index 000000000..0aa93fc9c --- /dev/null +++ b/src/render/doc/src/qt3drenderer-index.qdoc @@ -0,0 +1,77 @@ +/**************************************************************************** +** +** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the Qt3D module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL3$ +** 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 http://www.qt.io/terms-conditions. For further +** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free +** Software Foundation and appearing in the file LICENSE.GPL included in +** the packaging of this file. Please review the following information to +** ensure the GNU General Public License version 2.0 requirements will be +** met: http://www.gnu.org/licenses/gpl-2.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qt3drender-index.html + \title Qt3D Renderer + \ingroup qt3d-modules + \brief The Qt3D Renderer module contains functionality to support 2D and 3D rendering using Qt3D. + + \section1 Getting Started + + To use Qt3D classes, add this directive into the C++ files: + + \code + #include + \endcode + + To link against the corresponding C++ libraries, add the following to your qmake project file: + + \code + QT += 3drenderer + \endcode + + \section1 Reference + \list + \li \l {Qt3D Renderer C++ Classes} + \li \l {Qt3D Examples} + \endlist +*/ + +/*! + \page qt3d-examples.html + \ingroup all-examples + \title Qt3D Examples + \brief Examples that demostrate 2D and 3D rendering using Qt3D. + + The following examples demonstrate 2D and 3D rendering using Qt3D. + + \section1 QML Examples + \annotatedlist qt3d-examples-qml + + \section1 C++ Examples + \annotatedlist qt3d-examples-cpp +*/ diff --git a/src/render/doc/src/qt3drenderer-module.qdoc b/src/render/doc/src/qt3drenderer-module.qdoc new file mode 100644 index 000000000..25b551ce4 --- /dev/null +++ b/src/render/doc/src/qt3drenderer-module.qdoc @@ -0,0 +1,63 @@ +/**************************************************************************** +** +** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the Qt3D module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL3$ +** 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 http://www.qt.io/terms-conditions. For further +** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free +** Software Foundation and appearing in the file LICENSE.GPL included in +** the packaging of this file. Please review the following information to +** ensure the GNU General Public License version 2.0 requirements will be +** met: http://www.gnu.org/licenses/gpl-2.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \module Qt3DRenderer + \title Qt3D Renderer C++ Classes + \brief The Qt3D Renderer module contains functionality to support 2D and 3D rendering using Qt3D. + + \ingroup modules + \qtvariable 3drenderer + + The Qt3D Renderer module provides an aspect, components, and other supporting types necessary + to implement 2D and 3D rendering as part of the Qt3D framework. + + Classes, types, and functions are declared under the \l [Qt3DCore]{Qt3D} namespace. +*/ + +/*! + \qmlmodule Qt3D.Renderer 2.0 + \title Qt3D Renderer QML Types + \ingroup qmlmodules + + \brief Provides Qt3D QML types for rendering. + + To import and use the module's QML types, use the following statement: + + \badcode + import Qt3D.Renderer 2.0 + \endcode +*/ diff --git a/src/render/render.pro b/src/render/render.pro index 2d9c2d3bd..03f05e9ba 100644 --- a/src/render/render.pro +++ b/src/render/render.pro @@ -11,7 +11,7 @@ MODULE_PLUGIN_TYPES = \ load(qt_module) -QMAKE_DOCS = $$PWD/doc/qt3drender.qdocconf +QMAKE_DOCS = $$PWD/doc/qt3drenderer.qdocconf include (backend/render-backend.pri) include (frontend/render-frontend.pri) -- cgit v1.2.3