From 3c4b3e3b969080a83ead1332ab80acc1e1c924e5 Mon Sep 17 00:00:00 2001
From: Nico Vertriest <nico.vertriest@theqtcompany.com>
Date: Thu, 23 Jun 2016 13:49:42 +0200
Subject: [PATCH] Doc: minor link issues in qtwayland
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Change-Id: I0dd4d0262818ee622f9572506d4025e586f5674b
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
---
 .../compositor_api/qwaylandclient.cpp         |  3 +++
 .../compositor_api/qwaylandquicksurface.cpp   |  4 ++--
 .../compositor_api/qwaylandview.cpp           | 22 +++++++++++--------
 src/compositor/extensions/qwaylandwlshell.cpp |  2 +-
 4 files changed, 19 insertions(+), 12 deletions(-)

diff --git a/src/compositor/compositor_api/qwaylandclient.cpp b/src/compositor/compositor_api/qwaylandclient.cpp
index a3cc7cad..044977b5 100644
--- a/src/compositor/compositor_api/qwaylandclient.cpp
+++ b/src/compositor/compositor_api/qwaylandclient.cpp
@@ -181,6 +181,7 @@ wl_client *QWaylandClient::client() const
 
 /*!
  * \property QWaylandClient::userId
+ * \readonly
  *
  * This property holds the user id of this QWaylandClient.
  */
@@ -193,6 +194,7 @@ qint64 QWaylandClient::userId() const
 
 /*!
  * \qmlproperty int QtWaylandCompositor::WaylandClient::groupId
+ * \readonly
  *
  * This property holds the group id of this WaylandClient.
  */
@@ -211,6 +213,7 @@ qint64 QWaylandClient::groupId() const
 
 /*!
  * \qmlproperty int QtWaylandCompositor::WaylandClient::processId
+ * \readonly
  *
  * This property holds the process id of this WaylandClient.
  */
diff --git a/src/compositor/compositor_api/qwaylandquicksurface.cpp b/src/compositor/compositor_api/qwaylandquicksurface.cpp
index 0fc07c6c..30a94556 100644
--- a/src/compositor/compositor_api/qwaylandquicksurface.cpp
+++ b/src/compositor/compositor_api/qwaylandquicksurface.cpp
@@ -87,7 +87,7 @@ QWaylandQuickSurface::~QWaylandQuickSurface()
 }
 
 /*!
- * \qmlproperty QtWaylandCompositor::WaylandSurface::useTextureAlpha
+ * \qmlproperty bool QtWaylandCompositor::WaylandSurface::useTextureAlpha
  *
  * This property specifies whether the surface should use texture alpha.
  */
@@ -108,7 +108,7 @@ void QWaylandQuickSurface::setUseTextureAlpha(bool useTextureAlpha)
 }
 
 /*!
- * \qmlproperty QtWaylandCompositor::WaylandSurface::clientRenderingEnabled
+ * \qmlproperty bool QtWaylandCompositor::WaylandSurface::clientRenderingEnabled
  *
  * This property specifies whether client rendering is enabled for the surface.
  */
diff --git a/src/compositor/compositor_api/qwaylandview.cpp b/src/compositor/compositor_api/qwaylandview.cpp
index 73cb49be..6c1ce248 100644
--- a/src/compositor/compositor_api/qwaylandview.cpp
+++ b/src/compositor/compositor_api/qwaylandview.cpp
@@ -104,20 +104,19 @@ QWaylandView::~QWaylandView()
 }
 
 /*!
-  \internal Didn't we decide to remove this property?
+* \internal
+*  Didn't we decide to remove this property?
 */
 QObject *QWaylandView::renderObject() const
 {
     Q_D(const QWaylandView);
     return d->renderObject;
 }
-
 /*!
- * \qmlproperty object QtWaylandCompositor::WaylandView::surface
- *
- * This property holds the surface viewed by this WaylandView.
- */
-
+* \qmlproperty object QtWaylandCompositor::WaylandView::surface
+*
+* This property holds the surface viewed by this WaylandView.
+*/
 /*!
  * \property QWaylandView::surface
  *
@@ -312,9 +311,14 @@ void QWaylandView::setBufferLock(bool locked)
     d->bufferLock = locked;
     emit bufferLockChanged();
 }
-
 /*!
- * \property bool QWaylandView::discardFrontBuffers
+ * \qmlproperty bool QtWaylandCompositor::WaylandView::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.
+ */
+/*!
+ * \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.
diff --git a/src/compositor/extensions/qwaylandwlshell.cpp b/src/compositor/extensions/qwaylandwlshell.cpp
index 93bad293..a4d98207 100644
--- a/src/compositor/extensions/qwaylandwlshell.cpp
+++ b/src/compositor/extensions/qwaylandwlshell.cpp
@@ -446,7 +446,7 @@ QSize QWaylandWlShellSurface::sizeForResize(const QSizeF &size, const QPointF &d
  * This enum type provides a way to specify a specific edge or corner of
  * the surface.
  *
- * \value None No edge.
+ * \value NoneEdge No edge.
  * \value TopEdge The top edge.
  * \value BottomEdge The bottom edge.
  * \value LeftEdge The left edge.
-- 
GitLab