b720e4ae04
Make sure this macro can be used in any documentation regarding the Qt IntelliJ plugin for Android Studio. Task-number: QTBUG-121447 Change-Id: I764cd91ea4c1fc7897a9243729a1c6c553739ada Reviewed-by: Tinja Paavoseppä <tinja.paavoseppa@qt.io> Reviewed-by: Rami Potinkara <rami.potinkara@qt.io> (cherry picked from commit 2bae857aadaf9d0c67d9cba91f5f71805227f06d) Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
164 lines
7.5 KiB
Plaintext
164 lines
7.5 KiB
Plaintext
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.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 = "<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"
|
|
|
|
macro.QDS = "Qt Design Studio"
|
|
macro.QDV = "Qt Design Viewer"
|
|
macro.QB = "Qt Bridge"
|
|
macro.QBPS = "Qt Bridge for Adobe Photoshop"
|
|
macro.QBXD = "Qt Bridge for Adobe XD"
|
|
macro.QBSK = "Qt Bridge for Sketch"
|
|
macro.QBF = "Qt Bridge for Figma"
|
|
macro.QMCU = "Qt for MCUs"
|
|
macro.QUL = "Qt Quick Ultralite"
|
|
macro.QtAA = "Qt for Android Automotive"
|
|
macro.QOI = "Qt Online Installer"
|
|
macro.QMT = "Qt Maintenance Tool"
|
|
macro.QMLLS = "QML Language Server"
|
|
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-v8}, \\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 = "26"
|
|
macro.AndroidMaxApiVer = "34"
|
|
macro.AndroidMinVer = "8.0"
|
|
macro.AndroidMaxVer = "14"
|
|
macro.AndroidPlatformVer = "33"
|
|
macro.AndroidBuildToolsVer = "34.0.0"
|
|
macro.GradleVer = "8.3"
|
|
macro.AGPVer = "7.4.1"
|
|
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.QtDoc.extraFiles, DocBook.extraimages} += images/dQw4w9WgXcQ.jpg
|
|
#
|
|
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"
|