diff options
author | Nico Vertriest <nico.vertriest@qt.io> | 2017-03-21 12:23:27 +0100 |
---|---|---|
committer | Nico Vertriest <nico.vertriest@qt.io> | 2017-05-03 08:30:53 +0000 |
commit | d947ef04bc162d9f1816afb6188e8ef0a30c5143 (patch) | |
tree | b75137556ba4805dde1c7cd807fc3a3e1a872ac5 | |
parent | b5800ac037321e161d31ee362688aef179c8d9d2 (diff) |
Doc: correct several link errors
qkeyframeanimation.cpp:61: warning: Can't link to 'Qt3D.Render::Transform'
levelofdetailloader.qdoc:40: warning: Can't link to 'minimum'
levelofdetailloader.qdoc:40: warning: Can't link to 'maximum'
qlevelofdetail.cpp:201: warning: Can't link to 'Qt3DRender::QLevelOfDetail::SizeProxyMode'
qlevelofdetailswitch.cpp:62: warning: Can't link to 'LevelOfDetailSwitch::currentIndex'
Plus a minor language correction
Change-Id: I26096ec74880a406ada27fb3d867983845611410
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r-- | src/animation/frontend/qkeyframeanimation.cpp | 2 | ||||
-rw-r--r-- | src/doc/src/levelofdetailloader.qdoc | 2 | ||||
-rw-r--r-- | src/render/frontend/qlevelofdetail.cpp | 31 | ||||
-rw-r--r-- | src/render/frontend/qlevelofdetailswitch.cpp | 8 |
4 files changed, 10 insertions, 33 deletions
diff --git a/src/animation/frontend/qkeyframeanimation.cpp b/src/animation/frontend/qkeyframeanimation.cpp index 0b17265a6..19069a8ed 100644 --- a/src/animation/frontend/qkeyframeanimation.cpp +++ b/src/animation/frontend/qkeyframeanimation.cpp @@ -68,7 +68,7 @@ namespace Qt3DAnimation { A KeyframeAnimation type implements simple keyframe animation that can be used to animate \l Transform. The keyframes consists of multiple - timed \l {Qt3D.Render::Transform}{Transforms}, which are interpolated and applied + timed \l {Qt3D.Core::Transform}s, which are interpolated and applied to the target Transform. EasingCurve is used between keyframes to control the interpolator. RepeatMode can be set for when the position set to the KeyframeAnimation is less or or greater than the values defined in the keyframe positions. diff --git a/src/doc/src/levelofdetailloader.qdoc b/src/doc/src/levelofdetailloader.qdoc index 65fda072a..6294e4735 100644 --- a/src/doc/src/levelofdetailloader.qdoc +++ b/src/doc/src/levelofdetailloader.qdoc @@ -40,12 +40,12 @@ /*! \qmltype LevelOfDetailLoader \inqmlmodule Qt3D.Render + \inherits Entity \since 5.9 \brief An entity loader that changes depending on distance to camera or screen size A LevelOfDetailLoader will load the entity matching the \l LevelOfDetail::currentIndex. The source is selected from the \l sources property. - The range is specified using the \l {minimum} and the \l{maximum} values. \sa LevelOfDetail */ diff --git a/src/render/frontend/qlevelofdetail.cpp b/src/render/frontend/qlevelofdetail.cpp index df169876e..4d6b07d4b 100644 --- a/src/render/frontend/qlevelofdetail.cpp +++ b/src/render/frontend/qlevelofdetail.cpp @@ -77,7 +77,7 @@ QLevelOfDetailPrivate::QLevelOfDetailPrivate() The currentIndex property can then be used, for example, to enable or disable entities, change material, etc. - The LevelOfDetail component is not shareable between multiple Entity's. + The LevelOfDetail component is not shareable between multiple \l [QML]{Entity}{entities}. \code #include <Qt3DCore/QEntity> @@ -185,35 +185,6 @@ QLevelOfDetailPrivate::QLevelOfDetailPrivate() * \sa Qt3DRender::QLevelOfDetail::ThresholdType */ - -/*! - * \enum Qt3DRender::QLevelOfDetail::SizeProxyMode - * - * Specifies what is used as a proxy for the entity when computing distance - * or size. - * - * \value LevelOfDetailBoundingSphere use the bounding sphere specified by the center - * and radius properties. - * \value Children LevelOfDetailBoundingSphere use the bounding sphere of the entity the - * component is attached to. - */ - -/*! - * \qmlproperty enumeration LevelOfDetail::SizeProxyMode - * - * Specifies what is used as a proxy for the entity when computing distance - * or size. - * - * \list - * \li LevelOfDetailBoundingSphere use the bounding sphere specified by the center - * and radius properties. - * \li Children LevelOfDetailBoundingSphere use the bounding sphere of the entity the - * component is attached to. - * \endlist - * \sa Qt3DRender::QLevelOfDetail::SizeProxyMode - */ - - /*! * \qmlproperty Camera LevelOfDetail::camera * diff --git a/src/render/frontend/qlevelofdetailswitch.cpp b/src/render/frontend/qlevelofdetailswitch.cpp index a6d2b1530..845fdd5a6 100644 --- a/src/render/frontend/qlevelofdetailswitch.cpp +++ b/src/render/frontend/qlevelofdetailswitch.cpp @@ -69,11 +69,17 @@ namespace Qt3DRender { This component is assigned to an entity. When the entity changes distance relative to the camera, the LevelOfDetailSwitch will disable all the child entities except - the one matching index \l LevelOfDetailSwitch::currentIndex. + the one matching index \l currentIndex. \sa LevelOfDetail */ +/*! + \qmlproperty int LevelOfDetailSwitch::currentIndex + + The index of the presently selected child entity. +*/ + /*! \fn Qt3DRender::QLevelOfDetailSwitch::QLevelOfDetailSwitch(Qt3DCore::QNode *parent) Constructs a new QLevelOfDetailSwitch with the specified \a parent. */ |