summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@theqtcompany.com>2016-06-23 13:49:42 +0200
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2016-08-10 10:11:25 +0000
commit3c4b3e3b969080a83ead1332ab80acc1e1c924e5 (patch)
tree5b084971b8c824c1a802f588cc6c2a0ff7224ce5
parent19cdda76e8e1803c3c36252088e2f8d756e7cbea (diff)
Doc: minor link issues in qtwayland
Change-Id: I0dd4d0262818ee622f9572506d4025e586f5674b Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
-rw-r--r--src/compositor/compositor_api/qwaylandclient.cpp3
-rw-r--r--src/compositor/compositor_api/qwaylandquicksurface.cpp4
-rw-r--r--src/compositor/compositor_api/qwaylandview.cpp22
-rw-r--r--src/compositor/extensions/qwaylandwlshell.cpp2
4 files changed, 19 insertions, 12 deletions
diff --git a/src/compositor/compositor_api/qwaylandclient.cpp b/src/compositor/compositor_api/qwaylandclient.cpp
index a3cc7cad6..044977b5a 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 0fc07c6c5..30a94556f 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 73cb49bea..6c1ce248f 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 93bad2938..a4d982079 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.