2019-10-08 17:28:16 +00:00
macro.aacute.HTML = "á"
2022-07-10 23:38:06 +00:00
macro.aacute.DocBook = "á"
2019-10-08 17:28:16 +00:00
macro.Aring.HTML = "Å"
2022-07-10 23:38:06 +00:00
macro.Aring.DocBook = "Å"
2019-10-08 17:28:16 +00:00
macro.aring.HTML = "å"
2022-07-10 23:38:06 +00:00
macro.aring.DocBook = "å"
2019-10-08 17:28:16 +00:00
macro.Auml.HTML = "Ä"
2022-07-10 23:38:06 +00:00
macro.Auml.DocBook = "Ä"
2019-10-08 17:28:16 +00:00
macro.author = "\\b{Author:}"
macro.BR.HTML = "<br />"
2022-07-10 23:38:06 +00:00
macro.BR.DocBook = ""
2019-10-08 17:28:16 +00:00
macro.copyright.HTML = "©"
2022-07-10 23:38:06 +00:00
macro.copyright.DocBook = "©"
2019-10-08 17:28:16 +00:00
macro.eacute.HTML = "é"
2022-07-10 23:38:06 +00:00
macro.eacute.DocBook = "é"
2019-10-08 17:28:16 +00:00
macro.gui = "\\b"
macro.HR.HTML = "<hr />"
2022-07-10 23:38:06 +00:00
macro.HR.DocBook = ""
2019-10-08 17:28:16 +00:00
macro.iacute.HTML = "í"
2022-07-10 23:38:06 +00:00
macro.iacute.DocBook = "í"
2019-10-08 17:28:16 +00:00
macro.key = "\\b"
macro.macos = "macOS"
macro.menu = "\\b"
macro.oslash.HTML = "ø"
2022-07-10 23:38:06 +00:00
macro.oslash.DocBook = "ø"
2019-10-08 17:28:16 +00:00
macro.ouml.HTML = "ö"
2022-07-10 23:38:06 +00:00
macro.ouml.DocBook = "ö"
2020-07-31 22:33:49 +00:00
macro.nothing = "\\dontdocument ()"
2019-10-08 17:28:16 +00:00
macro.nullptr = "\\c{nullptr}"
macro.QA = "\\e{Qt Assistant}"
macro.QD = "\\e{Qt Designer}"
macro.QL = "\\e{Qt Linguist}"
2020-01-22 12:47:08 +00:00
macro.Q_OBJECT = "Q_OBJECT"
2019-10-08 17:28:16 +00:00
macro.QQV = "\\e{Qt QML Viewer}"
macro.QtVersion = "$QT_VERSION"
macro.QtVer = "$QT_VER"
macro.param = "\\e"
macro.raisedaster.HTML = "<sup>*</sup>"
2023-05-24 14:37:34 +00:00
macro.raisedaster.DocBook = "<db:superscript>*</db:superscript>"
2019-10-08 17:28:16 +00:00
macro.rarrow.HTML = "→"
2022-07-10 23:38:06 +00:00
macro.rarrow.DocBook = "→"
2019-10-08 17:28:16 +00:00
macro.reg.HTML = "<sup>®</sup>"
2022-07-10 23:38:06 +00:00
macro.reg.DocBook = "\\sup{®}"
2019-10-08 17:28:16 +00:00
macro.return = "Returns"
macro.starslash = "\\c{*/}"
macro.begincomment = "\\c{/*}"
macro.endcomment = "\\c{*/}"
macro.uuml.HTML = "ü"
2022-07-10 23:38:06 +00:00
macro.uuml.DocBook = "ü"
2019-10-08 17:28:16 +00:00
macro.mdash.HTML = "—"
2022-07-10 23:38:06 +00:00
macro.mdash.DocBook = "—"
2019-10-08 17:28:16 +00:00
macro.pi.HTML = "Π"
2022-07-10 23:38:06 +00:00
macro.pi.DocBook = "Π"
2019-10-08 17:28:16 +00:00
macro.beginqdoc.HTML = "/*!"
Doc: Provide a DocBook version of the beginqdoc and endqdoc macros
QDoc allows code-expanding macros to be defined so that the user can
abstract away common code in a simple to use command.
Furthermore, macros allows for a different expansion based on the
currently generated format so that format-specific requirements can be
satisfied when required.
Due to a certain bug in QDoc, when generating the DocBook format, QDoc
would expand an HTML specific macro definition when a DocBook specific
one was not provided.
As this bug is now being fixed, the DocBook format will lose some of the
output that it was previously generating.
For example, the "\beginqdoc" and "\endqdoc" macros are defined, for
HTML, to expand to the beginning of block-comment text, "/*!" and ending
of block-comment text, "*/".
To avoid losing the usage of "\beginqdoc" and "\endqdoc`" when
generating DocBook, an equivalent expansion of the macro is now provided
for the DocBook format.
Change-Id: I45fb54f1f56077771c091323a69fd63e09a910eb
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2023-05-24 14:27:55 +00:00
macro.beginqdoc.DocBook = "/*!"
2019-10-08 17:28:16 +00:00
macro.endqdoc.HTML = "*/"
Doc: Provide a DocBook version of the beginqdoc and endqdoc macros
QDoc allows code-expanding macros to be defined so that the user can
abstract away common code in a simple to use command.
Furthermore, macros allows for a different expansion based on the
currently generated format so that format-specific requirements can be
satisfied when required.
Due to a certain bug in QDoc, when generating the DocBook format, QDoc
would expand an HTML specific macro definition when a DocBook specific
one was not provided.
As this bug is now being fixed, the DocBook format will lose some of the
output that it was previously generating.
For example, the "\beginqdoc" and "\endqdoc" macros are defined, for
HTML, to expand to the beginning of block-comment text, "/*!" and ending
of block-comment text, "*/".
To avoid losing the usage of "\beginqdoc" and "\endqdoc`" when
generating DocBook, an equivalent expansion of the macro is now provided
for the DocBook format.
Change-Id: I45fb54f1f56077771c091323a69fd63e09a910eb
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2023-05-24 14:27:55 +00:00
macro.endqdoc.DocBook = "*/"
2016-09-20 12:13:56 +00:00
macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv"
2023-04-11 15:50:36 +00:00
macro.examplecategory = "\\meta category {\1}\n\\ingroup category \1"
2012-10-26 10:39:04 +00:00
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>"
2017-03-03 09:31:56 +00:00
2022-07-10 23:38:06 +00:00
macro.beginfloatleft.DocBook = ""
macro.beginfloatright.DocBook = ""
macro.endfloat.DocBook = ""
macro.clearfloat.DocBook = ""
macro.emptyspan.DocBook = ""
2021-10-12 07:09:34 +00:00
# Used like \brief, but replicates the sentence also as text.
# Wrap the entire sentence with {}, for example:
# \summary {Creates a build target.}
2021-09-24 05:48:23 +00:00
macro.summary = "\\brief \1\n\n\1\n"
2021-11-06 16:39:20 +00:00
# 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+)\\."
2018-09-09 10:39:53 +00:00
macro.QtMinorVersion.match = "\\d+\\.(\\d+)"
2017-03-03 09:31:56 +00:00
# Embed YouTube content by video ID - Example: \youtube dQw4w9WgXcQ
2022-10-04 22:48:49 +00:00
# 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:
2017-03-03 09:31:56 +00:00
#
2022-10-04 22:48:49 +00:00
# {HTML.extraimages,qhp.QtDoc.extraFiles, DocBook.extraimages} += images/dQw4w9WgXcQ.jpg
2017-03-03 09:31:56 +00:00
#
2021-03-31 15:41:06 +00:00
macro.youtube.HTML = "<div class=\"video\">\n" \
2017-03-03 09:31:56 +00:00
"<a href=\"https://www.youtube.com/watch/?v=\1\">\n"\
"<img src=\"images/\1.jpg\"" \
"title=\"Click to play in a browser\" /></a>\n" \
2020-11-27 15:31:54 +00:00
"</div>\n"
2023-05-24 13:50:43 +00:00
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"
2020-10-27 10:27:25 +00:00
macro.excludefromcreator = "\\meta tag broken"
2020-12-17 01:30:43 +00:00
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."
2022-01-26 14:29:17 +00:00
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"
2020-12-17 01:30:43 +00:00
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."
2021-08-11 08:29:18 +00:00
macro.versionlessCMakeCommandsNote = "If \\l{Versionless commands}{versionless commands} are disabled, use \\c{\1} instead. It supports the same set of arguments as this command."
2022-02-13 23:28:51 +00:00
macro.cmakepropertywebassemblyonly = "\\note This property is used only if targeting the WebAssembly platform."
2022-08-11 16:50:11 +00:00
macro.cmakepropertyiosonly = "\\note This property is used only if targeting iOS."
macro.cmakevariableiosonly = "\\note This variable is used only if targeting iOS."
