summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJohan Klokkhammer Helsing <johan.helsing@qt.io>2017-09-26 11:20:30 +0200
committerJohan Helsing <johan.helsing@qt.io>2017-10-17 08:59:46 +0000
commited413219535595104be0a6c8c398db9782b57ab8 (patch)
treec4dd7241206f6459ed4c8d1b99633ff549f15e77
parentfefb26f01fc07aeb615a1aef596cf984f105ca43 (diff)
Compositor documentation: Specify return types for objects
Change-Id: I9ff21c7d8b085be8fbcb102b5284ec1ac5dfb40b Reviewed-by: Pier Luigi Fiorini <pierluigi.fiorini@liri.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
-rw-r--r--src/compositor/compositor_api/qwaylandclient.cpp2
-rw-r--r--src/compositor/compositor_api/qwaylandcompositor.cpp4
-rw-r--r--src/compositor/compositor_api/qwaylandoutput.cpp2
-rw-r--r--src/compositor/compositor_api/qwaylandquickitem.cpp6
-rw-r--r--src/compositor/compositor_api/qwaylandsurface.cpp2
-rw-r--r--src/compositor/compositor_api/qwaylandview.cpp5
-rw-r--r--src/compositor/extensions/qwaylandivisurface.cpp2
-rw-r--r--src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp2
-rw-r--r--src/compositor/extensions/qwaylandwlshell.cpp4
-rw-r--r--src/compositor/extensions/qwaylandxdgshellv5.cpp14
10 files changed, 22 insertions, 21 deletions
diff --git a/src/compositor/compositor_api/qwaylandclient.cpp b/src/compositor/compositor_api/qwaylandclient.cpp
index 48675c495..f6b5564b8 100644
--- a/src/compositor/compositor_api/qwaylandclient.cpp
+++ b/src/compositor/compositor_api/qwaylandclient.cpp
@@ -167,7 +167,7 @@ QWaylandClient *QWaylandClient::fromWlClient(QWaylandCompositor *compositor, wl_
}
/*!
- * \qmlproperty object QtWaylandCompositor::WaylandClient::compositor
+ * \qmlproperty WaylandCompositor QtWaylandCompositor::WaylandClient::compositor
*
* This property holds the compositor of this WaylandClient.
*/
diff --git a/src/compositor/compositor_api/qwaylandcompositor.cpp b/src/compositor/compositor_api/qwaylandcompositor.cpp
index 522ef0413..00f3d83f0 100644
--- a/src/compositor/compositor_api/qwaylandcompositor.cpp
+++ b/src/compositor/compositor_api/qwaylandcompositor.cpp
@@ -660,7 +660,7 @@ QWaylandOutput *QWaylandCompositor::outputFor(QWindow *window) const
}
/*!
- * \qmlproperty object QtWaylandCompositor::WaylandCompositor::defaultOutput
+ * \qmlproperty WaylandOutput QtWaylandCompositor::WaylandCompositor::defaultOutput
*
* This property contains the first in the list of outputs added to the
* WaylandCompositor, or null if no outputs have been added.
@@ -805,7 +805,7 @@ void QWaylandCompositor::overrideSelection(const QMimeData *data)
}
/*!
- * \qmlproperty object QtWaylandCompositor::WaylandCompositor::defaultSeat
+ * \qmlproperty WaylandSeat QtWaylandCompositor::WaylandCompositor::defaultSeat
*
* This property contains the default seat for this
* WaylandCompositor.
diff --git a/src/compositor/compositor_api/qwaylandoutput.cpp b/src/compositor/compositor_api/qwaylandoutput.cpp
index cbd7fe776..0eb5bc5df 100644
--- a/src/compositor/compositor_api/qwaylandoutput.cpp
+++ b/src/compositor/compositor_api/qwaylandoutput.cpp
@@ -336,7 +336,7 @@ void QWaylandOutput::update()
}
/*!
- * \qmlproperty object QtWaylandCompositor::WaylandOutput::compositor
+ * \qmlproperty WaylandCompositor QtWaylandCompositor::WaylandOutput::compositor
*
* This property holds the compositor displaying content on this WaylandOutput.
*
diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp
index 073322ee3..f31bf39e9 100644
--- a/src/compositor/compositor_api/qwaylandquickitem.cpp
+++ b/src/compositor/compositor_api/qwaylandquickitem.cpp
@@ -369,7 +369,7 @@ QWaylandQuickItem::~QWaylandQuickItem()
}
/*!
- * \qmlproperty object QtWaylandCompositor::WaylandQuickItem::compositor
+ * \qmlproperty WaylandCompositor QtWaylandCompositor::WaylandQuickItem::compositor
*
* This property holds the compositor for the surface rendered by this WaylandQuickItem.
*/
@@ -386,7 +386,7 @@ QWaylandCompositor *QWaylandQuickItem::compositor() const
}
/*!
- * \qmlproperty object QtWaylandCompositor::WaylandQuickItem::view
+ * \qmlproperty WaylandView QtWaylandCompositor::WaylandQuickItem::view
*
* This property holds the view rendered by this WaylandQuickItem.
*/
@@ -403,7 +403,7 @@ QWaylandView *QWaylandQuickItem::view() const
}
/*!
- * \qmlproperty object QtWaylandCompositor::WaylandQuickItem::surface
+ * \qmlproperty WaylandSurface QtWaylandCompositor::WaylandQuickItem::surface
*
* This property holds the surface rendered by this WaylandQuickItem.
*/
diff --git a/src/compositor/compositor_api/qwaylandsurface.cpp b/src/compositor/compositor_api/qwaylandsurface.cpp
index 6f277dd96..945d68827 100644
--- a/src/compositor/compositor_api/qwaylandsurface.cpp
+++ b/src/compositor/compositor_api/qwaylandsurface.cpp
@@ -445,7 +445,7 @@ bool QWaylandSurface::isInitialized() const
}
/*!
- * \qmlproperty object QtWaylandCompositor::WaylandSurface::client
+ * \qmlproperty WaylandClient QtWaylandCompositor::WaylandSurface::client
*
* This property holds the client using this WaylandSurface.
*/
diff --git a/src/compositor/compositor_api/qwaylandview.cpp b/src/compositor/compositor_api/qwaylandview.cpp
index f56cb0b8e..47996a5a0 100644
--- a/src/compositor/compositor_api/qwaylandview.cpp
+++ b/src/compositor/compositor_api/qwaylandview.cpp
@@ -117,8 +117,9 @@ QObject *QWaylandView::renderObject() const
Q_D(const QWaylandView);
return d->renderObject;
}
+
/*!
- * \qmlproperty object QtWaylandCompositor::WaylandView::surface
+ * \qmlproperty WaylandSurface QtWaylandCompositor::WaylandView::surface
*
* This property holds the surface viewed by this WaylandView.
*/
@@ -169,7 +170,7 @@ void QWaylandView::setSurface(QWaylandSurface *newSurface)
}
/*!
- * \qmlproperty object QtWaylandCompositor::WaylandView::output
+ * \qmlproperty WaylandOutput QtWaylandCompositor::WaylandView::output
*
* This property holds the output on which this view displays its surface.
*/
diff --git a/src/compositor/extensions/qwaylandivisurface.cpp b/src/compositor/extensions/qwaylandivisurface.cpp
index 0bb2a6158..08b95b3b5 100644
--- a/src/compositor/extensions/qwaylandivisurface.cpp
+++ b/src/compositor/extensions/qwaylandivisurface.cpp
@@ -121,7 +121,7 @@ void QWaylandIviSurface::initialize(QWaylandIviApplication *iviApplication, QWay
}
/*!
- * \qmlproperty object QtWaylandCompositor::IviSurface::surface
+ * \qmlproperty WaylandSurface QtWaylandCompositor::IviSurface::surface
*
* This property holds the surface associated with this IviSurface.
*/
diff --git a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
index e5443d468..289f706ca 100644
--- a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
+++ b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
@@ -87,7 +87,7 @@ QWaylandQuickShellSurfaceItem::QWaylandQuickShellSurfaceItem(QWaylandQuickShellS
}
/*!
- * \qmlproperty object QtWaylandCompositor::ShellSurfaceItem::shellSurface
+ * \qmlproperty ShellSurface QtWaylandCompositor::ShellSurfaceItem::shellSurface
*
* This property holds the ShellSurface rendered by this ShellSurfaceItem.
* It may either be an XdgSurfaceV5, WlShellSurface or IviSurface depending on which shell protocol
diff --git a/src/compositor/extensions/qwaylandwlshell.cpp b/src/compositor/extensions/qwaylandwlshell.cpp
index 0b4ab3323..dc33acc32 100644
--- a/src/compositor/extensions/qwaylandwlshell.cpp
+++ b/src/compositor/extensions/qwaylandwlshell.cpp
@@ -575,7 +575,7 @@ QWaylandQuickShellIntegration *QWaylandWlShellSurface::createIntegration(QWaylan
#endif
/*!
- * \qmlproperty object QtWaylandCompositor::WlShellSurface::surface
+ * \qmlproperty WaylandSurface QtWaylandCompositor::WlShellSurface::surface
*
* This property holds the \c wl_surface associated with this WlShellSurface.
*/
@@ -592,7 +592,7 @@ QWaylandSurface *QWaylandWlShellSurface::surface() const
}
/*!
- * \qmlproperty object QtWaylandCompositor::WlShellSurface::shell
+ * \qmlproperty WlShell QtWaylandCompositor::WlShellSurface::shell
*
* This property holds the shell associated with this WlShellSurface.
*/
diff --git a/src/compositor/extensions/qwaylandxdgshellv5.cpp b/src/compositor/extensions/qwaylandxdgshellv5.cpp
index 8f1164260..0f42eb95f 100644
--- a/src/compositor/extensions/qwaylandxdgshellv5.cpp
+++ b/src/compositor/extensions/qwaylandxdgshellv5.cpp
@@ -789,7 +789,7 @@ void QWaylandXdgSurfaceV5::handleBufferScaleChanged()
}
/*!
- * \qmlproperty object QtWaylandCompositor::XdgSurfaceV5::shell
+ * \qmlproperty XdgShellV5 QtWaylandCompositor::XdgSurfaceV5::shell
*
* This property holds the shell associated with this XdgSurfaceV5.
*/
@@ -806,7 +806,7 @@ QWaylandXdgShellV5 *QWaylandXdgSurfaceV5::shell() const
}
/*!
- * \qmlproperty object QtWaylandCompositor::XdgSurfaceV5::surface
+ * \qmlproperty WaylandSurface QtWaylandCompositor::XdgSurfaceV5::surface
*
* This property holds the surface associated with this XdgSurfaceV5.
*/
@@ -840,7 +840,7 @@ Qt::WindowType QWaylandXdgSurfaceV5::windowType() const
}
/*!
- * \qmlproperty object QtWaylandCompositor::XdgSurfaceV5::parentSurface
+ * \qmlproperty XdgSurfaceV5 QtWaylandCompositor::XdgSurfaceV5::parentSurface
*
* This property holds the XdgSurfaceV5 parent of this XdgSurfaceV5.
* When a parent surface is set, the parentSurfaceChanged() signal
@@ -1175,7 +1175,7 @@ void QWaylandXdgPopupV5::initialize(QWaylandXdgShellV5 *shell, QWaylandSurface *
}
/*!
- * \qmlproperty object QtWaylandCompositor::XdgPopupV5::shell
+ * \qmlproperty XdgShellV5 QtWaylandCompositor::XdgPopupV5::shell
*
* This property holds the shell associated with this XdgPopupV5.
*/
@@ -1192,7 +1192,7 @@ QWaylandXdgShellV5 *QWaylandXdgPopupV5::shell() const
}
/*!
- * \qmlproperty object QtWaylandCompositor::XdgPopupV5::surface
+ * \qmlproperty WaylandSurface QtWaylandCompositor::XdgPopupV5::surface
*
* This property holds the surface associated with this XdgPopupV5.
*/
@@ -1209,7 +1209,7 @@ QWaylandSurface *QWaylandXdgPopupV5::surface() const
}
/*!
- * \qmlproperty object QtWaylandCompositor::XdgPopupV5::parentSurface
+ * \qmlproperty WaylandSurface QtWaylandCompositor::XdgPopupV5::parentSurface
*
* This property holds the surface associated with the parent of this XdgPopupV5.
*/
@@ -1228,7 +1228,7 @@ QWaylandSurface *QWaylandXdgPopupV5::parentSurface() const
/*!
- * \qmlproperty object QtWaylandCompositor::XdgPopupV5::position
+ * \qmlproperty point QtWaylandCompositor::XdgPopupV5::position
*
* This property holds the location of the upper left corner of the surface
* relative to the upper left corner of the parent surface, in surface local