summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicholas Bennett <[email protected]>2023-04-17 13:31:34 +0300
committerNicholas Bennett <[email protected]>2023-08-02 12:47:15 +0000
commit5290ba4cbd1e5bcdc217b58b0495768263097ba3 (patch)
treea0cce85ef97098d97554a65ed0c7ebcea228fe4a
parent8c41125118768ce037698e0605755128b2da705d (diff)
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 <[email protected]>
-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 b2cabeb0396..3c7365a00c0 100644
--- a/doc/global/macros.qdocconf
+++ b/doc/global/macros.qdocconf
@@ -135,3 +135,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"