diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-05-16 11:47:35 +0000 |
|---|---|---|
| committer | Shawn Rutledge <shawn.rutledge@qt.io> | 2023-05-16 14:08:11 +0000 |
| commit | f9e2614a35707c95b1ebd34dbb595263efc4a128 (patch) | |
| tree | f9b85fb16a9792384b77d23ec0c56f49a64d95f0 | |
| parent | 4416a6bd4fb1cd1cb9d9225f3183431b37d6c948 (diff) | |
| download | qtdeclarative-f9e2614a35707c95b1ebd34dbb595263efc4a128.tar.gz | |
Doc: Fix linking and read-only status for Window.visibility properties
QDoc has problems linking to a topic that has identical name to the
topic the link appears in, as is the case when linking from 'visibility'
property to 'visibility' attached property.
Add a unique \keyword for the former and use it for linking.
Explicitly set the attached property as \readonly.
Pick-to: 6.5 6.2
Task-number: QTBUG-113015
Change-Id: Ia0eb99fd2436565c697ca23629134b691acecc1b
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
| -rw-r--r-- | src/quick/items/qquickwindow.cpp | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp index 2e0274528d..54e73abc91 100644 --- a/src/quick/items/qquickwindow.cpp +++ b/src/quick/items/qquickwindow.cpp @@ -3373,6 +3373,7 @@ void QQuickWindow::endExternalCommands() */ /*! + \keyword qml-window-visibility-prop \qmlproperty QWindow::Visibility Window::visibility The screen-occupation state of the window. @@ -3395,6 +3396,7 @@ void QQuickWindow::endExternalCommands() /*! \qmlattachedproperty QWindow::Visibility Window::visibility + \readonly \since 5.4 This attached property holds whether the window is currently shown @@ -3402,7 +3404,7 @@ void QQuickWindow::endExternalCommands() hidden. The \c Window attached property can be attached to any Item. If the item is not shown in any window, the value will be \l {QWindow::}{Hidden}. - \sa visible, visibility + \sa visible, {qml-window-visibility-prop}{visibility} */ /*! |