diff options
author | Kavindra Palaraja <kpalaraja@luxoft.com> | 2019-03-20 16:16:11 +0100 |
---|---|---|
committer | Kavindra Palaraja <kpalaraja@luxoft.com> | 2019-03-27 15:04:20 +0000 |
commit | a20a7734ccc917eb9debe2fec6fa9dcc4d5b39a2 (patch) | |
tree | e8af52d89a16801745d4db512b5e18eb4374cdf9 | |
parent | 0f3ff1823c4bf1fc12280a677b871f381c77d0fb (diff) | |
download | qtwayland-a20a7734ccc917eb9debe2fec6fa9dcc4d5b39a2.tar.gz |
docs: Fix qdoc warnings
* Added some missing documentation
Change-Id: I214b108c084aeff501bed85845153aa80fa61e6d
Reviewed-by: Johan Helsing <johan.helsing@qt.io>
4 files changed, 103 insertions, 3 deletions
diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp index fb73760b..69c0a31a 100644 --- a/src/compositor/compositor_api/qwaylandquickitem.cpp +++ b/src/compositor/compositor_api/qwaylandquickitem.cpp @@ -1306,7 +1306,7 @@ void QWaylandQuickItem::updateInputMethod(Qt::InputMethodQueries queries) * If an animation is started, bufferLocked should be set to ensure the item keeps its content * until the animation finishes * - * \sa QWaylandQuickkItem::bufferLocked + * \sa QWaylandQuickItem::bufferLocked */ QSGNode *QWaylandQuickItem::updatePaintNode(QSGNode *oldNode, UpdatePaintNodeData *data) diff --git a/src/compositor/compositor_api/qwaylandseat.cpp b/src/compositor/compositor_api/qwaylandseat.cpp index d135ad03..bc5e1d8b 100644 --- a/src/compositor/compositor_api/qwaylandseat.cpp +++ b/src/compositor/compositor_api/qwaylandseat.cpp @@ -177,7 +177,7 @@ void QWaylandSeatPrivate::seat_get_touch(wl_seat::Resource *resource, uint32_t i */ /*! - * Constructs a QWaylandSeat for the given \a compositor and with the given \a capabilityFlags. + * Constructs a QWaylandSeat for the given \a compositor and \a capabilityFlags. */ QWaylandSeat::QWaylandSeat(QWaylandCompositor *compositor, CapabilityFlags capabilityFlags) : QWaylandObject(*new QWaylandSeatPrivate(this)) @@ -196,6 +196,14 @@ QWaylandSeat::~QWaylandSeat() { } +/*! + * Initializes parts of the seat corresponding to the capabilities set in the constructor, or + * through setCapabilities(). + * + * \note Normally, this function is called automatically after the seat and compositor have been + * created, so calling it manually is usually unnecessary. + */ + void QWaylandSeat::initialize() { Q_D(QWaylandSeat); @@ -211,6 +219,11 @@ void QWaylandSeat::initialize() d->isInitialized = true; } +/*! + * Returns true if the QWaylandSeat is initialized; false otherwise. + * + * The value \c true indicates that it's now possible for clients to start using the seat. + */ bool QWaylandSeat::isInitialized() const { Q_D(const QWaylandSeat); @@ -535,6 +548,11 @@ bool QWaylandSeat::setKeyboardFocus(QWaylandSurface *surface) return true; } + +/*! + * Returns the keymap object for this QWaylandSeat. + */ + QWaylandKeymap *QWaylandSeat::keymap() { Q_D(const QWaylandSeat); @@ -654,4 +672,65 @@ void QWaylandSeat::handleMouseFocusDestroyed() emit mouseFocusChanged(d->mouseFocus, oldFocus); } + +/*! \qmlsignal void QtWaylandCompositor::QWaylandSeat::keyboardFocusChanged(QWaylandSurface newFocus, QWaylandSurface oldFocus) + * + * This signal is emitted when setKeyboardFocus() is called or when a WaylandQuickItem has focus + * and the user starts pressing keys. + * + * \a newFocus has the surface that received keyboard focus; or \c nullptr if no surface has + * focus. + * \a oldFocus has the surface that lost keyboard focus; or \c nullptr if no surface had focus. + */ + +/*! + * \fn void QWaylandSeat::keyboardFocusChanged(QWaylandSurface *newFocus, QWaylandSurface *oldFocus) + * + * This signal is emitted when setKeyboardFocus() is called. + * + * \a newFocus has the surface that received keyboard focus; or \c nullptr if no surface has + * focus. + * \a oldFocus has the surface that lost keyboard focus; or \c nullptr if no surface had focus. + */ + +/*! \qmlsignal void QtWaylandCompositor::QWaylandSeat::cursorSurfaceRequest(QWaylandSurface surface, int hotspotX, int hotspotY) + * + * This signal is emitted when the client has requested for a specific \a surface to be the mouse + * cursor. For example, when the user hovers over a particular surface, and you want the cursor + * to change into a resize arrow. + * + * Both \a hotspotX and \a hotspotY are offsets from the top-left of a pointer surface, where a + * click should happen. For example, if the requested cursor surface is an arrow, the parameters + * indicate where the arrow's tip is, on that surface. + */ + + +/*! + * \fn void QWaylandSeat::cursorSurfaceRequest(QWaylandSurface *surface, int hotspotX, int hotspotY) + * + * This signal is emitted when the client has requested for a specific \a surface to be the mouse + * cursor. For example, when the user hovers over a particular surface, and you want the cursor + * to change into a resize arrow. + */ + +/*! + * \property QWaylandSeat::drag + * + * This property holds the drag and drop operations and sends signals when they start and end. + * The property stores details like what image should be under the mouse cursor when the user + * drags it. + */ + +/*! + * \property QWaylandSeat::keymap + * This property holds the keymap object. + * + * A keymap provides a way to translate actual key scan codes into a meaningful value. + * For example, if you use a keymap with a Norwegian layout, the key to the right of + * the letter L produces an Ø. + * + * Keymaps can also be used to customize key functions, such as to specify whether + * Control and CAPS lock should be swapped, and so on. + */ + QT_END_NAMESPACE diff --git a/src/compositor/compositor_api/qwaylandsurface.cpp b/src/compositor/compositor_api/qwaylandsurface.cpp index 826cd3fd..cd78166d 100644 --- a/src/compositor/compositor_api/qwaylandsurface.cpp +++ b/src/compositor/compositor_api/qwaylandsurface.cpp @@ -1012,4 +1012,21 @@ void QWaylandSurfacePrivate::Subsurface::subsurface_set_desync(wl_subsurface::Re * This signal is emitted when a \a drag has started from this surface. */ +/*! + * \fn void damaged(const QRegion &rect) + * + * This signal is emitted when the client tells the compositor that a particular part of, or + * possibly the entire surface has been updated, so the compositor can redraw that part. + * + * While the compositor APIs take care of redrawing automatically, this function may be useful + * if you require a specific, custom behavior. + */ + +/*! + * \fn void parentChanged(QWaylandSurface *newParent, QWaylandSurface *oldParent) + * + * This signal is emitted when the client has requested that this surface should be a + * subsurface of \a newParent. + */ + QT_END_NAMESPACE diff --git a/src/compositor/extensions/qwaylandiviapplication.cpp b/src/compositor/extensions/qwaylandiviapplication.cpp index 4ac5c273..36690341 100644 --- a/src/compositor/extensions/qwaylandiviapplication.cpp +++ b/src/compositor/extensions/qwaylandiviapplication.cpp @@ -131,6 +131,9 @@ const struct wl_interface *QWaylandIviApplication::interface() return QWaylandIviApplicationPrivate::interface(); } +/*! + * \internal + */ QByteArray QWaylandIviApplication::interfaceName() { return QWaylandIviApplicationPrivate::interfaceName(); @@ -141,8 +144,9 @@ QByteArray QWaylandIviApplication::interfaceName() * * This signal is emitted when the client has requested an \c ivi_surface to be associated * 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 + * expected to create the ivi surface for \a resource and initialize it within the scope of the * signal emission. If no ivi surface is created, a default one will be created instead. + * */ /*! |