summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2023-03-04 22:41:28 +0000
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2023-03-11 09:34:40 +0000
commitc07c7812078fe03c59b43d487cf9951e5ae2e8b9 (patch)
tree0518d92699e59e1e80ea55b93406725a40af41e3
parent7c28e30b17a62b3a3badeaf7a46cf1dc1a9f791f (diff)
downloadqttools-c07c7812078fe03c59b43d487cf9951e5ae2e8b9.tar.gz
Doc: Document \sincelist QDoc command
Change-Id: I925e1b1afbb62fb582a09921f244d4975f9dc881 Reviewed-by: <safiyyah.moosa@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit ee3f485fb45f2470811ecd8ae1e6813ea2bc9c98) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/qdoc/doc/qdoc-manual-cmdindex.qdoc1
-rw-r--r--src/qdoc/doc/qdoc-manual-markupcmds.qdoc23
2 files changed, 24 insertions, 0 deletions
diff --git a/src/qdoc/doc/qdoc-manual-cmdindex.qdoc b/src/qdoc/doc/qdoc-manual-cmdindex.qdoc
index ac39bc8f5..a915a9f7c 100644
--- a/src/qdoc/doc/qdoc-manual-cmdindex.qdoc
+++ b/src/qdoc/doc/qdoc-manual-cmdindex.qdoc
@@ -105,6 +105,7 @@
\li \l {sectionThree-command} {\\section3}
\li \l {sectionFour-command} {\\section4}
\li \l {since-command} {\\since}
+ \li \l {sincelist-command} {\\sincelist}
\li \l {skipline-command} {\\skipline}
\li \l {skipto-command} {\\skipto}
\li \l {skipuntil-command} {\\skipuntil}
diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
index 782e6cb4a..01608d841 100644
--- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
@@ -60,6 +60,7 @@
\li \l {sectionTwo-command} {\\section2}
\li \l {sectionThree-command} {\\section3}
\li \l {sectionFour-command} {\\section4}
+ \li \l {sincelist-command} {\\sincelist}
\li \l {skipline-command} {\\skipline}
\li \l {skipto-command} {\\skipto}
\li \l {skipuntil-command} {\\skipuntil}
@@ -3970,6 +3971,28 @@
\tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and
\tt {\span {id="color-cyan"} {cyan(#00ffff)}}.
+ \target sincelist-command
+ \section1 \\sincelist
+
+ The \\sincelist command expands to a detailed breakdown of new
+ inclusions to the documented API in a specified version. Example
+ usage:
+
+ \badcode * \QtMajorVersion \QtMinorVersion \QtVer
+ /\1!
+ \page newclasses\2\3.html
+ \title New Classes and Functions in \4
+ \brief A comprehensive list of new classes and functions in \4.
+
+ \sincelist \4
+ \1/
+ \endcode
+
+ \\sincelist takes a single argument, a version string. The generated
+ output includes all functionality that is marked with a
+ \l {since-command}{\\since} command or a \l {since clause} matching
+ the version string.
+
\target unicode-command
\section1 \\unicode