From 548cdde11d6148420dfb8f15d12788dba5e3260a Mon Sep 17 00:00:00 2001 From: Kavindra Palaraja Date: Tue, 19 Mar 2019 10:59:30 +0100 Subject: [docs] Fix qdoc warnings Change-Id: I57e89057a238064e1270d036b656d261b85e50e7 Reviewed-by: Paul Olav Tvete --- src/compositor/compositor_api/qwaylandcompositor.cpp | 4 ++-- src/compositor/compositor_api/qwaylandsurface.cpp | 7 ++++--- src/compositor/extensions/qwaylandiviapplication.cpp | 4 ++-- src/compositor/extensions/qwaylandxdgdecorationv1.cpp | 4 ++-- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/src/compositor/compositor_api/qwaylandcompositor.cpp b/src/compositor/compositor_api/qwaylandcompositor.cpp index a0d69c52e..053235432 100644 --- a/src/compositor/compositor_api/qwaylandcompositor.cpp +++ b/src/compositor/compositor_api/qwaylandcompositor.cpp @@ -586,7 +586,7 @@ QByteArray QWaylandCompositor::socketName() const * \qmlmethod QtWaylandCompositor::WaylandCompositor::addSocketDescriptor(fd) * \since 5.12 * - * Listen for client connections on a file descriptor referring to a + * Listen for client connections on a file descriptor, \a fd, referring to a * server socket already bound and listening. * * Does not take ownership of the file descriptor; it must be closed @@ -598,7 +598,7 @@ QByteArray QWaylandCompositor::socketName() const */ /*! - * Listen for client connections on a file descriptor referring to a + * Listen for client connections on a file descriptor, \a fd, referring to a * server socket already bound and listening. * * Does not take ownership of the file descriptor; it must be closed 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 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) { diff --git a/src/compositor/extensions/qwaylandiviapplication.cpp b/src/compositor/extensions/qwaylandiviapplication.cpp index 57b1627b5..4ac5c2735 100644 --- a/src/compositor/extensions/qwaylandiviapplication.cpp +++ b/src/compositor/extensions/qwaylandiviapplication.cpp @@ -140,7 +140,7 @@ QByteArray QWaylandIviApplication::interfaceName() * \qmlsignal void QtWaylandCompositor::IviApplication::iviSurfaceRequested(WaylandSurface surface, int iviId, WaylandResource resource) * * This signal is emitted when the client has requested an \c ivi_surface to be associated - * with \a surface, which is identified by \a id. The handler for this signal is + * with \a surface, which is identified by \a iviId. The handler for this signal is * expected to create the ivi surface and initialize it within the scope of the * signal emission. If no ivi surface is created, a default one will be created instead. */ @@ -149,7 +149,7 @@ QByteArray QWaylandIviApplication::interfaceName() * \fn void QWaylandIviApplication::iviSurfaceRequested(QWaylandSurface *surface, uint iviId, const QWaylandResource &resource) * * This signal is emitted when the client has requested an \c ivi_surface to be associated - * with \a surface, which is identified by \a id. The handler for this signal is + * with \a surface, which is identified by \a iviId. The handler for this signal is * expected to create the ivi surface and initialize it within the scope of the * signal emission. If no ivi surface is created, a default one will be created instead. */ diff --git a/src/compositor/extensions/qwaylandxdgdecorationv1.cpp b/src/compositor/extensions/qwaylandxdgdecorationv1.cpp index 1abd5e3fc..89c56acd9 100644 --- a/src/compositor/extensions/qwaylandxdgdecorationv1.cpp +++ b/src/compositor/extensions/qwaylandxdgdecorationv1.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \qmltype XdgDecorationManagerV1 \inqmlmodule QtWayland.Compositor \since 5.12 - \brief Provides an extension for negotiation of server-side and client-side window decorations + \brief Provides an extension for negotiation of server-side and client-side window decorations. The XdgDecorationManagerV1 extension provides a way for a compositor to announce support for server-side window decorations, and for xdg-shell clients to communicate whether they prefer @@ -82,7 +82,7 @@ QT_BEGIN_NAMESPACE \class QWaylandXdgDecorationManagerV1 \inmodule QtWaylandCompositor \since 5.12 - \brief Provides an extension for negotiation of server-side and client-side window decorations + \brief Provides an extension for negotiation of server-side and client-side window decorations. The QWaylandXdgDecorationManagerV1 extension provides a way for a compositor to announce support for server-side window decorations, and for xdg-shell clients to communicate whether they prefer -- cgit v1.2.3