diff options
| author | Joerg Bornemann <joerg.bornemann@qt.io> | 2021-08-11 10:29:18 +0200 |
|---|---|---|
| committer | Joerg Bornemann <joerg.bornemann@qt.io> | 2021-08-23 13:06:27 +0200 |
| commit | c3308b13ca1d21eb6119297341588d8df1242637 (patch) | |
| tree | 0befe9588d1d9760e6331146b8f9aac3fccf513d /doc | |
| parent | fd9a94594fc42347e1b08f83ae62e7d42aee1e6b (diff) | |
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/global/macros.qdocconf | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf index 93d5749354..0efbf05dfb 100644 --- a/doc/global/macros.qdocconf +++ b/doc/global/macros.qdocconf @@ -71,3 +71,5 @@ macro.preliminarycmakeproperty = "\\note This property is in technology preview 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." + +macro.versionlessCMakeCommandsNote = "If \\l{Versionless commands}{versionless commands} are disabled, use \\c{\1} instead. It supports the same set of arguments as this command." |