diff options
author | Johan Klokkhammer Helsing <johan.helsing@qt.io> | 2017-09-26 12:20:51 +0200 |
---|---|---|
committer | Johan Helsing <johan.helsing@qt.io> | 2017-10-03 14:09:35 +0000 |
commit | 00a99e631459eb7e52fde822c24d7b9d603008c4 (patch) | |
tree | eaab9b3d5f51199880e067b2b05eb47681652637 | |
parent | a951b854823a1fb33f27fc04f5bd020dd937f5b5 (diff) | |
download | qtwayland-00a99e631459eb7e52fde822c24d7b9d603008c4.tar.gz |
Add missing QML documentation for IviSurface
Change-Id: I4b84d7eac0016dccaa370419487940e32130617e
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
-rw-r--r-- | src/compositor/extensions/qwaylandivisurface.cpp | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/src/compositor/extensions/qwaylandivisurface.cpp b/src/compositor/extensions/qwaylandivisurface.cpp index dde7ce61..0bb2a615 100644 --- a/src/compositor/extensions/qwaylandivisurface.cpp +++ b/src/compositor/extensions/qwaylandivisurface.cpp @@ -51,16 +51,27 @@ QT_BEGIN_NAMESPACE QWaylandSurfaceRole QWaylandIviSurfacePrivate::s_role("ivi_surface"); /*! + * \qmltype IviSurface + * \inqmlmodule QtWayland.Compositor + * \since 5.8 + * \brief Provides a simple way to identify and resize a surface. + * + * This type is part of the \l{IviApplication} extension and provides a way to extend + * the functionality of an existing WaylandSurface with a way to resize and identify it. + * + * It corresponds to the Wayland \c ivi_surface interface. + */ + +/*! * \class QWaylandIviSurface * \inmodule QtWaylandCompositor * \since 5.8 * \brief The QWaylandIviSurface class provides a simple way to identify and resize a surface. * * This class is part of the QWaylandIviApplication extension and provides a way to - * extend the functionality of an existing QWaylandSurface with features a way to - * resize and identify it. + * extend the functionality of an existing QWaylandSurface with a way to resize and identify it. * - * It corresponds to the Wayland interface ivi_surface. + * It corresponds to the Wayland \c ivi_surface interface. */ /*! |