summaryrefslogtreecommitdiffstats
path: root/src/doc/qt3d.qdocconf
blob: 5ea4cd6f813b846bc1a7307c2d9f4bf6288e7bfa (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
122
123
124
125
126
127
128
129
130
131
132
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)

project                 = Qt3D
description             = Qt 3D Reference Documentation
version                 = $QT_VERSION

moduleheader            = Qt3DDoc
includepaths            = -I . \
                          -I $QT_INSTALL_HEADERS \
                          -I $QT_INSTALL_HEADERS/Qt3DCore \
                          -I $QT_INSTALL_HEADERS/Qt3DCore/$QT_VERSION \
                          -I $QT_INSTALL_HEADERS/Qt3DAnimation \
                          -I $QT_INSTALL_HEADERS/Qt3DAnimation/$QT_VERSION \
                          -I $QT_INSTALL_HEADERS/Qt3DInput \
                          -I $QT_INSTALL_HEADERS/Qt3DInput/$QT_VERSION

examplesinstallpath     = qt3d

qhp.projects            = Qt3D

qhp.Qt3D.file                = qt3d.qhp
qhp.Qt3D.namespace           = org.qt-project.qt3d.$QT_VERSION_TAG
qhp.Qt3D.virtualFolder       = qt3d
qhp.Qt3D.indexTitle          = Qt 3D
qhp.Qt3D.indexRoot           =

qhp.Qt3D.filterAttributes                   = qt3d $QT_VERSION qtrefdoc
qhp.Qt3D.customFilters.Qt.name              = Qt3D $QT_VERSION
qhp.Qt3D.customFilters.Qt.filterAttributes  = qt3d $QT_VERSION

qhp.Qt3D.subprojects                    = classes qmltypes examples

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

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

qhp.Qt3D.subprojects.examples.title      = Examples
qhp.Qt3D.subprojects.examples.indexTitle = Qt 3D Examples
qhp.Qt3D.subprojects.examples.selectors  = doc:example
qhp.Qt3D.subprojects.examples.sortPages  = true

tagfile                 = qt3d.tags

depends                 += qtcore qtgui qtqml qtquick qtdoc

headerdirs += . \
              ../render \
              ../core \
              ../logic \
              ../plugins \
              ../quick3d/quick3d \
              ../input \
              ../extras \
              ../animation \
              ../quick3d/quick3dscene2d \
              ../quick3d/imports/scene3d

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

# Add some private headers explicitly to avoid documentation warnings
headers       = ../core/transforms/matrix4x4_p.h \
                ../core/transforms/vector3d_p.h \
                ../render/raycasting/qray3d_p.h \
                ../animation/frontend/qchannelmappingcreatedchange_p.h \
                ../input/frontend/qabstractphysicaldeviceproxy_p.h \
                ../input/frontend/qinputdeviceintegration_p.h \
                ../quick3d/imports/scene3d/scene3ditem_p.h

sourcedirs += . \
              ../render \
              ../core \
              ../logic \
              ../plugins \
              ../quick3d/quick3d \
              ../input \
              ../extras \
              ../animation \
              ../quick3d/quick3dscene2d \
              ../quick3d/imports/scene3d


exampledirs += ../../examples/qt3d \
               snippets

examples.fileextensions       += "*.fraq *.geom *.vert"
examples.imageextensions      += "*.png"

excludedirs += \
              ../plugins/renderplugins \
              ../plugins/sceneparsers

macro.TODO = " "
imagedirs   += images \
               ../../examples/qt3d/shadow-map-qml/doc/images \
               ../../examples/qt3d/basicshapes-cpp/doc/images \
               ../../examples/qt3d/planets-qml/doc/images \
               ../../examples/qt3d/wireframe/doc/images \
               ../../examples/qt3d/audio-visualizer-qml/doc/images \
               ../../examples/qt3d/simplecustommaterial/doc/images \
               ../../examples/qt3d/scene2d/doc/images \
               ../../examples/qt3d/advancedcustommaterial/doc/images

Cpp.ignoretokens     += QT3DINPUTSHARED_EXPORT \
                        QT3DCORESHARED_EXPORT \
                        QT3DLOGIC_PRIVATE_EXPORT \
                        QT3DLOGICSHARED_EXPORT \
                        QT3DRENDERSHARED_EXPORT \
                        QT3DRENDERSHARED_PRIVATE_EXPORT \
                        QT3DQUICKSHARED_PRIVATE_EXPORT \
                        QT3DEXTRASSHARED_EXPORT \
                        QT3DANIMATIONSHARED_EXPORT \
                        QT3DQUICKSCENE2DSHARED_EXPORT

Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY

manifestmeta.highlighted.names = \
                "Qt3D/Qt 3D: Advanced custom material QML Example" \
                "Qt3D/Qt 3D: Audio Visualizer Example" \
                "Qt3D/Qt 3D: Planets QML Example"

manifestmeta.thumbnail.names += "Qt3D/Qt 3D: Deferred Renderer C++ Example"

navigation.landingpage = "Qt 3D"
navigation.cppclassespage = "Qt 3D C++ Classes"
navigation.qmltypespage = "Qt 3D QML Types"