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>

5 files changed, 21 insertions, 19 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)
 {
diff --git a/src/compositor/compositor_api/qwaylandsurface.cpp b/src/compositor/compositor_api/qwaylandsurface.cpp
index 80e8715ea..98db1dbe2 100644
--- a/src/compositor/compositor_api/qwaylandsurface.cpp
+++ b/src/compositor/compositor_api/qwaylandsurface.cpp
@@ -872,13 +872,13 @@ void QWaylandSurfacePrivate::Subsurface::subsurface_set_desync(wl_subsurface::Re
 /*!
  * \qmlsignal void QtWaylandCompositor::WaylandSurface::dragStarted(object drag)
  *
- * This signal is emitted when a drag has started from this surface.
+ * This signal is emitted when a \a drag has started from this surface.
  */
 
 /*!
  * \fn void QWaylandSurface::dragStarted(QWaylandDrag *drag)
  *
- * This signal is emitted when a drag has started from this surface.
+ * This signal is emitted when a \a drag has started from this surface.
  */
 
 QT_END_NAMESPACE
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()
  */
diff --git a/src/compositor/extensions/qwaylandivisurface.cpp b/src/compositor/extensions/qwaylandivisurface.cpp
index fc3102df8..06e12a5ab 100644
--- a/src/compositor/extensions/qwaylandivisurface.cpp
+++ b/src/compositor/extensions/qwaylandivisurface.cpp
@@ -68,7 +68,7 @@ QWaylandIviSurface::QWaylandIviSurface()
 
 /*!
  * Constructs a QWaylandIviSurface for \a surface and initializes it with the
- * given \a application, \a surface, \a iviId, and resource \a res.
+ * given \a application, \a surface, \a iviId, and \a resource.
  */
 QWaylandIviSurface::QWaylandIviSurface(QWaylandIviApplication *application, QWaylandSurface *surface, uint iviId, const QWaylandResource &resource)
     : QWaylandShellSurfaceTemplate<QWaylandIviSurface>(*new QWaylandIviSurfacePrivate())
@@ -129,7 +129,7 @@ QWaylandSurface *QWaylandIviSurface::surface() const
  */
 
 /*!
- * \property QWaylandClient::iviId
+ * \property QWaylandIviSurface::iviId
  *
  * This property holds the ivi id of this QWaylandIviSurface.
  */
diff --git a/src/compositor/extensions/qwaylandxdgshellv5.cpp b/src/compositor/extensions/qwaylandxdgshellv5.cpp
index b73b84d7a..fd23865cf 100644
--- a/src/compositor/extensions/qwaylandxdgshellv5.cpp
+++ b/src/compositor/extensions/qwaylandxdgshellv5.cpp
@@ -912,13 +912,15 @@ QSize QWaylandXdgSurfaceV5::sizeForResize(const QSizeF &size, const QPointF &del
 }
 
 /*!
- * \qmlmethod int QtWaylandCompositor::XdgSurface::sendConfigure(size size, List<uint>)
+ * \qmlmethod int QtWaylandCompositor::XdgSurface::sendConfigure(size size, list<uint> states)
  *
- * Sends a configure event to the client. Known states are enumerated in XdgSurface::State
+ * Sends a configure event to the client. \a size contains the pixel size of the surface.
+ * Known \a states are enumerated in XdgSurface::State.
  */
 
 /*!
- * Sends a configure event to the client. Known states are enumerated in QWaylandXdgSurfaceV5::State
+ * Sends a configure event to the client. Parameter \a size contains the pixel size
+ * of the surface. Known \a states are enumerated in QWaylandXdgSurfaceV5::State.
  */
 uint QWaylandXdgSurfaceV5::sendConfigure(const QSize &size, const QVector<uint> &states)
 {
@@ -1038,8 +1040,8 @@ QWaylandXdgPopupV5::QWaylandXdgPopupV5()
 }
 
 /*!
- * Constructs a QWaylandXdgPopupV5 for \a surface and initializes it with the
- * given \a parentSurface and \a resource.
+ * Constructs a QWaylandXdgPopupV5, associating it with \a xdgShell at the specified \a position
+ * for \a surface and initializes it with the given \a parentSurface and \a resource.
  */
 QWaylandXdgPopupV5::QWaylandXdgPopupV5(QWaylandXdgShellV5 *xdgShell, QWaylandSurface *surface,
                                    QWaylandSurface *parentSurface, const QPoint &position, const QWaylandResource &resource)