diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2015-11-04 12:47:51 +0100 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@theqtcompany.com> | 2015-11-23 14:15:40 +0000 |
| commit | 85ffad3142cd4c3baa0bb77b0674a17287b01534 (patch) | |
| tree | d0ab865a944d837b965546248b19e1ab69e99a82 /src/render/picking | |
| parent | ed9628c87fac466ee6106d12996373ddf56f2c73 (diff) | |
Doc: Fix QDoc warnings and do further cleanup
Fix the documentation issues that still remained broken after
renaming the namespaces/QML modules. Do further cleanup and
minor doc editing.
Change-Id: Iff38c8c1b99e7f712dc3f9ad07ecd37a747b3a26
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Diffstat (limited to 'src/render/picking')
| -rw-r--r-- | src/render/picking/qobjectpicker.cpp | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/src/render/picking/qobjectpicker.cpp b/src/render/picking/qobjectpicker.cpp index da13baace..6213c6d0b 100644 --- a/src/render/picking/qobjectpicker.cpp +++ b/src/render/picking/qobjectpicker.cpp @@ -46,16 +46,17 @@ namespace Qt3DRender { /*! \class Qt3DRender::QObjectPicker + \inmodule Qt3DRender - \brief The Qt3DRender::QObjectPicker class instantiates a component that can - be used to interact with a Qt3DCore::QEntity by a process known as picking. + \brief The QObjectPicker class instantiates a component that can + be used to interact with a QEntity by a process known as picking. - The signals pressed(), released(), clicked(), entered(), exited() are + The signals pressed(), released(), clicked(), entered(), and exited() are emitted when the bounding volume defined by the pickAttribute property intersects with a ray. \note Instances of this component shouldn't be shared, not respecting that - condition will most likely result in undefined behaviors. + condition will most likely result in undefined behavior. \since 5.6 */ @@ -80,9 +81,6 @@ namespace Qt3DRender { \qmlsignal Qt3D.Render::ObjectPicker::exited() */ -/*! - \internal -*/ class QObjectPickerPrivate : public Qt3DCore::QComponentPrivate { public: |