diff options
| author | Simon Hausmann <simon.hausmann@qt.io> | 2019-03-19 12:35:17 +0100 |
|---|---|---|
| committer | Simon Hausmann <simon.hausmann@qt.io> | 2019-03-19 12:39:44 +0000 |
| commit | c0905957be0d7db90c9d9f05069a259575753dfe (patch) | |
| tree | 30d38b256c0963c7d9d5f966d0019da1b8303a22 | |
| parent | 548cdde11d6148420dfb8f15d12788dba5e3260a (diff) | |
Fix documentation for bufferLocked property
Commit 2824a71e5c28ec1843edc056f2c17c6274378f1d silenced the qdoc
warning about the bufferLocked property, but it did not fix the
underlying problem that the existing documentation would be shown.
This patch reverts the change and fixes it by making the \property
command match the name of the property, not the getter. Similarly, the
\qmlproperty annotation was missing entirely.
Change-Id: I66281ea4df0162b14ebfab15f1cc18162ea0e8ef
Reviewed-by: Johan Helsing <johan.helsing@qt.io>
| -rw-r--r-- | src/compositor/compositor_api/qwaylandquickitem.cpp | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp index ffd291974..fb73760b4 100644 --- a/src/compositor/compositor_api/qwaylandquickitem.cpp +++ b/src/compositor/compositor_api/qwaylandquickitem.cpp @@ -826,7 +826,16 @@ void QWaylandQuickItem::setOutput(QWaylandOutput *output) } /*! - * \property QWaylandQuickItem::isBufferLocked + * \qmlproperty bool QtWaylandCompositor::WaylandQuickItem::bufferLocked + * + * This property holds whether the item's buffer is currently locked. As long as + * the buffer is locked, it will not be released and returned to the client. + * + * The default is false. + */ + +/*! + * \property QWaylandQuickItem::bufferLocked * * This property holds whether the item's buffer is currently locked. As long as * the buffer is locked, it will not be released and returned to the client. @@ -1284,7 +1293,7 @@ void QWaylandQuickItem::updateInputMethod(Qt::InputMethodQueries queries) * If an animation is started, bufferLocked should be set to ensure the item keeps its content * until the animation finishes * - * \sa isBufferLocked + * \sa bufferLocked */ /*! |