1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
qtbase/doc/global/macros.qdocconf

184 lines
8.3 KiB
Plaintext
Raw Permalink Normal View History

Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.aacute.HTML = "&aacute;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.aacute.DocBook = "&#225;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.Aring.HTML = "&Aring;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.Aring.DocBook = "&#197;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.aring.HTML = "&aring;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.aring.DocBook = "&#229;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.Auml.HTML = "&Auml;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.Auml.DocBook = "&#196;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.author = "\\b{Author:}"
macro.BR.HTML = "<br />"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.BR.DocBook = ""
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.copyright.HTML = "&copy;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.copyright.DocBook = "&#169;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.eacute.HTML = "&eacute;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.eacute.DocBook = "&#233;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.gui = "\\b"
macro.HR.HTML = "<hr />"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.HR.DocBook = ""
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.iacute.HTML = "&iacute;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.iacute.DocBook = "&#237;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.key = "\\b"
macro.macos = "macOS"
macro.menu = "\\b"
macro.oslash.HTML = "&oslash;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.oslash.DocBook = "&#248;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.ouml.HTML = "&ouml;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.ouml.DocBook = "&#246;"
Doc: Fix documentation warnings for Qt GUI * 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>
2020-08-01 00:33:49 +02:00
macro.nothing = "\\dontdocument ()"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.nullptr = "\\c{nullptr}"
macro.QtVersion = "$QT_VERSION"
macro.QtVer = "$QT_VER"
macro.param = "\\e"
macro.raisedaster.HTML = "<sup>*</sup>"
Doc: Correct the expansion of the raisedaster macro for DocBook 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. When format specific expansions are provided, QDoc considers the resulting text as if it should be generated verbatim. The "\raisedaster" macro is used to generate an superscript asterisk. The macro is provided for both HTML and DocBook. As the macro has format-specific expansions, the expanded code will be read verbatim. Nonetheless, while the HTML expansion expands to actual HTML, the DocBook expansion expands to an equivalent QDoc code, which will not be generated correctly. To avoid the issue, the DocBook version of "\raisedaster" is modified so that it produces the correct DocBook code. Change-Id: I3a37838bda885af42f8d93b86ec08126d7146ff9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-05-24 16:37:34 +02:00
macro.raisedaster.DocBook = "<db:superscript>*</db:superscript>"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.rarrow.HTML = "&rarr;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.rarrow.DocBook = "&#8594;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.reg.HTML = "<sup>&reg;</sup>"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.reg.DocBook = "\\sup{&#174;}"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.return = "Returns"
macro.starslash = "\\c{*/}"
macro.begincomment = "\\c{/*}"
macro.endcomment = "\\c{*/}"
macro.uuml.HTML = "&uuml;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.uuml.DocBook = "&#252;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.mdash.HTML = "&mdash;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.mdash.DocBook = "&#8212;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02:00
macro.pi.HTML = "&Pi;"
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.pi.DocBook = "&#928;"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02: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 16:27:55 +02:00
macro.beginqdoc.DocBook = "/*!"
Update macros to work with DocBook support Related to https://codereview.qt-project.org/c/qt/qttools/+/276759 Change-Id: Iac9e43ea06b0ef19018094407cde907b38d7c547 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-10-08 19:28:16 +02: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 16:27:55 +02:00
macro.endqdoc.DocBook = "*/"
Doc: Add a custom \borderedimage macro This macro is used similarly to the \image command; it wraps the image in a div with class attribute 'border' that allows additional styling in CSS. Change-Id: I94271074378d79f0e52f1f5a4715a1f84e0254dc Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2016-09-20 14:13:56 +02:00
macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv"
Doc: Fix \examplecategory macro Argument passed to the \ingroup command should not be wrapped in braces as it's read as-is. Pick-to: 6.5 Task-number: QTBUG-111891 Change-Id: Ic759af37e8b7e9f60651103b395fdd7e630779c6 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-04-11 15:50:36 +00:00
macro.examplecategory = "\\meta category {\1}\n\\ingroup category \1"
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:39:04 +02:00
Doc: Remove formatting from \QA, \QD, and \QL macros We don't format other product names, either. Moved all product name macros to a separate section and sorted them in alphabetic order. Change-Id: I84cfd5a350b6e523e05371b809a49146b1c50769 Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
2024-02-21 10:16:02 +01:00
# Macros for product names, sorted in alphabetic order
Doc: Add more global macros for product names Added macros in the qtbase and qttools from the wiki page Fixes: QTBUG-122652 Change-Id: Icb6892741a340ab3cba2ab596e7cbe69a88f22a0 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-04-29 12:39:27 +02:00
macro.B2Q = "Boot to Qt"
macro.B2QSS = "Boot to Qt Software Stack"
macro.B2QST = "Boot to Qt Startup Screen"
macro.IFW = "Qt Installer Framework"
Doc: Remove formatting from \QA, \QD, and \QL macros We don't format other product names, either. Moved all product name macros to a separate section and sorted them in alphabetic order. Change-Id: I84cfd5a350b6e523e05371b809a49146b1c50769 Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
2024-02-21 10:16:02 +01:00
macro.QA = "Qt Assistant"
QtDoc Global: Add macros for Qt Design Studio in qtdoc Adding some Qt Design Studio macros for global qtdoc use. This would ensure flexibility for the documentation writing. Pick-to: 5.15 6.5 6.6 Task-number: QDS-10142 Change-Id: Id61a68d124aad1b8c8f9e17358fb5990efbab5de Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-06-21 15:10:23 +02:00
macro.QB = "Qt Bridge"
Doc: Remove formatting from \QA, \QD, and \QL macros We don't format other product names, either. Moved all product name macros to a separate section and sorted them in alphabetic order. Change-Id: I84cfd5a350b6e523e05371b809a49146b1c50769 Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
2024-02-21 10:16:02 +01:00
macro.QBF = "Qt Bridge for Figma"
QtDoc Global: Add macros for Qt Design Studio in qtdoc Adding some Qt Design Studio macros for global qtdoc use. This would ensure flexibility for the documentation writing. Pick-to: 5.15 6.5 6.6 Task-number: QDS-10142 Change-Id: Id61a68d124aad1b8c8f9e17358fb5990efbab5de Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-06-21 15:10:23 +02:00
macro.QBPS = "Qt Bridge for Adobe Photoshop"
macro.QBSK = "Qt Bridge for Sketch"
Doc: Remove formatting from \QA, \QD, and \QL macros We don't format other product names, either. Moved all product name macros to a separate section and sorted them in alphabetic order. Change-Id: I84cfd5a350b6e523e05371b809a49146b1c50769 Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
2024-02-21 10:16:02 +01:00
macro.QBXD = "Qt Bridge for Adobe XD"
Doc: Add more global macros for product names Added macros in the qtbase and qttools from the wiki page Fixes: QTBUG-122652 Change-Id: Icb6892741a340ab3cba2ab596e7cbe69a88f22a0 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-04-29 12:39:27 +02:00
macro.QC = "Qt Creator"
Doc: Remove formatting from \QA, \QD, and \QL macros We don't format other product names, either. Moved all product name macros to a separate section and sorted them in alphabetic order. Change-Id: I84cfd5a350b6e523e05371b809a49146b1c50769 Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
2024-02-21 10:16:02 +01:00
macro.QD = "Qt Widgets Designer"
macro.QDS = "Qt Design Studio"
macro.QDV = "Qt Design Viewer"
Doc: Add more global macros for product names Added macros in the qtbase and qttools from the wiki page Fixes: QTBUG-122652 Change-Id: Icb6892741a340ab3cba2ab596e7cbe69a88f22a0 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-04-29 12:39:27 +02:00
macro.QfP = "Qt for Python"
Doc: Remove formatting from \QA, \QD, and \QL macros We don't format other product names, either. Moved all product name macros to a separate section and sorted them in alphabetic order. Change-Id: I84cfd5a350b6e523e05371b809a49146b1c50769 Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
2024-02-21 10:16:02 +01:00
macro.QL = "Qt Linguist"
QtDoc Global: Add macros for Qt Design Studio in qtdoc Adding some Qt Design Studio macros for global qtdoc use. This would ensure flexibility for the documentation writing. Pick-to: 5.15 6.5 6.6 Task-number: QDS-10142 Change-Id: Id61a68d124aad1b8c8f9e17358fb5990efbab5de Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-06-21 15:10:23 +02:00
macro.QMCU = "Qt for MCUs"
Doc: Add more global macros for product names Added macros in the qtbase and qttools from the wiki page Fixes: QTBUG-122652 Change-Id: Icb6892741a340ab3cba2ab596e7cbe69a88f22a0 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-04-29 12:39:27 +02:00
macro.QMLP = "QML Profiler"
doc: add macro for QML Language Server product name Add a macro for QML Language Server product name. Pick-to: 6.7 Task-number: QTBUG-120980 Change-Id: I8b7196881a1c3777f975079c22ecbeb6f868f5a6 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2024-01-15 10:33:20 +01:00
macro.QMLLS = "QML Language Server"
Doc: Remove formatting from \QA, \QD, and \QL macros We don't format other product names, either. Moved all product name macros to a separate section and sorted them in alphabetic order. Change-Id: I84cfd5a350b6e523e05371b809a49146b1c50769 Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
2024-02-21 10:16:02 +01:00
macro.QMT = "Qt Maintenance Tool"
macro.QOI = "Qt Online Installer"
Doc: Add more global macros for product names Added macros in the qtbase and qttools from the wiki page Fixes: QTBUG-122652 Change-Id: Icb6892741a340ab3cba2ab596e7cbe69a88f22a0 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-04-29 12:39:27 +02:00
macro.QQEM = "Qt Quick Effect Maker"
Doc: Remove formatting from \QA, \QD, and \QL macros We don't format other product names, either. Moved all product name macros to a separate section and sorted them in alphabetic order. Change-Id: I84cfd5a350b6e523e05371b809a49146b1c50769 Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
2024-02-21 10:16:02 +01:00
macro.QQV = "Qt QML Viewer"
macro.QtAA = "Qt for Android Automotive"
macro.QUL = "Qt Quick Ultralite"
Add Qt Tools for Android Studio Macro \QtTAS Make sure this macro can be used in any documentation regarding the Qt IntelliJ plugin for Android Studio. Task-number: QTBUG-121447 Pick-to: 6.7 Change-Id: I764cd91ea4c1fc7897a9243729a1c6c553739ada Reviewed-by: Tinja Paavoseppä <tinja.paavoseppa@qt.io> Reviewed-by: Rami Potinkara <rami.potinkara@qt.io>
2024-02-21 11:26:07 +02:00
macro.QtTAS = "Qt Tools for Android Studio"
Docs: Create \Q4A macro for "Qt for Android" and replace instances "Android" is trademarked and needs to be referenced in a certain way. The following steps were taken: -Created qdoc macro. -Updated "Qt Android" and "Qt for Android" to use \Q4A in qdoc files. The macro will need to be adopted in all documentation projects. Task-number: QAA-2836 Pick-to: 6.9 6.8 6.5 Change-Id: I4b52247a4ed52047242a06404e6d3aa19de9c16c Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2025-02-26 10:20:48 +02:00
macro.Q4A = "Qt for Android"
QtDoc Global: Add macros for Qt Design Studio in qtdoc Adding some Qt Design Studio macros for global qtdoc use. This would ensure flexibility for the documentation writing. Pick-to: 5.15 6.5 6.6 Task-number: QDS-10142 Change-Id: Id61a68d124aad1b8c8f9e17358fb5990efbab5de Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-06-21 15:10:23 +02:00
Android: add macros for common tools and sdk versions To make it more maintainable and keep the docs up-to-date, define most of the version numbers for various tools used in Qt Android dev environment. Task-number: QTBUG-115020 Pick-to: 6.7 Change-Id: I92aa52398b7700e90a0ffd39a1c40bb7a17c3658 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2023-12-16 14:49:03 +02:00
# 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.
Docs: Correct Android ABI string in build documentation Changed arm64-v8 to arm64-v8a. Pick-to: 6.7 Change-Id: I8ee5a5591bc22c28422643ab0d462b0638624d8c Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2024-05-20 10:15:38 +03:00
macro.AndroidAbis = "\\c{arm64-v8a}, \\c{x86_64}, \\c{x86}, and \\c{armeabi-v7a}"
Docs: Replace supported Android NDK r26b with r27c Updated the macros in qtbase to propagate changes to other doc projects. A separate change has been raised to handle multiple supported ndks in prior LTSs Task-number: QTQAINFRA-6479 Change-Id: Ic052f1b6b80473cc33c7f2be23049969d3cec0ee Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2025-03-25 13:26:49 +02:00
macro.NdkVer = "r27c"
macro.NdkFullVer = "27.2.12479018"
Android: update NDKr26b and clang 17.0.2 to docs Fixes: QTBUG-117993 Pick-to: 6.7 Change-Id: Ice205e0f472f09fcf60ad41f4daac2cdaf3e362a Reviewed-by: Rami Potinkara <rami.potinkara@qt.io> Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2023-12-22 12:15:23 +02:00
macro.NdkCompilerVer = "Clang 17.0.2"
Android: add macros for common tools and sdk versions To make it more maintainable and keep the docs up-to-date, define most of the version numbers for various tools used in Qt Android dev environment. Task-number: QTBUG-115020 Pick-to: 6.7 Change-Id: I92aa52398b7700e90a0ffd39a1c40bb7a17c3658 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2023-12-16 14:49:03 +02:00
macro.JdkVer = "17"
Android: bump min supported SDK to 28 (Android 9) Bump the minimum supported Android API from 23 to 28 i.e. Android Oreo 9. This is done to focus more and more on recent versions. Fixes: QTBUG-125023 Task-number: QTBUG-124890 Change-Id: I4d510b771f413e5711dd44de454211e019c63db6 Reviewed-by: Heikki Halmet <heikki.halmet@qt.io>
2023-03-14 13:46:28 +02:00
macro.AndroidMinApiVer = "28"
Android: update Android 15 SDK 35 to docs This patch updates the macros for Android maxApiVer, AndroidMaxVer, AndroidPlatformVer, AndroidBuildToolsVer variables to reflect Android 15 Task-number: QTBUG-129462 Pick-to: 6.9 6.8 6.5 Change-Id: Ia6edfa7811dd8c98a0a99c10d8781aa09384bdfa Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2025-02-13 11:50:29 +02:00
macro.AndroidMaxApiVer = "35"
Android: bump min supported SDK to 28 (Android 9) Bump the minimum supported Android API from 23 to 28 i.e. Android Oreo 9. This is done to focus more and more on recent versions. Fixes: QTBUG-125023 Task-number: QTBUG-124890 Change-Id: I4d510b771f413e5711dd44de454211e019c63db6 Reviewed-by: Heikki Halmet <heikki.halmet@qt.io>
2023-03-14 13:46:28 +02:00
macro.AndroidMinVer = "9"
Android: update Android 15 SDK 35 to docs This patch updates the macros for Android maxApiVer, AndroidMaxVer, AndroidPlatformVer, AndroidBuildToolsVer variables to reflect Android 15 Task-number: QTBUG-129462 Pick-to: 6.9 6.8 6.5 Change-Id: Ia6edfa7811dd8c98a0a99c10d8781aa09384bdfa Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2025-02-13 11:50:29 +02:00
macro.AndroidMaxVer = "15"
macro.AndroidPlatformVer = "35"
Android: update Android SDK to version 35.0.1 This patch updates the macro AndroidBuildToolsVer to version 35.0.1. The version 35.0.1 is used elsewhere, see b49421a984ac2b203b7995f3787b67184c990089 Amends: 9b475eadfcf04194a094454f65295c3a456000a4 Task-number: QTBUG-129462 Pick-to: 6.9 6.8 6.5 Change-Id: Ic15e12c563fa3d16315daa13b6f6b6ef19535954 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2025-02-25 13:59:43 +02:00
macro.AndroidBuildToolsVer = "35.0.1"
Android: upgrade to Gradle 8.10 and AGP 8.5.2 Bump Gradle version to the latest of 8.10 and Android Gradle Plugin to 8.5.2 which is used by latest stable Android Studio Koala. AndroidX core depenedency doesn't need an update as the latest stable is still 1.13.1. [*] https://developer.android.com/build/releases/gradle- plugin#compatibility [*] https://developer.android.com/build/releases/gradle-plugin#updating- gradle [*] https://github.com/gradle/gradle/releases/tag/v8.10.0 [*] https://developer.android.com/jetpack/androidx/releases/core [ChangeLog][Third-Party Code] Updated Gradle to 8.10 and AGP to 8.5.2. Pick-to: 6.8 6.7 Fixes: QTBUG-126061 Change-Id: I2178915776f7de60a0ca04826b7cee3e120096b3 Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
2024-08-22 13:24:18 +03:00
macro.GradleVer = "8.10"
Android: bump AGP to 8.6.0 which supports Android 15 AGP 8.5.2 still throws a warning about not being tested with Android 15 builds, now 8.6.0 is released and doesn't have the warning. Amends b5d8552f2baab56457d3f39f6b2915c72447b702. Pick-to: 6.8 Fixes: QTBUG-128648 Task-number: QTBUG-126061 Change-Id: I3d7a4c9c184e1a81f0ebb9431a6e3ca9706d19e9 Reviewed-by: Ville Voutilainen <ville.voutilainen@qt.io>
2024-09-08 15:49:16 +03:00
macro.AGPVer = "8.6.0"
Add the use of a macro to control the supported AAOS versions Add the macro and set it to the current support range in 6.7 for Android Automotive OS which is 10 to 13 Pick-to: 6.7 Change-Id: I4342a42f5f56ab9731c969d9cbe0d4291ec3eaf4 Reviewed-by: Rami Potinkara <rami.potinkara@qt.io> Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2024-02-28 16:34:36 +02:00
macro.AAOSVer = "10 to 13"
Android: add macros for common tools and sdk versions To make it more maintainable and keep the docs up-to-date, define most of the version numbers for various tools used in Qt Android dev environment. Task-number: QTBUG-115020 Pick-to: 6.7 Change-Id: I92aa52398b7700e90a0ffd39a1c40bb7a17c3658 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2023-12-16 14:49:03 +02:00
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:39:04 +02: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>"
Doc: Add macro for embedding YouTube videos This macro adds a \youtube <ID> command that embeds a YouTube link into the documentation. The video container scales to a specified percentage of the available horizontal area. It assumes a source aspect ratio of 16:9, but looks acceptable with other ratios. For backends that do not support <iframe> (e.g. QTextBrowser), shows a clickable video thumbnail that open the YouTube link in an external browser window. Unfortunately, QTextBrowser cannot load images from a remote URL, so we need to store a thumbnail image in the .qch file. Change-Id: I3a3a0c5a20dd90e5cec6357ba70a23ee47dbe825 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2017-03-03 10:31:56 +01:00
Adapt qdoc macros and documentation for DocBook Change-Id: I91e380e7670964937d90e478029f367177bf339b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-07-11 01:38:06 +02:00
macro.beginfloatleft.DocBook = ""
macro.beginfloatright.DocBook = ""
macro.endfloat.DocBook = ""
macro.clearfloat.DocBook = ""
macro.emptyspan.DocBook = ""
Doc: Fix usage of \summary macro The macro takes only one parameter, sentences must be wrapped in {}. Pick-to: 6.2 Fixes: QTBUG-97441 Change-Id: I7177548a32a67d720c2b551d16c09d898b0fda51 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2021-10-12 09:09:34 +02:00
# Used like \brief, but replicates the sentence also as text.
# Wrap the entire sentence with {}, for example:
# \summary {Creates a build target.}
Doc: Add summary to CMake commands For normal \page elements, \brief is just showing in the \generatelist or \annotatedlist commands. Make sure the description is also visible in the actual CMake command/variable/property page by defining a \summary macro. Pick-to: 6.2 Change-Id: I12bc854d547059a2f6309a5922bb0b2a36d4e41c Reviewed-by: Craig Scott <craig.scott@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-09-24 07:48:23 +02:00
macro.summary = "\\brief \1\n\n\1\n"
Doc: Add \QtMajorVersion macro This macro expands to the major version of Qt, complementing the already existing \QtMinorVersion macro. Pick-to: 6.2 5.15 Change-Id: I64861f8cc50d73f34369311a19b5e554645a4127 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2021-11-06 17:39:20 +01: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+)\\."
Doc: Add a macro that returns the minor version Add a global QDoc macro \QtMinorVersion that expands into the minor version of Qt, or more specifically, the minor version contained in the QT_VER environment variable. The main use case for the new macro is to document the QML modules whose minor versions track the minor version of Qt: \qmlmodule QtQuick 2.\QtMinorVersion Task-number: QTBUG-67818 Change-Id: I2b4fcbb18de0f8f95718099309090017c237622f Reviewed-by: Martin Smith <martin.smith@qt.io>
2018-09-09 12:39:53 +02:00
macro.QtMinorVersion.match = "\\d+\\.(\\d+)"
Doc: Add macro for embedding YouTube videos This macro adds a \youtube <ID> command that embeds a YouTube link into the documentation. The video container scales to a specified percentage of the available horizontal area. It assumes a source aspect ratio of 16:9, but looks acceptable with other ratios. For backends that do not support <iframe> (e.g. QTextBrowser), shows a clickable video thumbnail that open the YouTube link in an external browser window. Unfortunately, QTextBrowser cannot load images from a remote URL, so we need to store a thumbnail image in the .qch file. Change-Id: I3a3a0c5a20dd90e5cec6357ba70a23ee47dbe825 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2017-03-03 10:31:56 +01:00
# Embed YouTube content by video ID - Example: \youtube dQw4w9WgXcQ
qdoc: improve \youtube documentation for DocBook images The same kind of line is required for DocBook as HTML or QHP. This change makes that requirement clear. It was suggested by Nicholas Bennett in a change in existing configuration for this exact line. Change-Id: I664300f229bac9931c6f1ac4a08bd7c8c42bf37c Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2022-10-05 00:48:49 +02: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:
Doc: Add macro for embedding YouTube videos This macro adds a \youtube <ID> command that embeds a YouTube link into the documentation. The video container scales to a specified percentage of the available horizontal area. It assumes a source aspect ratio of 16:9, but looks acceptable with other ratios. For backends that do not support <iframe> (e.g. QTextBrowser), shows a clickable video thumbnail that open the YouTube link in an external browser window. Unfortunately, QTextBrowser cannot load images from a remote URL, so we need to store a thumbnail image in the .qch file. Change-Id: I3a3a0c5a20dd90e5cec6357ba70a23ee47dbe825 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2017-03-03 10:31:56 +01:00
#
Doc: Fix usage instructions for the \youtube macro The example configuration included a space character that caused a syntax error parsing the .qdocconf. Replace the hardcoded qhp `QtDoc` project name with a placeholder. Pick-to: 6.9 6.8 Change-Id: Iadf3a50e030f02182016ed9832f4f59d29f82c57 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2024-09-26 09:04:25 +00:00
# {HTML.extraimages,qhp.<qhp_project>.extraFiles,DocBook.extraimages} += images/dQw4w9WgXcQ.jpg
Doc: Add macro for embedding YouTube videos This macro adds a \youtube <ID> command that embeds a YouTube link into the documentation. The video container scales to a specified percentage of the available horizontal area. It assumes a source aspect ratio of 16:9, but looks acceptable with other ratios. For backends that do not support <iframe> (e.g. QTextBrowser), shows a clickable video thumbnail that open the YouTube link in an external browser window. Unfortunately, QTextBrowser cannot load images from a remote URL, so we need to store a thumbnail image in the .qch file. Change-Id: I3a3a0c5a20dd90e5cec6357ba70a23ee47dbe825 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2017-03-03 10:31:56 +01:00
#
Doc: Fix usage instructions for the \youtube macro The example configuration included a space character that caused a syntax error parsing the .qdocconf. Replace the hardcoded qhp `QtDoc` project name with a placeholder. Pick-to: 6.9 6.8 Change-Id: Iadf3a50e030f02182016ed9832f4f59d29f82c57 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2024-09-26 09:04:25 +00:00
# Where <qhp_project> is a project name listed in `qhp.projects`.
doc: Remove vertical space before youtube video links in offline mode The vspan was originally added for iframes. They are not needed (and look weird) for normal images/links. Pick-to: 6.1 Fixes: QTBUG-92266 Change-Id: I9da2b52234b2e49bc0cdef4bf8f0865fb092bb31 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2021-03-31 17:41:06 +02:00
macro.youtube.HTML = "<div class=\"video\">\n" \
Doc: Add macro for embedding YouTube videos This macro adds a \youtube <ID> command that embeds a YouTube link into the documentation. The video container scales to a specified percentage of the available horizontal area. It assumes a source aspect ratio of 16:9, but looks acceptable with other ratios. For backends that do not support <iframe> (e.g. QTextBrowser), shows a clickable video thumbnail that open the YouTube link in an external browser window. Unfortunately, QTextBrowser cannot load images from a remote URL, so we need to store a thumbnail image in the .qch file. Change-Id: I3a3a0c5a20dd90e5cec6357ba70a23ee47dbe825 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2017-03-03 10:31:56 +01: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" \
Doc: Make \youtube macro work with litehtml help backend Unlike the QTextBrowser backend, litehtml does not render elements inside <iframe> correctly. This prevented external links to YouTube from working in offline documentation. Move the <iframe> to a macro override specific to online doc builds. Pick-to: 6.0 6.0.0 Fixes: QTBUG-88975 Change-Id: Iff7828ddeed353620eaa9ac669a3e0c03749daa2 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-11-27 16:31:54 +01:00
"</div>\n"
Doc: Add DocBook version of youtube macro 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 "\youtube" macro is defined, for HTML, so that a youtube video can be embedded by reference. To avoid losing the usage of "\youtube" when generating DocBook, an equivalent version expansion of the macro is now provided for the DocBook format. Change-Id: Id74155f2c30b80b5f4490f8451cd8d00535806d6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-05-24 15:50:43 +02:00
macro.youtube.DocBook = "<db:mediaobject>\n" \
"<db:videoobject>\n" \
DocBook: indicate more clearly what a YouTube video is The previous description was too bare bones and did not allow further processing of the file. The new implementation gives more information and is consistent with what the standard xslTNG style sheets expect (https://github.com/docbook/xslTNG/blob/2.2.0/src/test/resources/xml/mo-1/preface.xml). Previous versions of the style sheets do not support video embedding. Change-Id: I1604858b6ad6254c4006470521a30cc0acd7b136 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2024-02-14 14:09:51 +01:00
"<?db video="iframe"?>\n" \
"<db:videodata format="youtube" fileref=\"https://www.youtube.com/watch/?v=\1\">\n" \
Doc: Add DocBook version of youtube macro 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 "\youtube" macro is defined, for HTML, so that a youtube video can be embedded by reference. To avoid losing the usage of "\youtube" when generating DocBook, an equivalent version expansion of the macro is now provided for the DocBook format. Change-Id: Id74155f2c30b80b5f4490f8451cd8d00535806d6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-05-24 15:50:43 +02:00
"</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"
Doc: Add macro to exclude examples from Creator Done-with: Topi Reinö <topi.reinio@qt.io> Change-Id: I069214e3139c8b9993b5b8f86e4b5cda1dcc2bfd Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-10-27 11:27:25 +01:00
Long live \constraints! We have divergence in the way we document function, operator and constructor constraints. About half use \note, while the other doesn't. Some say "if and only if" while others say just "participates only if". So add a qdoc macro, \constraints, to semantically mark up these constraints. It expands to a section titled `Constraints`, and uses a predefined sentence (prefix) for constraints. Documentation for constraints is moved to the end of the comment blocks to separate them from the rest of the text. Apply them to all the standard-ish constraint documentation blocks (grepped for "participate"). I didn't look for other, one-off, ways documentation authors may have documented constraints, but I'm also not aware of any. Re-wrap lines only if the result fits into a single line. As a drive-by, drop additional "if"s, as in "only if X and -if- Y" to make the texts work with the `Constraints` section. Fixes: QTBUG-106871 Pick-to: 6.9 6.8 6.5 Change-Id: I18c2f9f734474017264e49165389f8c9c7f34030 Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
2025-02-06 08:15:36 +01:00
#
# C++ constrained function templates
#
macro.constraints = "\\section1 Constraints\n\nParticipates in overload resolution only if "
Doc: Add macro to exclude examples from Creator Done-with: Topi Reinö <topi.reinio@qt.io> Change-Id: I069214e3139c8b9993b5b8f86e4b5cda1dcc2bfd Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-10-27 11:27:25 +01:00
macro.excludefromcreator = "\\meta tag broken"
Doc: Add partial documentation for CMake API (tech preview) There are still other parts of the CMake API that are not yet documented. This change only addresses qt_add_executable() and the Android-related commands it uses. Fixes: QTBUG-88839 Task-number: QTBUG-84482 Pick-to: 6.0 Change-Id: I761b5ce908d1f62284baabe2d414cd37a0efe83d Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2020-12-17 12:30:43 +11: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."
Doc: State Qt versions for when CMake commands etc. were introduced Introduce the qdoc macros \cmakecommandsince, \cmakepropertysince, and \cmakevariablesince that insert a paragraph akin to the \since context command. Example: \cmakecommandsince 6.3 produces the paragraph This command was introduced in Qt 6.3 The macro text is wrapped in \n\n to ensure that we always generate a new paragraph. Pick-to: 6.2 6.3 Task-number: QTBUG-100212 Change-Id: Id5c8e8812e6b0b915674d108a0e775091e9eacd8 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
2022-01-26 15:29:17 +01: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"
Doc: Add partial documentation for CMake API (tech preview) There are still other parts of the CMake API that are not yet documented. This change only addresses qt_add_executable() and the Android-related commands it uses. Fixes: QTBUG-88839 Task-number: QTBUG-84482 Pick-to: 6.0 Change-Id: I761b5ce908d1f62284baabe2d414cd37a0efe83d Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2020-12-17 12:30:43 +11: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."
Doc: Add global \versionlessCMakeCommandsNote qdoc macro When documenting a CMake command, document the unversioned command 'qt_foo' and use '\versionlessCMakeCommandNote qt6_foo' to refer to the versioned command. This avoids duplicating the command signature. Use the new macro where applicable. Pick-to: 6.2 Task-number: QTBUG-95796 Change-Id: I2e4180fbda0b89acf3d8c036459f591eb2f46475 Reviewed-by: Craig Scott <craig.scott@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
2021-08-11 10:29:18 +02: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."
wasm: move user configurable settings Both INITIAL_MEMORY and PTHREAD_POOL_SIZE are settings users can change, they are not interface settings. Fixes: QTBUG-100693 Pick-to: 6.3 6.2 Change-Id: Ie1547c7f52c9fe109a313260616705728024b6b8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: David Skoland <david.skoland@qt.io>
2022-02-14 09:28:51 +10:00
macro.cmakepropertywebassemblyonly = "\\note This property is used only if targeting the WebAssembly platform."
CMake: Add reference documentation for QT_IOS_LAUNCH_SCREEN Amends 578f4ba00c9fce9af922c9924ca104bc47e50f03 Pick-to: 6.4 Task-number: QTBUG-104519 Change-Id: I02ea0694ead0e5b8c7a70a09cc14b51d8e374dd5 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
2022-08-11 18:50:11 +02:00
macro.cmakepropertyiosonly = "\\note This property is used only if targeting iOS."
macro.cmakevariableiosonly = "\\note This variable is used only if targeting iOS."
Introduce macro.qtpolicydeprecatedbehavior for Qt CMake Policy Added a template that we can use instead of rewriting the message for every policy. Pick-to: 6.6 Change-Id: I13cc182244d5f092e3d5677664bc149c6b126da5 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
2023-07-07 13:59:41 +02:00
macro.qtpolicydeprecatedbehavior = "\\note The \\c{OLD} behavior of a policy is deprecated, and may be removed in the future."
Docs: Add a macro for documenting something as a technical preview Adds a warning symbol. Adds a note to the brief string. Pick-to: 6.5 6.6 Change-Id: Ib036295bbcf7ab5eca7fd554fb2da836fedad8a0 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2023-04-17 13:31:34 +03:00
#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"
Doc: Add macros for generating a grid structure of items These macros generate a a three-column grid of items in online documentation. These make for a clutter-free and more visually pleasing result in many cases, compared to a standard \table layout. For compatibility reasons, these macros continue to output a table structure in offline documentation builds. Task-number: QTWEBSITE-1144 Change-Id: Iab994b383f488dbd225c6a04d64cf41e2dbb20e9 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2024-04-26 13:49:11 +00:00
include(grid.qdocconf)
Create qdoc macros for C++ class docs 1.1: member-swap(), traditional phrasing We have some patterns for how to document certain functions, but we also vary the sentences a lot, and you have to look up one documentation piece and copy it, essentially. If we ever want to change them, we end up with shotgun surgery. So apply DRY to the documentation and start a collection of macros to help with repetitive C++ class documentation tasks. The first macro is for member-swap(), and the first patch is for documentation that used the traditional phrasing ("Swaps the X \a other with this X."). This doesn't change the documentation, except as follows: * adds the "very fast and never fails" blurb, if it was missing * changes the function's argument name to `other`, as required by the macro. Task-number: QTBUG-129573 Pick-to: 6.8 6.7 6.5 6.2 Change-Id: Ib494bd218334724b3b43796ba6f71fb52b83aa94 Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
2024-10-02 18:46:01 +02:00
include(cpp-doc-macros.qdocconf)
Reference in New Issue Copy Permalink