aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick3d/doc/qtquick3d.qdocconf
blob: 0477b3f518eda07659d40ba1c7e62e8c66c3be3e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)

project                 = QtQuick3D
description             = Qt Quick 3D Reference Documentation
version                 = $QT_VERSION
buildversion            = Qt Quick 3D | Commercial or GPLv3

examplesinstallpath     = quick3d
url.examples            = "https://code.qt.io/cgit/qt/qtquick3d.git/tree/examples/\1?h=$QT_VER"
url.sources             = "https://code.qt.io/cgit/qt/qtquick3d.git/tree/\1?h=$QT_VER#n\2"
# Path to the root of qtquick3d (for automatic linking to source code)
url.sources.rootdir     = ../../..

qhp.projects            = QtQuick3D

qhp.QtQuick3D.file                = qtquick3d.qhp
qhp.QtQuick3D.namespace           = org.qt-project.qtquick3d.$QT_VERSION_TAG
qhp.QtQuick3D.virtualFolder       = qtquick3d
qhp.QtQuick3D.indexTitle          = Qt Quick 3D
qhp.QtQuick3D.indexRoot           =

qhp.QtQuick3D.subprojects = manual examples qmltypes classes
qhp.QtQuick3D.subprojects.manual.title = Qt Quick 3D
qhp.QtQuick3D.subprojects.manual.indexTitle = Qt Quick 3D module topics
qhp.QtQuick3D.subprojects.manual.type = manual

qhp.QtQuick3D.subprojects.examples.title = Examples
qhp.QtQuick3D.subprojects.examples.indexTitle = Qt Quick 3D Examples and Tutorials
qhp.QtQuick3D.subprojects.examples.selectors = doc:example
qhp.QtQuick3D.subprojects.examples.sortPages  = true

qhp.QtQuick3D.subprojects.qmltypes.title = QML Types
qhp.QtQuick3D.subprojects.qmltypes.indexTitle = Qt Quick 3D QML Types
qhp.QtQuick3D.subprojects.qmltypes.selectors = qmlclass
qhp.QtQuick3D.subprojects.qmltypes.sortPages = true

qhp.QtQuick3D.subprojects.classes.title      = C++ Classes
qhp.QtQuick3D.subprojects.classes.indexTitle = Qt Quick 3D C++ Classes
qhp.QtQuick3D.subprojects.classes.selectors  = class doc:headerfile
qhp.QtQuick3D.subprojects.classes.sortPages  = true

depends += qtcore qtgui qtdoc qtqml qtqmlmodels qtquick qtquickcontrols qtshadertools qtquicktimeline qtcmake

headerdirs  += .. \
               ../../quick3dparticles \
               ../../runtimerender/extensionapi

headers += ../../helpers/gridgeometry_p.h \
           ../../helpers/randominstancing_p.h \
           ../../helpers/infinitegrid_p.h \
           ../../helpers/instancerepeater_p.h \
           ../../helpers/lookatnode_p.h \
           ../../helpers/heightfieldgeometry_p.h \
           ../../helpers/proceduralskytexturedata_p.h \
           ../../helpers/qquick3dtexturedatafrontend_p.h \
           ../../helpers/proceduralmesh_p.h \
           ../../helpers/extrudedtextgeometry_p.h \
           ../../helpers/torusgeometry_p.h \
           ../../helpers/conegeometry_p.h \
           ../../helpers/cylindergeometry_p.h \
           ../../helpers/spheregeometry_p.h \
           ../../helpers/planegeometry_p.h \
           ../../helpers/cuboidgeometry_p.h \
           ../../helpers/capsulegeometry_p.h \
           ../../assetutils/qquick3druntimeloader_p.h \
           ../../runtimerender/qssgrendercontextcore.h \
           ../../runtimerender/qssgrhicontext.h \
           ../../runtimerender/qssgrenderpickresult.h

sourcedirs  += .. \
               src \
               ../../quick3dparticles \
               ../../runtimerender/extensionapi \
               ../../xr

sources += ../../helpers/gridgeometry.cpp \
           ../../helpers/randominstancing.cpp \
           ../../helpers/infinitegrid.cpp \
           ../../helpers/instancerepeater.cpp \
           ../../helpers/lookatnode.cpp \
           ../../helpers/heightfieldgeometry.cpp \
           ../../helpers/proceduralskytexturedata.cpp \
           ../../helpers/qquick3dtexturedatafrontend.cpp \
           ../../helpers/proceduralmesh.cpp \
           ../../helpers/extrudedtextgeometry.cpp \
           ../../helpers/torusgeometry.cpp \
           ../../helpers/conegeometry.cpp \
           ../../helpers/cylindergeometry.cpp \
           ../../helpers/spheregeometry.cpp \
           ../../helpers/planegeometry.cpp \
           ../../helpers/cuboidgeometry.cpp \
           ../../helpers/capsulegeometry.cpp \
           ../../assetutils/qquick3druntimeloader.cpp \
           ../../runtimerender/qssgrendercontextcore.cpp \
           ../../runtimerender/qssgrhicontext.cpp

exampledirs +=  ../../../examples/quick3d
examples.fileextensions += "*.frag *.geom *.vert *.tesc *.tese *.comp"

imagedirs   += images

# Exclude private header files from the documentation build
excludefiles += "*_p.h"

manifestmeta.highlighted.names = \
    "QtQuick3D/Qt Quick 3D - Particles 3D Testbed Example" \
    "QtQuick3D/Qt Quick 3D - View 3D Example" \
    "QtQuick3D/Virtual Assistant"

navigation.landingpage = "Qt Quick 3D"
navigation.qmltypespage = "Qt Quick 3D QML Types"
navigation.cppclassespage = "Qt Quick 3D C++ Classes"
# Auto-generate navigation linking based on "Qt Quick 3D module topics":
navigation.toctitles = "Qt Quick 3D module topics"
navigation.toctitles.inclusive = false

tagfile                 = qtquick3d.tags
macro.qxr = "Qt Quick 3D Xr"
# Fail the documentation build if warnings exceed the limit
#   src/quick3d/qquick3dtexture.cpp:653: (qdoc) warning: Can't link to 'RenderExtension'
warninglimit = 1