Doc: several minor link issues in QtWayland

Change-Id: I9e656b02e1b820e2257d95948650c541656192b4
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>

6 files changed, 12 insertions, 15 deletions

diff --git a/src/compositor/compositor_api/qwaylandclient.cpp b/src/compositor/compositor_api/qwaylandclient.cpp
index d2da470a4..a3cc7cad6 100644
--- a/src/compositor/compositor_api/qwaylandclient.cpp
+++ b/src/compositor/compositor_api/qwaylandclient.cpp
@@ -134,8 +134,8 @@ QWaylandClient::~QWaylandClient()
 }
 
 /*!
- * Returns the QWaylandClient corresponding to the Wayland client \a wl_client and \a compositor.
- * If a QWaylandClient has not already been created for \a client, it is
+ * Returns the QWaylandClient corresponding to the Wayland client \a wlClient and \a compositor.
+ * If a QWaylandClient has not already been created for a client, it is
  * created and returned.
  */
 QWaylandClient *QWaylandClient::fromWlClient(QWaylandCompositor *compositor, wl_client *wlClient)
diff --git a/src/compositor/compositor_api/qwaylandcompositor.cpp b/src/compositor/compositor_api/qwaylandcompositor.cpp
index 6e463e384..2fd5ca43c 100644
--- a/src/compositor/compositor_api/qwaylandcompositor.cpp
+++ b/src/compositor/compositor_api/qwaylandcompositor.cpp
@@ -836,7 +836,7 @@ void QWaylandCompositor::setUseHardwareIntegrationExtension(bool use)
  * to implement custom logic.
  * The default implementation only grabs SHM and OpenGL buffers, reimplement this in your
  * compositor subclass to handle more buffer types.
- * You should not call this manually, but rather use \a QWaylandSurfaceGrabber.
+ * You should not call this manually, but rather use QWaylandSurfaceGrabber (\a grabber).
  */
 void QWaylandCompositor::grabSurface(QWaylandSurfaceGrabber *grabber, const QWaylandBufferRef &buffer)
 {
diff --git a/src/compositor/compositor_api/qwaylandinput.cpp b/src/compositor/compositor_api/qwaylandinput.cpp
index 09c02bc48..4c2a0b439 100644
--- a/src/compositor/compositor_api/qwaylandinput.cpp
+++ b/src/compositor/compositor_api/qwaylandinput.cpp
@@ -467,7 +467,7 @@ QWaylandInputDevice *QWaylandInputDevice::fromSeatResource(struct ::wl_resource
 }
 
 /*!
- * \fn void mouseFocusChanged(QWaylandView *newFocus, QWaylandView *oldFocus)
+ * \fn void QWaylandInputDevice::mouseFocusChanged(QWaylandView *newFocus, QWaylandView *oldFocus)
  *
  * This signal is emitted when the mouse focus has changed from \a oldFocus to \a newFocus.
  */
diff --git a/src/compositor/compositor_api/qwaylandsurfacegrabber.cpp b/src/compositor/compositor_api/qwaylandsurfacegrabber.cpp
index 0eb85b0c6..d415642c4 100644
--- a/src/compositor/compositor_api/qwaylandsurfacegrabber.cpp
+++ b/src/compositor/compositor_api/qwaylandsurfacegrabber.cpp
@@ -93,7 +93,7 @@ QWaylandSurface *QWaylandSurfaceGrabber::surface() const
 
 /*!
  * Grab the content of the surface set on this object.
- * It may not be possible to do that immediately so the \a success and \a failed signals
+ * It may not be possible to do that immediately so the success and failed signals
  * should be used to be notified of when the grab is completed.
  */
 void QWaylandSurfaceGrabber::grab()
diff --git a/src/compositor/extensions/qwaylandwlshell.cpp b/src/compositor/extensions/qwaylandwlshell.cpp
index e3ab2eecb..93bad2938 100644
--- a/src/compositor/extensions/qwaylandwlshell.cpp
+++ b/src/compositor/extensions/qwaylandwlshell.cpp
@@ -326,12 +326,9 @@ const struct wl_interface *QWaylandWlShell::interface()
  */
 
 /*!
- * \fn void QWaylandWlShell::createShellSurface(QWaylandSurface *surface, QWaylandClient *client, uint id)
+ * \fn void QWaylandWlShell::createShellSurface(QWaylandSurface *surface, const QWaylandResource &resource)
  *
- * This signal is emitted when the \a client has requested a shell surface to be associated
- * with \a surface and be assigned the given \a id. The handler for this signal is
- * expected to create the shell surface and initialize it within the scope of the
- * signal emission.
+ * Constructs a QWaylandSurface, assigns it to \a surface and initializes it with the given \a resource.
  */
 
 /*!
@@ -377,7 +374,7 @@ QWaylandWlShellSurface::QWaylandWlShellSurface()
 }
 
 /*!
- * Constructs a QWaylandWlShellSurface for \a surface and initializes it with the given \a shell and \a resource.
+ * Constructs a QWaylandWlShellSurface for \a surface and initializes it with the given \a shell and resource \a res.
  */
 QWaylandWlShellSurface::QWaylandWlShellSurface(QWaylandWlShell *shell, QWaylandSurface *surface, const QWaylandResource &res)
     : QWaylandShellSurfaceTemplate<QWaylandWlShellSurface>(*new QWaylandWlShellSurfacePrivate)
@@ -586,12 +583,12 @@ QWaylandSurfaceRole *QWaylandWlShellSurface::role()
 /*!
  * \qmlmethod void QtWaylandCompositor::WlShellSurface::ping()
  *
- * Sends a ping event to the client. If the client replies to the event the \a pong
+ * Sends a ping event to the 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
+ * Sends a ping event to the client. If the client replies to the event the pong
  * signal will be emitted.
  */
 void QWaylandWlShellSurface::ping()
diff --git a/src/compositor/extensions/qwaylandxdgshell.cpp b/src/compositor/extensions/qwaylandxdgshell.cpp
index dfc68e254..4618891dc 100644
--- a/src/compositor/extensions/qwaylandxdgshell.cpp
+++ b/src/compositor/extensions/qwaylandxdgshell.cpp
@@ -599,7 +599,7 @@ QWaylandXdgSurface::QWaylandXdgSurface()
 
 /*!
  * Constructs a QWaylandXdgSurface for \a surface and initializes it with the
- * given \a xdgShell, \a surface and \a resource.
+ * given \a xdgShell, \a surface, and resource \a res.
  */
 QWaylandXdgSurface::QWaylandXdgSurface(QWaylandXdgShell *xdgShell, QWaylandSurface *surface, const QWaylandResource &res)
     : QWaylandShellSurfaceTemplate<QWaylandXdgSurface>(*new QWaylandXdgSurfacePrivate)
@@ -684,7 +684,7 @@ QWaylandSurface *QWaylandXdgSurface::surface() const
  */
 
 /*!
- * \property QWaylandXdgSurface::surface
+ * \property QWaylandXdgSurface::parentSurface
  *
  * This property holds the XdgSurface parent of this XdgSurface.
  */