diff options
| -rw-r--r-- | src/render/doc/qt3drender.qdocconf | 40 | ||||
| -rw-r--r-- | src/render/doc/src/qt3drender-index.qdoc | 51 | ||||
| -rw-r--r-- | src/render/doc/src/qt3drender-module.qdoc | 60 | ||||
| -rw-r--r-- | src/render/render.pro | 2 |
4 files changed, 153 insertions, 0 deletions
diff --git a/src/render/doc/qt3drender.qdocconf b/src/render/doc/qt3drender.qdocconf new file mode 100644 index 000000000..b36800a50 --- /dev/null +++ b/src/render/doc/qt3drender.qdocconf @@ -0,0 +1,40 @@ +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 += src/snippets + +#excludedirs += + +imagedirs += images + +navigation.landingpage = "Qt3D Render" +navigation.cppclassespage = "Qt3D Render C++ Classes" diff --git a/src/render/doc/src/qt3drender-index.qdoc b/src/render/doc/src/qt3drender-index.qdoc new file mode 100644 index 000000000..3c3376a18 --- /dev/null +++ b/src/render/doc/src/qt3drender-index.qdoc @@ -0,0 +1,51 @@ +/**************************************************************************** +** +** 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: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 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 Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 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 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qt3drender-index.html + \title Qt3D Render + + \brief The Qt3D Render module contains functionality to support 2D and 3D rendering using Qt3D. + + \section1 Getting Started + + +*/ diff --git a/src/render/doc/src/qt3drender-module.qdoc b/src/render/doc/src/qt3drender-module.qdoc new file mode 100644 index 000000000..b88690593 --- /dev/null +++ b/src/render/doc/src/qt3drender-module.qdoc @@ -0,0 +1,60 @@ +/**************************************************************************** +** +** 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: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 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 Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 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 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \module Qt3DRender + \title Qt3D Render + \brief The Qt3D Render module contains functionality to support 2D and 3D rendering using Qt3D. + + \ingroup modules + \qtvariable qt3drender + + 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. +*/ + +/*! + \namespace Qt3D + \inmodule Qt3DRender + + The Qt3D namespace contains user-visible classes and types that provide the ability to render + using the Qt3D framework. +*/ diff --git a/src/render/render.pro b/src/render/render.pro index 269074cc3..90dbe4dcb 100644 --- a/src/render/render.pro +++ b/src/render/render.pro @@ -11,6 +11,8 @@ MODULE_PLUGIN_TYPES = \ load(qt_module) +QMAKE_DOCS = $$PWD/doc/qt3drender.qdocconf + include (backend/render-backend.pri) include (frontend/render-frontend.pri) include (io/render-io.pri) |