diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-11-11 22:45:22 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-14 12:14:57 +0100 |
| commit | 5d76ced033cf1b2a1466a1b1b2a3a4f1102fab3f (patch) | |
| tree | be508feadc8113d9aa1024764aa91587068a8df0 /src/controls/Styles/Base/MenuStyle.qml | |
| parent | 724c8d81b0ce39ffc32dfdcf1b134ac4befb0127 (diff) | |
Doc: Fix documentation warnings
All warnings in qtquickcontrols were related to \qmlmethod or \qmlsignal
parameters, except for the missing dependency to qtcore in Qt Quick
Extras.
There's some inconsistencies with how QDoc parses QML method parameters,
especially for qml signals - in some cases the \a command is replaced
with \e to clear the warning, even though the parameter name referenced
with \a does exist.
This commit brings the current warning count to zero.
Fixes: QTBUG-79828
Change-Id: I3d3d02583498c5a579f6476273e10e75680d940c
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/controls/Styles/Base/MenuStyle.qml')
| -rw-r--r-- | src/controls/Styles/Base/MenuStyle.qml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/controls/Styles/Base/MenuStyle.qml b/src/controls/Styles/Base/MenuStyle.qml index 13a889c41..f40e0af7c 100644 --- a/src/controls/Styles/Base/MenuStyle.qml +++ b/src/controls/Styles/Base/MenuStyle.qml @@ -98,13 +98,13 @@ Style { /*! \qmlmethod string MenuStyle::formatMnemonic(string text, bool underline = false) - Returns a rich-text string to render mnemonics for a given menu item. + Returns a rich-text string to render mnemonics for a given menu item \a text. The mnemonic character is prefixed by an ampersand in the original string. - Passing \c true for \c underline will underline the mnemonic character (e.g., + Passing \c true for \a underline will underline the mnemonic character (e.g., \c formatMnemonic("&Open...", true) will return \c "<u>O</u>pen..."). Passing \c false - for \c underline will return the plain text form (e.g., \c formatMnemonic("&Open...", false) + for \a underline will return the plain text form (e.g., \c formatMnemonic("&Open...", false) will return \c "Open..."). \sa Label |