diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2021-10-12 09:09:34 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-10-12 16:37:41 +0000 |
| commit | ca3918ceb6dcdc1e4f0fe4ebd3f8cfa0de8e17c3 (patch) | |
| tree | 36e06e6dc7745fb0d9e29c472ce78bd20e8a0ee9 /doc | |
| parent | 53d297af05a15acaa8dbee8d3afbfd2785fbc2f5 (diff) | |
Doc: Fix usage of \summary macro
The macro takes only one parameter, sentences must be wrapped in {}.
Fixes: QTBUG-97441
Change-Id: I7177548a32a67d720c2b551d16c09d898b0fda51
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit b8360981791f876d835d3c3efcb1c6821e421b81)
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, 3 insertions, 1 deletions
diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf index 5faa7ce9f3..d165d291b4 100644 --- a/doc/global/macros.qdocconf +++ b/doc/global/macros.qdocconf @@ -46,7 +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 +# Used like \brief, but replicates the sentence also as text. +# Wrap the entire sentence with {}, for example: +# \summary {Creates a build target.} macro.summary = "\\brief \1\n\n\1\n" # Expands to the minor version based on the QT_VER environment variable |