From e74ff73d2b2acef0b97530a2c7dd52e20ada6239 Mon Sep 17 00:00:00 2001 From: Johan Klokkhammer Helsing Date: Thu, 23 Nov 2017 16:15:57 +0100 Subject: Fix broken documentation Change-Id: I16f11c32c861908e34de0cb28c8ad51378aa6e61 Reviewed-by: Martin Smith --- src/compositor/compositor_api/qwaylandclient.cpp | 2 +- .../compositor_api/qwaylandcompositor.cpp | 65 +++++++++++----------- .../compositor_api/qwaylandquickitem.cpp | 12 +--- .../extensions/qwaylandiviapplication.cpp | 6 +- src/compositor/extensions/qwaylandwlshell.cpp | 5 -- src/compositor/extensions/qwaylandxdgshellv5.cpp | 9 +-- 6 files changed, 40 insertions(+), 59 deletions(-) diff --git a/src/compositor/compositor_api/qwaylandclient.cpp b/src/compositor/compositor_api/qwaylandclient.cpp index f6b5564b8..2b73c06ca 100644 --- a/src/compositor/compositor_api/qwaylandclient.cpp +++ b/src/compositor/compositor_api/qwaylandclient.cpp @@ -221,7 +221,7 @@ qint64 QWaylandClient::userId() const */ /*! - * \property int QWaylandClient::groupId + * \property QWaylandClient::groupId * * This property holds the group id of this QWaylandClient. */ diff --git a/src/compositor/compositor_api/qwaylandcompositor.cpp b/src/compositor/compositor_api/qwaylandcompositor.cpp index 3b296f3a6..4e7040889 100644 --- a/src/compositor/compositor_api/qwaylandcompositor.cpp +++ b/src/compositor/compositor_api/qwaylandcompositor.cpp @@ -283,39 +283,6 @@ void QWaylandCompositorPrivate::addPolishObject(QObject *object) } } -/*! - \qmlsignal void QtWaylandCompositor::WaylandCompositor::createSurface(WaylandClient client, int id, int version) - - This signal is emitted when a client has created a surface. - The slot connecting to this signal may create and initialize - a WaylandSurface instance in the scope of the slot. - Otherwise a default surface is created. -*/ - -/*! - \fn void QWaylandCompositor::createSurface(QWaylandClient *client, uint id, int version) - - This signal is emitted when a client has created a surface. - The slot connecting to this signal may create and initialize - a QWaylandSurface instance in the scope of the slot. - Otherwise a default surface is created. - - Connections to this signal must be of Qt::DirectConnection connection type. -*/ - -/* - \qmlsignal void surfaceCreated(QWaylandSurface *surface) - - This signal is emitted when a new WaylandSurface instance has been created. -*/ - -/* - \fn void surfaceCreated(QWaylandSurface *surface) - - This signal is emitted when a new QWaylandSurface instance has been created. -*/ - - void QWaylandCompositorPrivate::compositor_create_surface(wl_compositor::Resource *resource, uint32_t id) { Q_Q(QWaylandCompositor); @@ -464,6 +431,38 @@ void QWaylandCompositorPrivate::loadServerBufferIntegration() instance, which can have several outputs as children. */ +/*! + \qmlsignal void QtWaylandCompositor::WaylandCompositor::surfaceRequested(WaylandClient client, int id, int version) + + This signal is emitted when a client has created a surface. + The slot connecting to this signal may create and initialize + a WaylandSurface instance in the scope of the slot. + Otherwise a default surface is created. +*/ + +/*! + \fn void QWaylandCompositor::surfaceRequested(QWaylandClient *client, uint id, int version) + + This signal is emitted when a client has created a surface. + The slot connecting to this signal may create and initialize + a QWaylandSurface instance in the scope of the slot. + Otherwise a default surface is created. + + Connections to this signal must be of Qt::DirectConnection connection type. +*/ + +/*! + \qmlsignal void QtWaylandCompositor::WaylandCompositor::surfaceCreated(QWaylandSurface *surface) + + This signal is emitted when a new WaylandSurface instance has been created. +*/ + +/*! + \fn void QWaylandCompositor::surfaceCreated(QWaylandSurface *surface) + + This signal is emitted when a new QWaylandSurface instance has been created. +*/ + /*! * Constructs a QWaylandCompositor with the given \a parent. */ diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp index 4b6da1e38..00c3117ad 100644 --- a/src/compositor/compositor_api/qwaylandquickitem.cpp +++ b/src/compositor/compositor_api/qwaylandquickitem.cpp @@ -386,15 +386,7 @@ QWaylandCompositor *QWaylandQuickItem::compositor() const } /*! - * \qmlproperty WaylandView QtWaylandCompositor::WaylandQuickItem::view - * - * This property holds the view rendered by this WaylandQuickItem. - */ - -/*! - * \property QWaylandQuickItem::view - * - * This property holds the view rendered by this QWaylandQuickItem. + * Returns the view rendered by this QWaylandQuickItem. */ QWaylandView *QWaylandQuickItem::view() const { @@ -815,7 +807,7 @@ void QWaylandQuickItem::setBufferLocked(bool locked) } /*! - * \property bool QWaylandQuickItem::allowDiscardFrontBuffer + * \property QWaylandQuickItem::allowDiscardFrontBuffer * * By default, the item locks the current buffer until a new buffer is available * and updatePaintNode() is called. Set this property to true to allow Qt to release the buffer diff --git a/src/compositor/extensions/qwaylandiviapplication.cpp b/src/compositor/extensions/qwaylandiviapplication.cpp index 1190eb2a1..8295d2a18 100644 --- a/src/compositor/extensions/qwaylandiviapplication.cpp +++ b/src/compositor/extensions/qwaylandiviapplication.cpp @@ -146,7 +146,7 @@ QByteArray QWaylandIviApplication::interfaceName() */ /*! - * \fn void QWaylandWlShell::iviSurfaceRequested(QWaylandSurface *surface, uint iviId, const QWaylandResource &resource) + * \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 @@ -162,9 +162,9 @@ QByteArray QWaylandIviApplication::interfaceName() */ /*! - * \fn void QtWaylandCompositor::IviApplication::iviSurfaceCreated(QWaylandIviSurface *iviSurface) + * \fn void QWaylandIviApplication::iviSurfaceCreated(QWaylandIviSurface *iviSurface) * - * This signal is emitted when an IviSurface has been created. + * This signal is emitted when an IviSurface, \a iviSurface, has been created. */ QWaylandIviApplicationPrivate::QWaylandIviApplicationPrivate() diff --git a/src/compositor/extensions/qwaylandwlshell.cpp b/src/compositor/extensions/qwaylandwlshell.cpp index 36c579e95..4cdbb0a3a 100644 --- a/src/compositor/extensions/qwaylandwlshell.cpp +++ b/src/compositor/extensions/qwaylandwlshell.cpp @@ -633,11 +633,6 @@ QWaylandWlShell *QWaylandWlShellSurface::shell() const * This property holds the window type of the WlShellSurface. */ -/*! - * \property QWaylandWlShellSurface::windowType - * - * This property holds the window type of the QWaylandWlShellSurface. - */ Qt::WindowType QWaylandWlShellSurface::windowType() const { Q_D(const QWaylandWlShellSurface); diff --git a/src/compositor/extensions/qwaylandxdgshellv5.cpp b/src/compositor/extensions/qwaylandxdgshellv5.cpp index 8019afe00..b5db226c2 100644 --- a/src/compositor/extensions/qwaylandxdgshellv5.cpp +++ b/src/compositor/extensions/qwaylandxdgshellv5.cpp @@ -888,11 +888,11 @@ void QWaylandXdgSurfaceV5::initialize(QWaylandXdgShellV5 *xdgShell, QWaylandSurf * typically in response to the window decorations being dragged by \a seat on the window borders * given by \a edges. * - * \sa QWaylandXdgSurfaceV5::ResizeEdges + * \sa QWaylandXdgSurfaceV5::ResizeEdge */ /*! - * \fn void QWaylandXdgSurfaceV5::startResize(QWaylandSeat *seat, ResizeEdges edges) + * \fn void QWaylandXdgSurfaceV5::startResize(QWaylandSeat *seat, ResizeEdge edges) * * This signal is emitted when the client wants to start an interactive resize of the * QWaylandXdgSurfaceV5, typically in response to the window decorations being dragged by @@ -1048,11 +1048,6 @@ QWaylandSurface *QWaylandXdgSurfaceV5::surface() const * This property holds the window type of the XdgSurfaceV5. */ -/*! - * \property QWaylandXdgSurfaceV5::windowType - * - * This property holds the window type of the QWaylandXdgSurfaceV5. - */ Qt::WindowType QWaylandXdgSurfaceV5::windowType() const { Q_D(const QWaylandXdgSurfaceV5); -- cgit v1.2.3