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/qquickmenu.cpp | |
| parent | 724c8d81b0ce39ffc32dfdcf1b134ac4befb0127 (diff) | |
| download | qtquickcontrols-5d76ced033cf1b2a1466a1b1b2a3a4f1102fab3f.tar.gz | |
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/qquickmenu.cpp')
| -rw-r--r-- | src/controls/qquickmenu.cpp | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/controls/qquickmenu.cpp b/src/controls/qquickmenu.cpp index bfa0f673..bbbbe97c 100644 --- a/src/controls/qquickmenu.cpp +++ b/src/controls/qquickmenu.cpp @@ -174,7 +174,7 @@ QT_BEGIN_NAMESPACE /*! \qmlmethod MenuItem Menu::addItem(string text) - Adds an item to the menu. Returns the newly created \l MenuItem. + Adds a \a text item to the menu. Returns the newly created \l MenuItem. \sa insertItem() */ @@ -182,7 +182,7 @@ QT_BEGIN_NAMESPACE /*! \qmlmethod MenuItem Menu::insertItem(int before, string title) - Creates and inserts an item with title \c title at the index \c before in the current menu. + Creates and inserts an item with title \a title at the index \a before in the current menu. Returns the newly created \l MenuItem. \sa addItem() @@ -199,14 +199,14 @@ QT_BEGIN_NAMESPACE /*! \qmlmethod void Menu::insertSeparator(int before) - Creates and inserts a separator at the index \c before in the current menu. + Creates and inserts a separator at the index \a before in the current menu. \sa addSeparator() */ /*! \qmlmethod Menu Menu::addMenu(string title) - Adds a submenu to the menu. Returns the newly created \l Menu. + Adds a submenu with a title \a title to the menu. Returns the newly created \l Menu. \sa insertMenu() */ @@ -214,7 +214,7 @@ QT_BEGIN_NAMESPACE /*! \qmlmethod MenuItem Menu::insertMenu(int before, string title) - Creates and inserts a submenu with title \c title at the index \c before in the current menu. + Creates and inserts a submenu with a title \a title at the index \a before in the current menu. Returns the newly created \l Menu. \sa addMenu() @@ -223,7 +223,7 @@ QT_BEGIN_NAMESPACE /*! \qmlmethod void Menu::insertItem(int before, object item) - Inserts the \c item at the index \c before in the current menu. + Inserts the \a item at the index \a before in the current menu. In this case, \c item can be either a \l MenuItem, a \l MenuSeparator, or a \l Menu. @@ -233,8 +233,8 @@ QT_BEGIN_NAMESPACE /*! \qmlmethod void Menu::removeItem(item) - Removes the \c item from the menu. - In this case, \c item can be either a \l MenuItem, a \l MenuSeparator, + Removes the \a item from the menu. + In this case, \a item can be either a \l MenuItem, a \l MenuSeparator, or a \l Menu. \sa insertItem() |