From 785f543bed9b0f05c4f6b0de7453faab04c1c8e8 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Tue, 4 Oct 2016 14:30:21 +0200 Subject: Doc: Added missing documentation for certain parameters Change-Id: I6f30d9032a9f5f432aacee1b05439445933fb9d0 Reviewed-by: Johan Helsing Reviewed-by: Venugopal Shivashankar Reviewed-by: Martin Smith --- src/compositor/compositor_api/qwaylandtouch.cpp | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'src/compositor/compositor_api/qwaylandtouch.cpp') 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() */ -- cgit v1.2.3