239982901b
* Drop deprecation warnings for now-dropped items * Use the 'qt6' define and a new \nothing doc macro to conditionally document items on Qt 6 * Add a custom module header for docs that pulls in also Vulkan headers * Add \internal command for internal classes/functions * Move QtGUI-related code snippets from widgets to gui docs Change-Id: Ieb386b96631a49568d09059906d307c45c01d93a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
66 lines
2.8 KiB
Plaintext
66 lines
2.8 KiB
Plaintext
macro.aacute.HTML = "á"
|
|
macro.Aring.HTML = "Å"
|
|
macro.aring.HTML = "å"
|
|
macro.Auml.HTML = "Ä"
|
|
macro.author = "\\b{Author:}"
|
|
macro.BR.HTML = "<br />"
|
|
macro.copyright.HTML = "©"
|
|
macro.eacute.HTML = "é"
|
|
macro.gui = "\\b"
|
|
macro.HR.HTML = "<hr />"
|
|
macro.iacute.HTML = "í"
|
|
macro.key = "\\b"
|
|
macro.macos = "macOS"
|
|
macro.menu = "\\b"
|
|
macro.oslash.HTML = "ø"
|
|
macro.ouml.HTML = "ö"
|
|
macro.nothing = "\\dontdocument ()"
|
|
macro.nullptr = "\\c{nullptr}"
|
|
macro.QA = "\\e{Qt Assistant}"
|
|
macro.QD = "\\e{Qt Designer}"
|
|
macro.QL = "\\e{Qt Linguist}"
|
|
macro.Q_OBJECT = "Q_OBJECT"
|
|
macro.QQV = "\\e{Qt QML Viewer}"
|
|
macro.QtVersion = "$QT_VERSION"
|
|
macro.QtVer = "$QT_VER"
|
|
macro.param = "\\e"
|
|
macro.raisedaster.HTML = "<sup>*</sup>"
|
|
macro.raisedaster.DocBook = "\\sup{*}"
|
|
macro.rarrow.HTML = "→"
|
|
macro.reg.HTML = "<sup>®</sup>"
|
|
macro.rego.DocBook = "\\sup{®}"
|
|
macro.return = "Returns"
|
|
macro.starslash = "\\c{*/}"
|
|
macro.begincomment = "\\c{/*}"
|
|
macro.endcomment = "\\c{*/}"
|
|
macro.uuml.HTML = "ü"
|
|
macro.mdash.HTML = "—"
|
|
macro.pi.HTML = "Π"
|
|
macro.beginqdoc.HTML = "/*!"
|
|
macro.endqdoc.HTML = "*/"
|
|
macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv"
|
|
|
|
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>"
|
|
|
|
# Expands to the minor version based on the QT_VER environment variable
|
|
macro.QtMinorVersion = "$QT_VER"
|
|
macro.QtMinorVersion.match = "\\d+\\.(\\d+)"
|
|
|
|
# Embed YouTube content by video ID - Example: \youtube dQw4w9WgXcQ
|
|
# Also requires a <ID>.jpg thumbnail for offline docs. In .qdocconf, add:
|
|
#
|
|
# HTML.extraimages += images/dQw4w9WgXcQ.jpg
|
|
# qhp.ProjectName.extraFiles += images/dQw4w9WgXcQ.jpg
|
|
#
|
|
macro.youtube.HTML = "<div class=\"video\">\n<span class=\"vspan\"></span>\n" \
|
|
"<iframe src=\"https://www.youtube.com/embed/\1\"" \
|
|
"frameborder=\"0\" allowfullscreen>\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" \
|
|
"</iframe></div>\n"
|