aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2021-08-25 14:36:08 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-08-31 09:26:17 +0000
commit314b7a9c4178cef90f4c3e0486260ef0ee6253e1 (patch)
tree4153207f0f1dce30b764fdd92127b484e2e01baa
parent0eef1d662f24dacca4ca563a3ad47aee0bc83858 (diff)
Doc: Fix remaining documentation warnings
* Refer to correct types in Window QML type docs. * Fix link target for 'Required properties'. * Fix other minor issues. Task-number: QTBUG-95860 Change-Id: Icc2819a18ad8cfc44d39f13b22c595ed7b2f0806 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> (cherry picked from commit 13c5c8e09e2a91f3675ef2da93d25912e1f01b13) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/labs/platform/qquickplatformmenu.cpp2
-rw-r--r--src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc2
-rw-r--r--src/quick/items/qquickwindow.cpp4
-rw-r--r--src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf2
-rw-r--r--src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp4
5 files changed, 8 insertions, 6 deletions
diff --git a/src/labs/platform/qquickplatformmenu.cpp b/src/labs/platform/qquickplatformmenu.cpp
index 16dffd5ea8..e7418df7aa 100644
--- a/src/labs/platform/qquickplatformmenu.cpp
+++ b/src/labs/platform/qquickplatformmenu.cpp
@@ -545,7 +545,7 @@ void QQuickPlatformMenu::setTitle(const QString &title)
This property holds the menu's font.
- \sa text
+ \sa title
*/
QFont QQuickPlatformMenu::font() const
{
diff --git a/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc b/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc
index b45bf6b386..e52b09aa97 100644
--- a/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc
+++ b/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc
@@ -195,7 +195,7 @@ maintenance pain-free, we should strive to keep C++ types unaware of QML as
much as possible. This can be achieved by "pushing" references to C++ types
into QML.
-This can be done by using \l {Required Property}{required properties} and
+This can be done by using \l {Required properties}{required properties} and
setting them via \l QQmlApplicationEngine::setInitialProperties. It is also
possible to create one or multiple \l {QML_SINGLETON}{singletons} which will
return all the data the C++ side wants to provide to QML.
diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp
index 760b3378e6..5f8ccfbd27 100644
--- a/src/quick/items/qquickwindow.cpp
+++ b/src/quick/items/qquickwindow.cpp
@@ -4082,7 +4082,7 @@ void QQuickWindow::setTextRenderType(QQuickWindow::TextRenderType renderType)
/*!
\since 6.0
- \qmlproperty QQuickPalette Window::palette
+ \qmlproperty Palette Window::palette
This property holds the palette currently set for the window.
@@ -4094,7 +4094,7 @@ void QQuickWindow::setTextRenderType(QQuickWindow::TextRenderType renderType)
property on the window's palette, that property propagates to all child controls in the window,
overriding any system defaults for that property.
- \sa Item::palette, Popup::palette, QQuickColorGroup
+ \sa Item::palette, Popup::palette, ColorGroup
//! internal \sa QQuickAbstractPaletteProvider, QQuickPalette
*/
diff --git a/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf b/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf
index e53a5c22a8..b41c30ca1d 100644
--- a/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf
+++ b/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf
@@ -23,7 +23,7 @@ qhp.QtQuickDialogs.subprojects.qmltypes.indexTitle = Qt Quick Dialogs QML Types
qhp.QtQuickDialogs.subprojects.qmltypes.selectors = qmlclass
qhp.QtQuickDialogs.subprojects.qmltypes.sortPages = true
-depends = qtcore qtgui qtdoc qtqml qtquick qtquickcontrols
+depends = qtcore qtgui qtdoc qtqml qtquick qtquickcontrols qtlabsplatform
# This module has no documented C++ types, clear the module header
moduleheader =
diff --git a/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp b/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp
index f63cbbf006..90be981fc9 100644
--- a/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp
+++ b/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp
@@ -96,7 +96,7 @@ Q_LOGGING_CATEGORY(lcFileDialog, "qt.quick.dialogs.filedialog")
\include includes/fallback.qdocinc
- \sa FolderDialog, StandardPaths
+ //! \sa FolderDialog, StandardPaths
*/
Q_DECLARE_LOGGING_CATEGORY(lcDialogs)
@@ -259,9 +259,11 @@ void QQuickFileDialog::setCurrentFiles(const QList<QUrl> &currentFiles)
This property holds the folder where files are selected. It can be set to
control the initial directory that is shown when the dialog is opened.
+\omit
For selecting a folder, use FolderDialog instead.
\sa FolderDialog
+\endomit
*/
QUrl QQuickFileDialog::currentFolder() const
{