diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2026-02-24 11:52:58 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2026-02-24 22:55:34 +0000 |
| commit | 9fefa4d39cca9e1ecb0fb92530e89edc113df7c3 (patch) | |
| tree | aea2eb7553adadcc2da5f463a1b3772ccc230e54 | |
| parent | c15888e01cc296e221754597e5d3ed742fd7a2f6 (diff) | |
Doc: Use standard bracket syntax for QDoc snippet markers
QDoc's \include command resolves named snippets by matching
bracket-delimited markers such as //! [snippet-name]. Two
documentation sources in qtdeclarative use non-standard syntax:
qquickanimation.cpp omits the brackets in its snippet markers,
and qquickshortcut.cpp includes them in the \include argument
instead.
Both deviations happened to work because QDoc's snippet matching
was based on substring search, which tolerated these variations.
An upcoming fix to QDoc corrects the matching to use exact
comparison against the bracket-delimited name, exposing these
non-standard usages as warnings.
This aligns both files with the documented \include syntax.
Pick-to: 6.8 6.5
Task-number: QTBUG-144451
Change-Id: I364992016dc16a342e8efb27951e0bc7ec36dc2c
Reviewed-by: Topi Reinio <topi.reinio@qt.io>
Reviewed-by: David Boddie <david.boddie@qt.io>
(cherry picked from commit a78837b1364983c088c885546c71078f40ae06e9)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
(cherry picked from commit 8914e007fc16ab528fdb0cdd998afc0c2db24fd3)
| -rw-r--r-- | src/quick/util/qquickanimation.cpp | 4 | ||||
| -rw-r--r-- | src/quick/util/qquickshortcut.cpp | 4 |
2 files changed, 4 insertions, 4 deletions
diff --git a/src/quick/util/qquickanimation.cpp b/src/quick/util/qquickanimation.cpp index 4126339d0c..f46881c473 100644 --- a/src/quick/util/qquickanimation.cpp +++ b/src/quick/util/qquickanimation.cpp @@ -2275,7 +2275,7 @@ void QQuickPropertyAnimation::setTo(const QVariant &t) \qmlproperty real QtQuick::PropertyAnimation::easing.period \qmlproperty list<real> QtQuick::PropertyAnimation::easing.bezierCurve -//! propertyanimation.easing +//! [propertyanimation.easing] \brief Specifies the easing curve used for the animation To specify an easing curve you need to specify at least the type. For some curves you can also specify @@ -2479,7 +2479,7 @@ void QQuickPropertyAnimation::setTo(const QVariant &t) end point: [cx1, cy1, cx2, cy2, endx, endy, ...]. The last point must be 1,1. See the \l {Qt Quick Examples - Animation#Easing Curves}{Easing Curves} for a demonstration of the different easing settings. -//! propertyanimation.easing +//! [propertyanimation.easing] */ QEasingCurve QQuickPropertyAnimation::easing() const { diff --git a/src/quick/util/qquickshortcut.cpp b/src/quick/util/qquickshortcut.cpp index 7549057b32..57954f2766 100644 --- a/src/quick/util/qquickshortcut.cpp +++ b/src/quick/util/qquickshortcut.cpp @@ -263,7 +263,7 @@ void QQuickShortcut::setSequences(const QVariantList &values) resemble a key sequence from the menu bar. It is best to display this text to the user (for example, on a tooltip). - \include qquickshortcut.qdocinc [multishortcut] + \include qquickshortcut.qdocinc multishortcut \sa sequence, portableText */ @@ -282,7 +282,7 @@ QString QQuickShortcut::nativeText() const "portable" format, suitable for reading and writing to a file. In many cases, it will look similar to the native text on Windows and X11. - \include qquickshortcut.qdocinc [multishortcut] + \include qquickshortcut.qdocinc multishortcut \sa sequence, nativeText */ |