summaryrefslogtreecommitdiffstats
path: root/doc/global
diff options
context:
space:
mode:
Diffstat (limited to 'doc/global')
-rw-r--r--doc/global/macros.qdocconf4
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