summaryrefslogtreecommitdiffstats
path: root/src/compositor/compositor_api/qwaylandseat.cpp
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2016-10-04 14:30:21 +0200
committerNico Vertriest <nico.vertriest@theqtcompany.com>2016-11-03 09:59:52 +0000
commit785f543bed9b0f05c4f6b0de7453faab04c1c8e8 (patch)
treeb97809549c27f4f690eb3a02ae3b25ab3507e772 /src/compositor/compositor_api/qwaylandseat.cpp
parente05f6c01d2ac4b807c07a682927f75d70292595b (diff)
Doc: Added missing documentation for certain parameters
Change-Id: I6f30d9032a9f5f432aacee1b05439445933fb9d0 Reviewed-by: Johan Helsing <johan.helsing@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
Diffstat (limited to 'src/compositor/compositor_api/qwaylandseat.cpp')
-rw-r--r--src/compositor/compositor_api/qwaylandseat.cpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/compositor/compositor_api/qwaylandseat.cpp b/src/compositor/compositor_api/qwaylandseat.cpp
index 169d5de62..f6a5276d4 100644
--- a/src/compositor/compositor_api/qwaylandseat.cpp
+++ b/src/compositor/compositor_api/qwaylandseat.cpp
@@ -257,8 +257,8 @@ void QWaylandSeat::sendKeyReleaseEvent(uint code)
}
/*!
- * Sends a touch point event with the given \a id and \a state to the touch device. The position
- * of the touch point is given by \a point.
+ * Sends a touch point event to the \a surface on a touch device with the given
+ * \a id, \a point and \a state.
*
* Returns the serial for the touch up or touch down event.
*/
@@ -273,7 +273,7 @@ uint QWaylandSeat::sendTouchPointEvent(QWaylandSurface *surface, int id, const Q
}
/*!
- * Sends a frame event to the touch device.
+ * Sends a frame event to the touch device of a \a client.
*/
void QWaylandSeat::sendTouchFrameEvent(QWaylandClient *client)
{
@@ -283,7 +283,7 @@ void QWaylandSeat::sendTouchFrameEvent(QWaylandClient *client)
}
/*!
- * Sends a cancel event to the touch device.
+ * Sends a cancel event to the touch device of a \a client.
*/
void QWaylandSeat::sendTouchCancelEvent(QWaylandClient *client)
{
@@ -293,7 +293,7 @@ void QWaylandSeat::sendTouchCancelEvent(QWaylandClient *client)
}
/*!
- * Sends the \a event to the touch device.
+ * Sends the \a event to the specified \a surface on the touch device.
*/
void QWaylandSeat::sendFullTouchEvent(QWaylandSurface *surface, QTouchEvent *event)
{