summaryrefslogtreecommitdiffstats
path: root/doc/config/ifw.qdocconf
blob: 16a94b5c41930685ef83a57f89f2ebb73d0f1c5b (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
include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf)
include($QT_INSTALL_DOCS/global/compat.qdocconf)
include($QT_INSTALL_DOCS/global/fileextensions.qdocconf)

includepaths += \
                ../../src/libs/installer \
                ../../src/libs/3rdparty/7zip/unix/CPP \
                ../../src/libs/3rdparty/7zip/win/CPP \
                ../../src/libs/3rdparty/libarchive

language    = Cpp
project     = "QtInstallerFramework"
description = "Qt Installer Framework Documentation"
url         = https://doc.qt.io/qtinstallerframework/

sourcedirs += ../../src/libs/installer ../../src/libs/kdtools ../includes
headerdirs += ../../src/libs/installer ../../src/libs/kdtools

imagedirs = ../images
exampledirs = .. \
              ../../examples

headers.fileextensions         = "*.h"
sources.fileextensions         = "*.qdoc *.qdocinc *.cpp"
examples.fileextensions        = "*.js *.qs *.txt *.xml *.ui *.ts"
examples.imageextensions       = "*.png"

indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \
           $QT_INSTALL_DOCS/qtwidgets/qtwidgets.index \
           $QT_INSTALL_DOCS/qtqml/qtqml.index \
           $QT_INSTALL_DOCS/qtxml/qtxml.index \
           $QT_INSTALL_DOCS/qtconcurrent/qtconcurrent.index \
           $QT_INSTALL_DOCS/qtnetwork/qtnetwork.index \
           $QT_INSTALL_DOCS/qtdoc/qtdoc.index

qhp.projects            = InstallerFramework
qhp.InstallerFramework.file             = ifw.qhp
qhp.InstallerFramework.namespace        = org.qt-project.ifw.$QT_VERSION_TAG
qhp.InstallerFramework.virtualFolder    = doc
qhp.InstallerFramework.indexTitle       = Qt Installer Framework Documentation
qhp.InstallerFramework.filterAttributes = ifw
qhp.InstallerFramework.customFilters.InstallerFramework.name = Installer Framework
qhp.InstallerFramework.customFilters.InstallerFramework.filterAttributes = ifw
qhp.InstallerFramework.indexRoot        =

qhp.InstallerFramework.subprojects = manual
qhp.InstallerFramework.subprojects.manual.title = Qt Installer Framework Documentation
qhp.InstallerFramework.subprojects.manual.indexTitle = All Topics
qhp.InstallerFramework.subprojects.manual.type = manual

macro.IFW = "Qt Installer Framework"
macro.MT = "maintenance tool"
macro.QOI = "Qt Online Installer"

# For docs, QT_VERSION resolves to IFW version
macro.ifwversion = $QT_VERSION


# Show IFW version at the top of the sidebar TOC and in the <title> element of each HTML file
version = $QT_VERSION
buildversion = Qt Installer Framework $QT_VERSION

# commands borrowed from qtbase/doc/global/macros.qdocconf

macro.gui               = "\\b"
macro.key               = "\\b"

# Doxygen compatibility commands

macro.see                       = "\\sa"
macro.function                  = "\\fn"


# We 'misuse' QML doc commands to generate JS documentation
# (only works with qdoc from Qt 5)

outputprefixes = QML
outputprefixes.QML =

navigation.homepage = "Qt Installer Framework Documentation"
navigation.toctitles = "All Topics"