blob: 5236dc2f7089adb54271c5a43ff6747da2682ff9 (
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
|
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
include($QT_INSTALL_DOCS/global/externalsites.qdocconf)
include($QT_INSTALL_DOCS/config/exampleurl-qtdoc.qdocconf)
project = QtDoc
description = Qt Reference Documentation
version = $QT_VERSION
# Instruct Clang not to look for a module header
moduleheader =
# Depend on everything - load all available index files
depends = *
headerdirs += ../src
imagedirs += ../src/images \
../images
sourcedirs += \
../src
exampledirs += \
../src \
../snippets \
../../examples
excludedirs += \
../src/snippets \
../src/cmake \
../src/platformintegration
# include java files in the list of example sources
examples.fileextensions =+ *.java
# Exclude documentation for the broken examples
excludefiles += \
../../examples/demos/maroon/doc/src/maroon.qdoc \
../../examples/demos/samegame/doc/src/samegame.qdoc \
../../examples/demos/tweetsearch/doc/src/tweetsearch.qdoc
examplesinstallpath =
qhp.projects = QtDoc
qhp.QtDoc.file = qtdoc.qhp
qhp.QtDoc.namespace = org.qt-project.qtdoc.$QT_VERSION_TAG
qhp.QtDoc.virtualFolder = qtdoc
qhp.QtDoc.indexTitle = Qt $QT_VERSION Reference Documentation
qhp.QtDoc.indexRoot =
qhp.QtDoc.subprojects = classes qmltypes examples
qhp.QtDoc.subprojects.classes.title = Classes
qhp.QtDoc.subprojects.classes.indexTitle = All Classes
qhp.QtDoc.subprojects.classes.selectors = class fake:headerfile
qhp.QtDoc.subprojects.classes.sortPages = true
qhp.QtDoc.subprojects.qmltypes.title = QML Types
qhp.QtDoc.subprojects.qmltypes.indexTitle = All QML Types
qhp.QtDoc.subprojects.qmltypes.selectors = qmlclass
qhp.QtDoc.subprojects.qmltypes.sortPages = true
qhp.QtDoc.subprojects.examples.title = Tutorials and Examples
qhp.QtDoc.subprojects.examples.indexTitle = Qt Examples And Tutorials
qhp.QtDoc.subprojects.examples.selectors = fake:example
qhp.QtDoc.subprojects.examples.sortPages = true
# Add an image used in example manifests to qhp, as well as thumbnails for YouTube links
{HTML.extraimages,qhp.QtDoc.extraFiles} += \
images/qt-codesample.png \
images/yIv0vO8B7tQ.jpg \
images/5OiIqFTjUZI.jpg
# Add an .html file with sidebar content, used in the online style
HTML.stylesheets += style/qt5-sidebar.html
macro.indextitle = "\\title Qt $QT_VER"
macro.qtver = "$QT_VER"
macro.qtmajorversion = "$QT_VER"
macro.qtmajorversion.match = "^(\\d+)"
macro.qt5 = "\\l{https://doc.qt.io/qt-5/\1}{\2}"
macro.qtbug = "\\l{https://bugreports.qt.io/browse/\1}{\1}"
manifestmeta.highlighted.names = "QtDoc/Coffee Machine Example" \
"QtDoc/Qt Quick Demo - Same Game" \
"QtDoc/Qt Quick Demo - Calqlatr"
manifestmeta.filters += coffeemachine
manifestmeta.coffeemachine.names = "QtDoc/Coffee Machine Example"
manifestmeta.coffeemachine.tags = quick,embedded
# Include 'Qt for Education' pages
include(../edu/config/qtforeducation.qdocconf)
# Fail the documentation build if there are more warnings than the limit
warninglimit = 0
|