diff options
| author | Joerg Bornemann <joerg.bornemann@qt.io> | 2022-01-26 15:29:17 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-02-01 21:31:55 +0000 |
| commit | 1bc2653bdeb5bbf5e1592acdb5977efb34d0b645 (patch) | |
| tree | 1333c8b2c3ae28b82d8f00589a081ee27a18a441 /doc | |
| parent | 034f1c1052c9153aa035022302f800e78cb6718b (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.
Task-number: QTBUG-100212
Change-Id: Id5c8e8812e6b0b915674d108a0e775091e9eacd8
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
(cherry picked from commit 0ad8dd480509369091f91c2370ddfdd86506cd85)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/global/macros.qdocconf | 4 |
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." |