summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoerg Bornemann <joerg.bornemann@qt.io>2022-01-26 15:29:17 +0100
committerJoerg Bornemann <joerg.bornemann@qt.io>2022-02-01 16:51:01 +0100
commit0ad8dd480509369091f91c2370ddfdd86506cd85 (patch)
treec194975b51bbafeb145bb2f1a8c097b522f96582 /doc
parent1031fa15472bba3f20691cda2305e0821391c5db (diff)
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>
Diffstat (limited to 'doc')
-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 8b5f499d07..37c5a3ea1c 100644
--- a/doc/global/macros.qdocconf
+++ b/doc/global/macros.qdocconf
@@ -74,6 +74,10 @@ macro.preliminarycmakecommand = "\\note This command is in technology preview a
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."