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>

1 files changed, 25 insertions, 24 deletions

diff --git a/src/compositor/compositor_api/qwaylandview.cpp b/src/compositor/compositor_api/qwaylandview.cpp
index 6c1ce248f..12b67bf5d 100644
--- a/src/compositor/compositor_api/qwaylandview.cpp
+++ b/src/compositor/compositor_api/qwaylandview.cpp
@@ -62,18 +62,20 @@ void QWaylandViewPrivate::markSurfaceAsDestroyed(QWaylandSurface *surface)
  * \preliminary
  * \brief Represents a view of a surface on an output.
  *
- * The WaylandView corresponds to the presentation of a surface on a specific output, managing
- * the buffers that contain the contents to be rendered. You can have several views into the same surface.
+ * The WaylandView corresponds to the presentation of a surface on a specific
+ * output, managing the buffers that contain the contents to be rendered.
+ * You can have several views into the same surface.
  */
 
 /*!
  * \class QWaylandView
  * \inmodule QtWaylandCompositor
  * \preliminary
- * \brief Represents a view of a surface on an output.
+ * \brief The QWaylandView class represents a view of a surface on an output.
  *
- * The WaylandView corresponds to the presentation of a surface on a specific output, managing
- * the buffers that contain the contents to be rendered. You can have several views into the same surface.
+ * The QWaylandView corresponds to the presentation of a surface on a specific
+ * output, managing the buffers that contain the contents to be rendered.
+ * You can have several views into the same surface.
  */
 
 /*!
@@ -162,7 +164,7 @@ void QWaylandView::setSurface(QWaylandSurface *newSurface)
 }
 
 /*!
- * \qmlproperty object QtWaylandCompositor::WaylandView::surface
+ * \qmlproperty object QtWaylandCompositor::WaylandView::output
  *
  * This property holds the output on which this view displays its surface.
  */
@@ -196,8 +198,8 @@ void QWaylandView::setOutput(QWaylandOutput *newOutput)
 }
 
 /*!
- * Attaches a new buffer \a ref and \a damage region to this QWaylandView. These
- * will become current the next time advance() is called.
+ * Attaches a new buffer \a ref and a \a damage region to this QWaylandView. These
+ * will become current on a subsequent call to the advance() method.
  */
 void QWaylandView::attach(const QWaylandBufferRef &ref, const QRegion &damage)
 {
@@ -208,21 +210,20 @@ void QWaylandView::attach(const QWaylandBufferRef &ref, const QRegion &damage)
 }
 
 /*!
- * Sets the next buffer and damage to current and returns true. If the buffer
+ * Sets the next buffer and damage region to current and returns \c true. If the buffer
  * is locked or if no new buffer has been attached since the last call to
- * advance(), the function returns false and does nothing.
+ * advance(), the function returns \c false and does nothing.
  *
- * If this view is set as its surface's throttling view, discardCurrentBuffer()
- * will be called on all views of the same surface for which the
+ * If this view is set as the surface's throttling view, discardCurrentBuffer()
+ * is called on all views of the same surface for which the
  * \l{QWaylandView::discardFrontBuffers}{discardFrontBuffers}
  * property is set to true and the current buffer is the same as the
  * throttling view's current buffer.
  *
- * This allows for a design where a primary
- * view can make sure that views running on a lower frequency will release their
- * front buffer references so that the buffer can be reused on the client side,
- * avoiding the situation where the lower frequency views throttle the frame rate
- * of the client application.
+ * To enable clients to reuse existing buffers, enable the primary view to ensure
+ * that views running on a lower frequency will release their front buffer
+ * references. This design approach should avoid the situation where the lower
+ * frequency views throttle the frame rate of the client application.
  */
 bool QWaylandView::advance()
 {
@@ -282,20 +283,20 @@ QRegion QWaylandView::currentDamage()
  * \qmlproperty bool QtWaylandCompositor::WaylandView::bufferLock
  *
  * This property holds whether the view's buffer is currently locked. When
- * the buffer is locked, advance() will not advance to the next buffer,
- * but will instead return false.
+ * the buffer is locked, advance() will not advance to the next buffer and
+ * returns \c false.
  *
- * The default is false.
+ * The default is \c false.
  */
 
 /*!
  * \property QWaylandView::bufferLock
  *
  * This property holds whether the view's buffer is currently locked. When
- * the buffer is locked, advance() will not advance to the next buffer,
- * but will instead return false.
+ * the buffer is locked, advance() will not advance to the next buffer
+ * and returns \c false.
  *
- * The default is false.
+ * The default is \c false.
  */
 bool QWaylandView::isBufferLocked() const
 {
@@ -321,7 +322,7 @@ void QWaylandView::setBufferLock(bool locked)
  * \property QWaylandView::discardFrontBuffers
  *
  * By default, the view locks the current buffer until advance() is called. Set this property
- * to true to allow Qt to release the buffer when the throttling view is no longer using it.
+ * to \c true to allow Qt to release the buffer when the throttling view is no longer using it.
  */
 bool QWaylandView::discardFrontBuffers() const
 {