Doc: Language edits

Task-number: QTBUG-53147
Change-Id: I353cf18b9661b5eb2371072f8091dc890fc7fcf0
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>

3 files changed, 22 insertions, 20 deletions

diff --git a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
index 5fe43e547..9cb65fbef 100644
--- a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
+++ b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
@@ -46,19 +46,21 @@ QT_BEGIN_NAMESPACE
  * \qmltype ShellSurfaceItem
  * \inqmlmodule QtWayland.Compositor
  * \preliminary
- * \brief An item representing a WlShellSurface.
+ * \brief A Qt Quick item type representing a WlShellSurface.
  *
- * This type is used to render wl_shell or xdg_shell surfaces as part of a Qt Quick
+ * This type is used to render \c wl_shell or \c xdg_shell surfaces as part of a Qt Quick
  * scene. It handles moving and resizing triggered by clicking on the window decorations.
+ *
+ * \sa WaylandQuickItem
  */
 
 /*!
  * \class QWaylandQuickShellSurfaceItem
  * \inmodule QtWaylandCompositor
  * \preliminary
- * \brief A Qt Quick item for QWaylandShellSurface.
+ * \brief The QWaylandQuickShellSurfaceItem class provides a Qt Quick item that represents a QWaylandShellSurface.
  *
- * This class is used to render wl_shell or xdg_shell surfaces as part of a Qt Quick
+ * This class is used to render \c wl_shell or \c xdg_shell surfaces as part of a Qt Quick
  * scene. It handles moving and resizing triggered by clicking on the window decorations.
  *
  * \sa QWaylandQuickItem
diff --git a/src/compositor/extensions/qwaylandwlshell.cpp b/src/compositor/extensions/qwaylandwlshell.cpp
index a4d982079..c79ddac7c 100644
--- a/src/compositor/extensions/qwaylandwlshell.cpp
+++ b/src/compositor/extensions/qwaylandwlshell.cpp
@@ -243,13 +243,13 @@ void QWaylandWlShellSurfacePrivate::shell_surface_set_class(Resource *resource,
  * \qmltype WlShell
  * \inqmlmodule QtWayland.Compositor
  * \preliminary
- * \brief Extension for desktop-style user interfaces.
+ * \brief Provides an extension for desktop-style user interfaces.
  *
  * The WlShell extension provides a way to assiociate a ShellSurface
  * with a regular Wayland surface. Using the shell surface interface, the client
  * can request that the surface is resized, moved, and so on.
  *
- * WlShell corresponds to the Wayland interface wl_shell.
+ * WlShell corresponds to the Wayland interface \c wl_shell.
  *
  * To provide the functionality of the shell extension in a compositor, create
  * an instance of the WlShell component and add it to the list of extensions
@@ -269,13 +269,13 @@ void QWaylandWlShellSurfacePrivate::shell_surface_set_class(Resource *resource,
  * \class QWaylandWlShell
  * \inmodule QtWaylandCompositor
  * \preliminary
- * \brief Extension for desktop-style user interfaces.
+ * \brief The QWaylandWlShell class is an extension for desktop-style user interfaces.
  *
  * The QWaylandWlShell extension provides a way to assiociate a QWaylandWlShellSurface with
  * a regular Wayland surface. Using the shell surface interface, the client
  * can request that the surface is resized, moved, and so on.
  *
- * WlShell corresponds to the Wayland interface wl_shell.
+ * WlShell corresponds to the Wayland interface \c wl_shell.
  */
 
 /*!
@@ -319,8 +319,8 @@ const struct wl_interface *QWaylandWlShell::interface()
 /*!
  * \qmlsignal void QtWaylandCompositor::WlShell::createShellSurface(object surface, object client, int id)
  *
- * This signal is emitted when the \a client has requested a wl_shell_surface to be associated
- * with \a surface and be assigned the given \a id. The handler for this signal is
+ * This signal is emitted when the \a client has requested a \c wl_shell_surface to be associated
+ * with \a surface, which is identified by \a id. The handler for this signal is
  * expected to create the shell surface and initialize it within the scope of the
  * signal emission.
  */
@@ -343,26 +343,26 @@ QByteArray QWaylandWlShell::interfaceName()
  * \qmltype WlShellSurface
  * \inqmlmodule QtWayland.Compositor
  * \preliminary
