diff options
| author | Nico Vertriest <nico.vertriest@qt.io> | 2016-10-04 14:30:21 +0200 |
|---|---|---|
| committer | Nico Vertriest <nico.vertriest@theqtcompany.com> | 2016-11-03 09:59:52 +0000 |
| commit | 785f543bed9b0f05c4f6b0de7453faab04c1c8e8 (patch) | |
| tree | b97809549c27f4f690eb3a02ae3b25ab3507e772 /src/compositor/extensions/qwaylandxdgshellv5.cpp | |
| parent | e05f6c01d2ac4b807c07a682927f75d70292595b (diff) | |
Doc: Added missing documentation for certain parameters
Change-Id: I6f30d9032a9f5f432aacee1b05439445933fb9d0
Reviewed-by: Johan Helsing <johan.helsing@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
Diffstat (limited to 'src/compositor/extensions/qwaylandxdgshellv5.cpp')
| -rw-r--r-- | src/compositor/extensions/qwaylandxdgshellv5.cpp | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/src/compositor/extensions/qwaylandxdgshellv5.cpp b/src/compositor/extensions/qwaylandxdgshellv5.cpp index b73b84d7a..fd23865cf 100644 --- a/src/compositor/extensions/qwaylandxdgshellv5.cpp +++ b/src/compositor/extensions/qwaylandxdgshellv5.cpp @@ -912,13 +912,15 @@ QSize QWaylandXdgSurfaceV5::sizeForResize(const QSizeF &size, const QPointF &del } /*! - * \qmlmethod int QtWaylandCompositor::XdgSurface::sendConfigure(size size, List<uint>) + * \qmlmethod int QtWaylandCompositor::XdgSurface::sendConfigure(size size, list<uint> states) * - * Sends a configure event to the client. Known states are enumerated in XdgSurface::State + * Sends a configure event to the client. \a size contains the pixel size of the surface. + * Known \a states are enumerated in XdgSurface::State. */ /*! - * Sends a configure event to the client. Known states are enumerated in QWaylandXdgSurfaceV5::State + * Sends a configure event to the client. Parameter \a size contains the pixel size + * of the surface. Known \a states are enumerated in QWaylandXdgSurfaceV5::State. */ uint QWaylandXdgSurfaceV5::sendConfigure(const QSize &size, const QVector<uint> &states) { @@ -1038,8 +1040,8 @@ QWaylandXdgPopupV5::QWaylandXdgPopupV5() } /*! - * Constructs a QWaylandXdgPopupV5 for \a surface and initializes it with the - * given \a parentSurface and \a resource. + * Constructs a QWaylandXdgPopupV5, associating it with \a xdgShell at the specified \a position + * for \a surface and initializes it with the given \a parentSurface and \a resource. */ QWaylandXdgPopupV5::QWaylandXdgPopupV5(QWaylandXdgShellV5 *xdgShell, QWaylandSurface *surface, QWaylandSurface *parentSurface, const QPoint &position, const QWaylandResource &resource) |