diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-11-12 23:18:42 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-13 12:20:22 +0100 |
| commit | ca8a6e6ee1c2439dbe439244b61f86cf062f88d5 (patch) | |
| tree | 13d43c49f9aa1d19463b92847f71395f023d0f31 /src/compositor/extensions/qwaylandxdgshellv5.cpp | |
| parent | b8f609f5d17051ed7396eb9f6c874a9cbb73b6b5 (diff) | |
Doc: Fix documentation warnings
Add missing function and function/qml method parameter documentation,
linking issues, and other minor tweaks.
QDoc fails to parse a Q_PROPERTY if the property type includes the
keyword 'enum' - fix that in the header file for
QWaylandXdgToplevel::DecorationMode.
These changes bring the currect warning count to zero.
Fixes: QTBUG-79817
Change-Id: I302b110eb91858f06e9cd410872a12365d421a8e
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/compositor/extensions/qwaylandxdgshellv5.cpp')
| -rw-r--r-- | src/compositor/extensions/qwaylandxdgshellv5.cpp | 39 |
1 files changed, 38 insertions, 1 deletions
diff --git a/src/compositor/extensions/qwaylandxdgshellv5.cpp b/src/compositor/extensions/qwaylandxdgshellv5.cpp index fab3c841a..337540fc3 100644 --- a/src/compositor/extensions/qwaylandxdgshellv5.cpp +++ b/src/compositor/extensions/qwaylandxdgshellv5.cpp @@ -591,7 +591,7 @@ QByteArray QWaylandXdgShellV5::interfaceName() } /*! - * \qmlmethod void QtWaylandCompositor::XdgShellV5::ping() + * \qmlmethod void QtWaylandCompositor::XdgShellV5::ping(WaylandClient client) * * Sends a ping event to the \a client. If the client replies to the event, the * pong signal will be emitted. @@ -784,6 +784,36 @@ void QWaylandXdgShellV5::handleFocusChanged(QWaylandSurface *newSurface, QWaylan */ /*! + \enum QWaylandXdgSurfaceV5::ResizeEdge + + \value NoneEdge + No edge defined. + \value TopEdge + Top egde. + \value BottomEdge + Bottom edge. + \value LeftEdge + Left edge. + \value TopLeftEdge + Top-left edge. + \value BottomLeftEdge + Bottom-left edge. + \value RightEdge + Right edge. + \value TopRightEdge + Top-right edge. + \value BottomRightEdge + Bottom-right edge. + */ + +/*! + * \fn QWaylandXdgSurfaceV5::setTopLevel() + * + * This signal is emitted when the parent surface is unset, effectively + * making the window top level. + */ + +/*! * \qmlsignal QtWaylandCompositor::XdgSurfaceV5::setTopLevel() * * This signal is emitted when the parent surface is unset, effectively @@ -791,6 +821,13 @@ void QWaylandXdgShellV5::handleFocusChanged(QWaylandSurface *newSurface, QWaylan */ /*! + * \fn QWaylandXdgSurfaceV5::setTransient() + * + * This signal is emitted when the parent surface is set, effectively + * making the window transient. + */ + +/*! * \qmlsignal QtWaylandCompositor::XdgSurfaceV5::setTransient() * * This signal is emitted when the parent surface is set, effectively |