- * \brief A wl_shell_surface providing desktop-style compositor-specific features to a surface.
+ * \brief Provides a \c wl_shell_surface that offers desktop-style compositor-specific features to a surface.
  *
  * This type is part of the \l{WlShell} extension and provides a way to extend
  * the functionality of an existing WaylandSurface with features specific to desktop-style
  * compositors, such as resizing and moving the surface.
  *
- * It corresponds to the Wayland interface wl_shell_surface.
+ * It corresponds to the Wayland interface \c wl_shell_surface.
  */
 
 /*!
  * \class QWaylandWlShellSurface
  * \inmodule QtWaylandCompositor
  * \preliminary
- * \brief A shell surface providing desktop-style compositor-specific features to a surface.
+ * \brief The QWaylandWlShellSurface class provides desktop-style compositor-specific features to a surface.
  *
  * This class is part of the QWaylandWlShell extension and provides a way to extend
  * the functionality of an existing QWaylandSurface with features specific to desktop-style
  * compositors, such as resizing and moving the surface.
  *
- * It corresponds to the Wayland interface wl_shell_surface.
+ * It corresponds to the Wayland interface \c wl_shell_surface.
  */
 
 /*!
@@ -385,11 +385,11 @@ QWaylandWlShellSurface::QWaylandWlShellSurface(QWaylandWlShell *shell, QWaylandS
 /*!
  * \qmlmethod void QtWaylandCompositor::WlShellSurface::initialize(object shell, object surface, object client, int id)
  *
- * Initializes the WlShellSurface, associating it with the given \a shell, \a surface, \a client, and \a id.
+ * Initializes the WlShellSurface with \a id and associates it with the given \a shell, \a surface, and \a client.
  */
 
 /*!
- * Initializes the QWaylandWlShellSurface, associating it with the given \a shell, \a surface and \a resource.
+ * Initializes the QWaylandWlShellSurface and associates it with the given \a shell, \a surface, and \a resource.
  */
 void QWaylandWlShellSurface::initialize(QWaylandWlShell *shell, QWaylandSurface *surface, const QWaylandResource &resource)
 {
@@ -443,7 +443,7 @@ QSize QWaylandWlShellSurface::sizeForResize(const QSizeF &size, const QPointF &d
 /*!
  * \enum QWaylandWlShellSurface::ResizeEdge
  *
- * This enum type provides a way to specify a specific edge or corner of
+ * This enum type provides a way to specify an edge or corner of
  * the surface.
  *
  * \value NoneEdge No edge.
@@ -501,7 +501,7 @@ QWaylandQuickShellIntegration *QWaylandWlShellSurface::createIntegration(QWaylan
 /*!
  * \qmlproperty object QtWaylandCompositor::WlShellSurface::surface
  *
- * This property holds the wl_surface associated with this WlShellSurface.
+ * This property holds the \c wl_surface associated with this WlShellSurface.
  */
 
 /*!
diff --git a/src/compositor/extensions/qwaylandxdgshell.cpp b/src/compositor/extensions/qwaylandxdgshell.cpp
index 4618891dc..b5346036a 100644
--- a/src/compositor/extensions/qwaylandxdgshell.cpp
+++ b/src/compositor/extensions/qwaylandxdgshell.cpp
@@ -579,7 +579,7 @@ void QWaylandXdgShell::handleFocusChanged(QWaylandSurface *newSurface, QWaylandS
  * \class QWaylandXdgSurface
  * \inmodule QtWaylandCompositor
  * \preliminary
- * \brief An xdg surface providing desktop-style compositor-specific features to a surface.
+ * \brief The QWaylandXdgSurface class provides desktop-style compositor-specific features to an xdg surface.
  *
  * This class is part of the QWaylandXdgShell extension and provides a way to
  * extend the functionality of an existing QWaylandSurface with features
@@ -927,7 +927,7 @@ QWaylandQuickShellIntegration *QWaylandXdgSurface::createIntegration(QWaylandQui
  * \class QWaylandXdgPopup
  * \inmodule QtWaylandCompositor
  * \preliminary
- * \brief An xdg popup providing menus for an xdg surface
+ * \brief The QWaylandXdgPopup class provides menus for an xdg surface
  *
  * This class is part of the QWaylandXdgShell extension and provides a way to
  * extend the functionality of an existing QWaylandSurface with features