diff options
| author | Kavindra Palaraja <kpalaraja@luxoft.com> | 2019-03-19 10:59:30 +0100 |
|---|---|---|
| committer | Kavindra Palaraja <kpalaraja@luxoft.com> | 2019-03-19 12:38:54 +0000 |
| commit | 548cdde11d6148420dfb8f15d12788dba5e3260a (patch) | |
| tree | b8c80fadf71a5a989a4e7c7762cd1091354f3ab9 /src/compositor/compositor_api/qwaylandsurface.cpp | |
| parent | 990982c03c092282462d8409ccd8b8365b0a9dfa (diff) | |
[docs] Fix qdoc warnings
Change-Id: I57e89057a238064e1270d036b656d261b85e50e7
Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>
Diffstat (limited to 'src/compositor/compositor_api/qwaylandsurface.cpp')
| -rw-r--r-- | src/compositor/compositor_api/qwaylandsurface.cpp | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/compositor/compositor_api/qwaylandsurface.cpp b/src/compositor/compositor_api/qwaylandsurface.cpp index 5f1ac6e41..826cd3fdc 100644 --- a/src/compositor/compositor_api/qwaylandsurface.cpp +++ b/src/compositor/compositor_api/qwaylandsurface.cpp @@ -847,7 +847,7 @@ QList<QWaylandView *> QWaylandSurface::views() const } /*! - * Returns the QWaylandSurface corresponding to the Wayland resource \a res. + * Returns the QWaylandSurface corresponding to the Wayland resource \a resource. */ QWaylandSurface *QWaylandSurface::fromResource(::wl_resource *resource) { @@ -866,11 +866,12 @@ struct wl_resource *QWaylandSurface::resource() const } /*! - * Sets a \a role on the surface. A role defines how a surface will be mapped on screen, without a role - * a surface is supposed to be hidden. Only one role at all times can be set on a surface. Although + * Sets a \a role on the surface. A role defines how a surface will be mapped on screen; without a role + * a surface is supposed to be hidden. Only one role can be set on a surface, at all times. Although * setting the same role many times is allowed, attempting to change the role of a surface will trigger * a protocol error to the \a errorResource and send an \a errorCode to the client. * + * Returns true if a role can be assigned; false otherwise. */ bool QWaylandSurface::setRole(QWaylandSurfaceRole *role, wl_resource *errorResource, uint32_t errorCode) { |