summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2017-04-24 16:02:54 +0200
committerNico Vertriest <nico.vertriest@qt.io>2017-04-26 08:15:23 +0000
commit1da2871ad105ca8daf1cc3c055703f14d343209f (patch)
treeaf0f60a60e71f6fb116c4acf08607006753032f7
parent014dd47b284325c32e8b404cf59852b810cc51ad (diff)
Doc: add info about parameters
qwaylandquickitem.cpp:1076: warning: Undocumented return value qwaylandxdgshellv5.cpp:614: warning: Undocumented parameter 'client' in QWaylandXdgShellV5::ping() qwaylandxdgshellv5.cpp:614: warning: No such parameter 'pong' in QWaylandXdgShellV5::ping() Change-Id: I9d058ba64f75285d1dd0591c2cc21987cabfe4bb Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Jan Arne Petersen <jan.petersen@kdab.com>
-rw-r--r--src/compositor/compositor_api/qwaylandquickitem.cpp4
-rw-r--r--src/compositor/extensions/qwaylandxdgshellv5.cpp8
2 files changed, 6 insertions, 6 deletions
diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp
index d3c096a85..ea32212d3 100644
--- a/src/compositor/compositor_api/qwaylandquickitem.cpp
+++ b/src/compositor/compositor_api/qwaylandquickitem.cpp
@@ -1067,14 +1067,14 @@ QVariant QWaylandQuickItem::inputMethodQuery(Qt::InputMethodQuery query, QVarian
/*!
\qmlproperty bool QtWaylandCompositor::WaylandQuickItem::paintEnabled
- If this property is \c true, the item is hidden, though the texture
+ Returns true if the item is hidden, though the texture
is still updated. As opposed to hiding the item by
setting \l{Item::visible}{visible} to \c false, setting this property to \c true
will not prevent mouse or keyboard input from reaching item.
*/
/*!
- If this property is \c true, the item is hidden, though the texture
+ Returns true if the item is hidden, though the texture
is still updated. As opposed to hiding the item by
setting \l{Item::visible}{visible} to \c false, setting this property to \c true
will not prevent mouse or keyboard input from reaching item.
diff --git a/src/compositor/extensions/qwaylandxdgshellv5.cpp b/src/compositor/extensions/qwaylandxdgshellv5.cpp
index 5d1fb03a5..90e505bdc 100644
--- a/src/compositor/extensions/qwaylandxdgshellv5.cpp
+++ b/src/compositor/extensions/qwaylandxdgshellv5.cpp
@@ -607,13 +607,13 @@ QByteArray QWaylandXdgShellV5::interfaceName()
/*!
* \qmlmethod void QtWaylandCompositor::XdgSurface::ping()
*
- * Sends a ping event to the client. If the client replies to the event the
- * \a pong signal will be emitted.
+ * Sends a ping event to the \a client. If the client replies to the event, the
+ * pong signal will be emitted.
*/
/*!
- * Sends a ping event to the client. If the client replies to the event the
- * \a pong signal will be emitted.
+ * Sends a ping event to the \a client. If the client replies to the event, the
+ * pong signal will be emitted.
*/
uint QWaylandXdgShellV5::ping(QWaylandClient *client)
{