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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
macro.aacute.HTML = "á"
macro.aacute.DocBook = "á"
macro.Aring.HTML = "Å"
macro.Aring.DocBook = "Å"
macro.aring.HTML = "å"
macro.aring.DocBook = "å"
macro.Auml.HTML = "Ä"
macro.Auml.DocBook = "Ä"
macro.author = "\\b{Author:}"
macro.BR.HTML = "<br />"
macro.BR.DocBook = ""
macro.copyright.HTML = "©"
macro.copyright.DocBook = "©"
macro.eacute.HTML = "é"
macro.eacute.DocBook = "é"
macro.gui = "\\b"
macro.HR.HTML = "<hr />"
macro.HR.DocBook = ""
macro.iacute.HTML = "í"
macro.iacute.DocBook = "í"
macro.key = "\\b"
macro.macos = "macOS"
macro.menu = "\\b"
macro.oslash.HTML = "ø"
macro.oslash.DocBook = "ø"
macro.ouml.HTML = "ö"
macro.ouml.DocBook = "ö"
macro.nothing = "\\dontdocument ()"
macro.nullptr = "\\c{nullptr}"
macro.QtVersion = "$QT_VERSION"
macro.QtVer = "$QT_VER"
macro.param = "\\e"
macro.raisedaster.HTML = "<sup>*</sup>"
macro.raisedaster.DocBook = "<db:superscript>*</db:superscript>"
macro.rarrow.HTML = "→"
macro.rarrow.DocBook = "→"
macro.reg.HTML = "<sup>®</sup>"
macro.reg.DocBook = "\\sup{®}"
macro.return = "Returns"
macro.starslash = "\\c{*/}"
macro.begincomment = "\\c{/*}"
macro.endcomment = "\\c{*/}"
macro.uuml.HTML = "ü"
macro.uuml.DocBook = "ü"
macro.mdash.HTML = "—"
macro.mdash.DocBook = "—"
macro.pi.HTML = "Π"
macro.pi.DocBook = "Π"
macro.beginqdoc.HTML = "/*!"
macro.beginqdoc.DocBook = "/*!"
macro.endqdoc.HTML = "*/"
macro.endqdoc.DocBook = "*/"
macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv"
macro.examplecategory = "\\meta category {\1}\n\\ingroup category \1"
# Macros for product names, sorted in alphabetic order
macro.B2Q = "Boot to Qt"
macro.B2QSS = "Boot to Qt Software Stack"
macro.B2QST = "Boot to Qt Startup Screen"
macro.IFW = "Qt Installer Framework"
macro.QA = "Qt Assistant"
macro.QB = "Qt Bridge"
macro.QBF = "Qt Bridge for Figma"
macro.QBPS = "Qt Bridge for Adobe Photoshop"
macro.QBSK = "Qt Bridge for Sketch"
macro.QBXD = "Qt Bridge for Adobe XD"
macro.QC = "Qt Creator"
macro.QD = "Qt Widgets Designer"
macro.QDS = "Qt Design Studio"
macro.QDV = "Qt Design Viewer"
macro.QfP = "Qt for Python"
macro.QL = "Qt Linguist"
macro.QMCU = "Qt for MCUs"
macro.QMLP = "QML Profiler"
macro.QMLLS = "QML Language Server"
macro.QMT = "Qt Maintenance Tool"
macro.QOI = "Qt Online Installer"
macro.QQEM = "Qt Quick Effect Maker"
macro.QQV = "Qt QML Viewer"
macro.QtAA = "Qt for Android Automotive"
macro.QUL = "Qt Quick Ultralite"
macro.QtTAS = "Qt Tools for Android Studio"
# The following macros are used for various Android docs. The purpose is to keep
# it as simple as updating these instead of updating multiple lines in scattered locations.
macro.AndroidAbis = "\\c{arm64-v8a}, \\c{x86_64}, \\c{x86}, and \\c{armeabi-v7a}"
macro.NdkVer = "r26b"
macro.NdkFullVer = "26.1.10909125"
macro.NdkCompilerVer = "Clang 17.0.2"
macro.JdkVer = "17"
macro.AndroidMinApiVer = "28"
macro.AndroidMaxApiVer = "34"
macro.AndroidMinVer = "9"
macro.AndroidMaxVer = "14"
macro.AndroidPlatformVer = "34"
macro.AndroidBuildToolsVer = "34.0.0"
macro.GradleVer = "8.10"
macro.AGPVer = "8.6.0"
macro.AAOSVer = "10 to 13"
macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">"
macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">"
macro.endfloat.HTML = "</div>"
macro.clearfloat.HTML = "<br style=\"clear: both\" />"
macro.emptyspan.HTML = "<span></span>"
macro.beginfloatleft.DocBook = ""
macro.beginfloatright.DocBook = ""
macro.endfloat.DocBook = ""
macro.clearfloat.DocBook = ""
macro.emptyspan.DocBook = ""
# Used like \brief, but replicates the sentence also as text.
# Wrap the entire sentence with {}, for example:
# \summary {Creates a build target.}
macro.summary = "\\brief \1\n\n\1\n"
# Macros that expand to the major and minor versions based on the QT_VER environment variable
{macro.QtMajorVersion,macro.QtMinorVersion} = "$QT_VER"
macro.QtMajorVersion.match = "^(\\d+)\\."
macro.QtMinorVersion.match = "\\d+\\.(\\d+)"
# Embed YouTube content by video ID - Example: \youtube dQw4w9WgXcQ
# Also requires a <ID>.jpg thumbnail for offline docs. By default, qdoc doesn't copy the thumbnail
# along with the offline docs, you must specify it manually. In .qdocconf, to do it for all formats
# at once, add:
#
# {HTML.extraimages,qhp.<qhp_project>.extraFiles,DocBook.extraimages} += images/dQw4w9WgXcQ.jpg
#
# Where <qhp_project> is a project name listed in `qhp.projects`.
macro.youtube.HTML = "<div class=\"video\">\n" \
"<a href=\"https://www.youtube.com/watch/?v=\1\">\n"\
"<img src=\"images/\1.jpg\"" \
"title=\"Click to play in a browser\" /></a>\n" \
"</div>\n"
macro.youtube.DocBook = "<db:mediaobject>\n" \
"<db:videoobject>\n" \
"<db:videodata fileref=\"\1\">\n" \
"</db:videodata>\n" \
"</db:videoobject>\n" \
"<db:imageobject>\n" \
"<db:imagedata fileref=\"images/\1.jpg\">\n" \
"</db:imagedata>\n" \
"</db:imageobject>\n" \
"</db:mediaobject>\n"
macro.excludefromcreator = "\\meta tag broken"
macro.preliminarycmakecommand = "\\note This command is in technology preview and may change in future releases."
macro.preliminarycmakevariable = "\\note This variable is in technology preview and may change in future releases."
macro.preliminarycmakeproperty = "\\note This property is in technology preview and may change in future releases."
macro.cmakecommandsince = "\n\nThis command was introduced in Qt \1.\n\n"
macro.cmakevariablesince = "\n\nThis variable was introduced in Qt \1.\n\n"
macro.cmakepropertysince = "\n\nThis property was introduced in Qt \1.\n\n"
macro.cmakecommandandroidonly = "\\note This command should only be called if targeting the Android platform."
macro.cmakepropertyandroidonly = "\\note This property is used only if targeting the Android platform."
macro.cmakevariableandroidonly = "\\note This variable is used only if targeting the Android platform."
macro.versionlessCMakeCommandsNote = "If \\l{Versionless commands}{versionless commands} are disabled, use \\c{\1} instead. It supports the same set of arguments as this command."
macro.cmakepropertywebassemblyonly = "\\note This property is used only if targeting the WebAssembly platform."
macro.cmakepropertyiosonly = "\\note This property is used only if targeting iOS."
macro.cmakevariableiosonly = "\\note This variable is used only if targeting iOS."
macro.qtpolicydeprecatedbehavior = "\\note The \\c{OLD} behavior of a policy is deprecated, and may be removed in the future."
#Appends the tech preview link to the brief sentence and adds to tech_preview
#group.
#Must be placed directly under a \brief command
macro.techpreview = "(Technical preview)\n\n\\meta status {Technical preview}\n\\ingroup tech_preview\n"
include(grid.qdocconf)
include(cpp-doc-macros.qdocconf)
|
