diff options
| author | Kai Köhne <kai.koehne@qt.io> | 2021-09-24 07:48:23 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-10-04 13:55:21 +0000 |
| commit | 380e9b565ffe501a17ffebbd5de7104b4e68f477 (patch) | |
| tree | ef1ef85baf3b99827b91badf3a4e434282dae189 /doc | |
| parent | 13075bb90c865a337e97bce4a7062028493a1cb8 (diff) | |
Doc: Add summary to CMake commands
For normal \page elements, \brief is just showing in the
\generatelist or \annotatedlist commands. Make sure the description
is also visible in the actual CMake command/variable/property
page by defining a \summary macro.
Change-Id: I12bc854d547059a2f6309a5922bb0b2a36d4e41c
Reviewed-by: Craig Scott <craig.scott@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit 23125b3f018f0dd27c761d2ba0e0dfca3d60b4f2)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/global/macros.qdocconf | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf index 0efbf05dfb..5faa7ce9f3 100644 --- a/doc/global/macros.qdocconf +++ b/doc/global/macros.qdocconf @@ -46,6 +46,9 @@ macro.endfloat.HTML = "</div>" macro.clearfloat.HTML = "<br style=\"clear: both\" />" macro.emptyspan.HTML = "<span></span>" +# Use like \brief, but replicates sentence also as text +macro.summary = "\\brief \1\n\n\1\n" + # Expands to the minor version based on the QT_VER environment variable macro.QtMinorVersion = "$QT_VER" macro.QtMinorVersion.match = "\\d+\\.(\\d+)" |