Skeletal Doc for render-picking

Task-number: QTBUG-46037
Change-Id: I2839f9d30498fa4ed3571bd282c2145cb5bcb25a
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

1 files changed, 47 insertions, 0 deletions

diff --git a/src/render/picking/qobjectpicker.cpp b/src/render/picking/qobjectpicker.cpp
index 2eb981d69..c8a69c363 100644
--- a/src/render/picking/qobjectpicker.cpp
+++ b/src/render/picking/qobjectpicker.cpp
@@ -59,6 +59,11 @@ namespace Qt3DRender {
     emitted when the bounding volume defined by the pickAttribute property intersects
     with a ray.
 
+    Pick queries are performed on mouse press and mouse release.
+    If drag is enabled, queries also happen on each mouse move while any button is pressed.
+    If hover is enabled, queries happen on every mouse move even if no button is pressed.
+    \sa QPickingSettings
+
     \note Instances of this component shouldn't be shared, not respecting that
     condition will most likely result in undefined behavior.
 
@@ -66,6 +71,14 @@ namespace Qt3DRender {
 */
 
 /*!
+ * \qmltype ObjectPicker
+ * \instantiates Qt3DRender::QObjectPicker
+ * \inqmlmodule Qt3D.Render
+ * \brief The ObjectPicker class instantiates a component that can
+    be used to interact with an Entity by a process known as picking.
+ */
+
+/*!
     \qmlsignal Qt3D.Render::ObjectPicker::pressed()
 */
 
@@ -99,6 +112,9 @@ QObjectPicker::~QObjectPicker()
 {
 }
 
+/*!
+ * Sets the hoverEnabled Property to \a hoverEnabled
+ */
 void QObjectPicker::setHoverEnabled(bool hoverEnabled)
 {
     Q_D(QObjectPicker);
@@ -110,13 +126,24 @@ void QObjectPicker::setHoverEnabled(bool hoverEnabled)
 
 /*!
     \qmlproperty bool Qt3D.Render::ObjectPicker::hoverEnabled
+    Specifies if hover is enabled
 */
+/*!
+  \property Qt3DRender::QObjectPicker::hoverEnabled
+    Specifies if hover is enabled
+ */
+/*!
+ * \return true if hover enabled
+ */
 bool QObjectPicker::isHoverEnabled() const
 {
     Q_D(const QObjectPicker);
     return d->m_hoverEnabled;
 }
 
+/*!
+ * Sets the dragEnabled Property to \a dragEnabled
+ */
 void QObjectPicker::setDragEnabled(bool dragEnabled)
 {
     Q_D(QObjectPicker);
@@ -129,6 +156,13 @@ void QObjectPicker::setDragEnabled(bool dragEnabled)
 /*!
     \qmlproperty bool Qt3D.Render::ObjectPicker::dragEnabled
 */
+/*!
+  \property Qt3DRender::QObjectPicker::dragEnabled
+    Specifies if drag is enabled
+ */
+/*!
+ * \return true if dragging is enabled
+ */
 bool QObjectPicker::isDragEnabled() const
 {
     Q_D(const QObjectPicker);
@@ -137,7 +171,15 @@ bool QObjectPicker::isDragEnabled() const
 
 /*!
     \qmlproperty bool Qt3D.Render::ObjectPicker::containsMouse
+    Specifies if the object picker currently contains the mouse
 */
+/*!
+  \property Qt3DRender::QObjectPicker::containsMouse
+    Specifies if the object picker currently contains the mouse
+ */
+/*!
+ * \return true if the object picker currently contains the mouse
+ */
 bool QObjectPicker::containsMouse() const
 {
     Q_D(const QObjectPicker);
@@ -146,7 +188,12 @@ bool QObjectPicker::containsMouse() const
 
 /*!
     \qmlproperty bool Qt3D.Render::ObjectPicker::pressed
+    Specifies if the object picker is currently pressed
 */
+/*!
+  \property Qt3DRender::QObjectPicker::pressed
+    Specifies if the object picker is currently pressed
+ */
 bool QObjectPicker::isPressed() const
 {
     Q_D(const QObjectPicker);