diff options
| author | Nico Vertriest <nico.vertriest@qt.io> | 2016-10-04 14:30:21 +0200 |
|---|---|---|
| committer | Nico Vertriest <nico.vertriest@theqtcompany.com> | 2016-11-03 09:59:52 +0000 |
| commit | 785f543bed9b0f05c4f6b0de7453faab04c1c8e8 (patch) | |
| tree | b97809549c27f4f690eb3a02ae3b25ab3507e772 /src/compositor/compositor_api/qwaylandtouch.cpp | |
| parent | e05f6c01d2ac4b807c07a682927f75d70292595b (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/qwaylandtouch.cpp')
| -rw-r--r-- | src/compositor/compositor_api/qwaylandtouch.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/compositor/compositor_api/qwaylandtouch.cpp b/src/compositor/compositor_api/qwaylandtouch.cpp index 168edc496..92a8f5cf3 100644 --- a/src/compositor/compositor_api/qwaylandtouch.cpp +++ b/src/compositor/compositor_api/qwaylandtouch.cpp @@ -133,7 +133,7 @@ QWaylandCompositor *QWaylandTouch::compositor() const } /*! - * Sends a touch point event for the touch device with the given \a id, + * Sends a touch point event to the touch device of \a surface with the given \a id, * \a position, and \a state. * * Returns the serial of the down or up event if sent, otherwise 0. @@ -162,7 +162,7 @@ uint QWaylandTouch::sendTouchPointEvent(QWaylandSurface *surface, int id, const } /*! - * Sends a touch frame event for the touch device. This indicates the end of a + * Sends a touch frame event to the touch device of a \a client. This indicates the end of a * contact point list. */ void QWaylandTouch::sendFrameEvent(QWaylandClient *client) @@ -174,7 +174,7 @@ void QWaylandTouch::sendFrameEvent(QWaylandClient *client) } /*! - * Sends a touch cancel event for the touch device. + * Sends a touch cancel event to the touch device of a \a client. */ void QWaylandTouch::sendCancelEvent(QWaylandClient *client) { @@ -185,8 +185,8 @@ void QWaylandTouch::sendCancelEvent(QWaylandClient *client) } /*! - * Sends all the touch points in \a event for this touch device, followed - * by a touch frame event. + * Sends all touch points in \a event to the specified \a surface, + * followed by a touch frame event. * * \sa sendTouchPointEvent(), sendFrameEvent() */ |