summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicholas Bennett <nicholas.bennett@qt.io>2023-04-17 13:31:34 +0300
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2023-08-16 06:55:44 +0000
commitd53745d7021c675049ea5f9a558e9f8f0a0edf3e (patch)
tree94a12b74ffc6e42bee606221b592ee0590da6c7d
parent9f1c5945b776b730aeaa597e6ba5d0a406e88e3a (diff)
Docs: Add a macro for documenting something as a technical preview
Adds a warning symbol. Adds a note to the brief string. Change-Id: Ib036295bbcf7ab5eca7fd554fb2da836fedad8a0 Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 5290ba4cbd1e5bcdc217b58b0495768263097ba3) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--doc/global/macros.qdocconf4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf
index 808027f1c3..381cc11528 100644
--- a/doc/global/macros.qdocconf
+++ b/doc/global/macros.qdocconf
@@ -113,3 +113,7 @@ 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"