summaryrefslogtreecommitdiffstats
path: root/src/core/doc/qtwebengine.qdocconf
blob: 644e5d1454edad06399ccd7d5913fe78186200bb (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
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
include($QT_INSTALL_DOCS/config/exampleurl-qtwebengine.qdocconf)

project                 = QtWebEngine
description             = Qt WebEngine Reference Documentation
version                 = $QT_VERSION

qhp.projects            = QtWebEngine

qhp.QtWebEngine.file                = qtwebengine.qhp
qhp.QtWebEngine.namespace           = org.qt-project.qtwebengine.$QT_VERSION_TAG
qhp.QtWebEngine.virtualFolder       = qtwebengine
qhp.QtWebEngine.indexTitle          = Qt WebEngine
qhp.QtWebEngine.indexRoot           =

qhp.QtWebEngine.subprojects = manual examples widgetexamples classes qmltypes

qhp.QtWebEngine.subprojects.classes.title = C++ Classes and Namespaces
qhp.QtWebEngine.subprojects.classes.indexTitle = Qt WebEngine C++ Classes and Namespaces
qhp.QtWebEngine.subprojects.classes.selectors = class group:qtwebengine-namespaces doc:headerfile
qhp.QtWebEngine.subprojects.classes.sortPages = true

qhp.QtWebEngine.subprojects.qmltypes.title = QML Types
qhp.QtWebEngine.subprojects.qmltypes.indexTitle = Qt WebEngine QML Types
qhp.QtWebEngine.subprojects.qmltypes.selectors = qmltype qmlvaluetype
qhp.QtWebEngine.subprojects.qmltypes.sortPages = true

qhp.QtWebEngine.subprojects.examples.title = Examples (Quick)
qhp.QtWebEngine.subprojects.examples.indexTitle = Qt WebEngine Quick Examples
qhp.QtWebEngine.subprojects.examples.selectors = group:webengine-examples
qhp.QtWebEngine.subprojects.examples.sortPages = true

qhp.QtWebEngine.subprojects.widgetexamples.title = Examples (Widgets)
qhp.QtWebEngine.subprojects.widgetexamples.indexTitle = Qt WebEngine Widgets Examples
qhp.QtWebEngine.subprojects.widgetexamples.selectors = group:webengine-widgetexamples
qhp.QtWebEngine.subprojects.widgetexamples.sortPages = true

qhp.QtWebEngine.subprojects.manual.title = Qt WebEngine
qhp.QtWebEngine.subprojects.manual.indexTitle = Qt WebEngine module topics
qhp.QtWebEngine.subprojects.manual.type = manual

manifestmeta.highlighted.names += "QtWebEngine/WebEngine Widgets Simple Browser Example" \
                "QtWebEngine/WebEngine Quick Nano Browser" \
                "QtWebEngine/Recipe Browser"

tagfile                 = ../../../doc/qtwebengine/qtwebengine.tags

# Custom module header for clang that pulls in also QtWebEngineWidgets
moduleheader = QtWebEngineDoc

# Additional include paths for clang
includepaths += -I .

depends += qtcore \
           qtcore5compat \
           qtdesigner \
           qtgui \
           qtnetwork \
           qtprintsupport \
           qtpositioning \
           qtqml \
           qtqmlmodels \
           qtquick \
           qtquickcontrols \
           qtdoc \
           qtcmake \
           qtwebchannel \
           qtwebview \
           qtwidgets

headerdirs  += ../../core/api \
               ../../webenginequick/api \
               ../../webenginewidgets/api

sourcedirs  += ../../core/api \
               ../../core/doc \
               ../../core/tools/webenginedriver \
               ../../webenginequick/api \
               ../../webenginequick/doc \
               ../../webenginewidgets/api \
               ../../webenginewidgets/doc

exampledirs +=  ../../../examples \
                ../../core/doc/snippets \
                ../../webenginequick/doc/snippets \
                ../../webenginewidgets/doc/snippets

# Path to the root of qtwebengine (for automatic linking to source code)
url.sources.rootdir     = ../../..

#exclude Qt PDF example directories
excludedirs += ../../../examples/pdfwidgets \
               ../../../examples/pdf

examples.fileextensions += *.aff *.dic *.html

imagedirs += \
             images \
             ../../webenginequick/doc/images

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

# \QWE macro expands to 'Qt WebEngine' without auto-linking anywhere.
macro.QWE    = "Qt \\WebEngine"

# QTBUG-134416: Ignore overwrite warnings, attribution
# documentation generates many of these
spurious += "Output file already exists, overwriting .*"

# Enforce zero documentation warnings
warninglimit = 2