mirror of https://github.com/qt/qt3d.git
Doc: Fix incorrect QML property types
QDoc now warns about C++ types in QML property documentation. This change fixes existing documentation to prevent warnings. Change-Id: Ia765b96ee7a08e95ee6b7f01e04fea1b49c14fc2 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
parent
44f170e0f6
commit
c630246205
|
|
@ -184,7 +184,7 @@ void QExtrudedTextGeometryPrivate::init()
|
|||
*/
|
||||
|
||||
/*!
|
||||
* \qmlproperty float ExtrudedTextGeometry::depth
|
||||
* \qmlproperty real ExtrudedTextGeometry::depth
|
||||
*
|
||||
* Holds the extrusion depth of the text.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ namespace Qt3DExtras {
|
|||
*/
|
||||
|
||||
/*!
|
||||
* \qmlproperty float Qt3D.Extras::ExtrudedTextMesh::depth
|
||||
* \qmlproperty real Qt3D.Extras::ExtrudedTextMesh::depth
|
||||
*
|
||||
* Holds the extrusion depth of the text.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -69,13 +69,13 @@ namespace Qt3DExtras {
|
|||
*/
|
||||
|
||||
/*!
|
||||
* \qmlproperty float Text2DEntity::width
|
||||
* \qmlproperty real Text2DEntity::width
|
||||
*
|
||||
* Holds the width of the text's bounding rectangle.
|
||||
*/
|
||||
|
||||
/*!
|
||||
* \qmlproperty float Text2DEntity::height
|
||||
* \qmlproperty real Text2DEntity::height
|
||||
*
|
||||
* Holds the height of the text's bounding rectangle.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ void QAxis::addInput(QAbstractAxisInput *input)
|
|||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty QVariantList Qt3D.Input::Axis::buttons
|
||||
\qmlproperty list<var> Qt3D.Input::Axis::buttons
|
||||
|
||||
The Buttons that can trigger this Action
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ bool QAxisSetting::isSmoothEnabled() const
|
|||
*/
|
||||
|
||||
/*!
|
||||
\qmlproperty float Qt3D.Input::AxisSetting::deadZoneRadius
|
||||
\qmlproperty real Qt3D.Input::AxisSetting::deadZoneRadius
|
||||
|
||||
The current deadZone radius of the AxisSetting
|
||||
*/
|
||||
|
|
@ -129,7 +129,7 @@ void QAxisSetting::setDeadZoneRadius(float deadZoneRadius)
|
|||
*/
|
||||
|
||||
/*!
|
||||
\qmlproperty QVariantList Qt3D.Input::AxisSetting::axis
|
||||
\qmlproperty list<var> Qt3D.Input::AxisSetting::axis
|
||||
|
||||
The current axis of the AxisSetting
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -318,7 +318,7 @@ int QRenderCapabilities::minorVersion() const
|
|||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty QStringList RenderCapabilities::extensions
|
||||
\qmlproperty list<string> RenderCapabilities::extensions
|
||||
|
||||
Returns the list of extensions currently available.
|
||||
|
||||
|
|
|
|||
|
|
@ -188,7 +188,7 @@ void QGeometryRendererPrivate::setView(QGeometryView *view)
|
|||
\sa Qt3DRender::QGeometryRenderer::PrimitiveType
|
||||
*/
|
||||
/*!
|
||||
\qmlproperty float GeometryRenderer::sortIndex
|
||||
\qmlproperty real GeometryRenderer::sortIndex
|
||||
\since 6.0
|
||||
|
||||
Overrides the sorting index when depth sorting is enabled.
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ void QAbstractLight::setColor(const QColor &c)
|
|||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty float Qt3D.Render.Light::intensity
|
||||
\qmlproperty real Qt3D.Render.Light::intensity
|
||||
|
||||
Holds the current Light intensity.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -98,7 +98,7 @@ QPointLight::QPointLight(QPointLightPrivate &dd, QNode *parent)
|
|||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty float Qt3D.Render::PointLight::constantAttenuation
|
||||
\qmlproperty real Qt3D.Render::PointLight::constantAttenuation
|
||||
Specifies the constant attenuation of the point light.
|
||||
|
||||
\note The exact meaning and use of this property is up to the
|
||||
|
|
@ -128,7 +128,7 @@ void QPointLight::setConstantAttenuation(float value)
|
|||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty float Qt3D.Render::PointLight::linearAttenuation
|
||||
\qmlproperty real Qt3D.Render::PointLight::linearAttenuation
|
||||
Specifies the linear attenuation of the point light.
|
||||
|
||||
\note The exact meaning and use of this property is up to the
|
||||
|
|
@ -158,7 +158,7 @@ void QPointLight::setLinearAttenuation(float value)
|
|||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty float Qt3D.Render::PointLight::quadraticAttenuation
|
||||
\qmlproperty real Qt3D.Render::PointLight::quadraticAttenuation
|
||||
Specifies the quadratic attenuation of the point light.
|
||||
|
||||
\note The exact meaning and use of this property is up to the
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ QSpotLight::QSpotLight(QSpotLightPrivate &dd, QNode *parent)
|
|||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty float Qt3D.Render::SpotLight::constantAttenuation
|
||||
\qmlproperty real Qt3D.Render::SpotLight::constantAttenuation
|
||||
Specifies the constant attenuation of the spot light.
|
||||
|
||||
\note The exact meaning and use of this property is up to the
|
||||
|
|
@ -133,7 +133,7 @@ void QSpotLight::setConstantAttenuation(float value)
|
|||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty float Qt3D.Render::SpotLight::linearAttenuation
|
||||
\qmlproperty real Qt3D.Render::SpotLight::linearAttenuation
|
||||
Specifies the linear attenuation of the spot light.
|
||||
|
||||
\note The exact meaning and use of this property is up to the
|
||||
|
|
@ -163,7 +163,7 @@ void QSpotLight::setLinearAttenuation(float value)
|
|||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty float Qt3D.Render::SpotLight::quadraticAttenuation
|
||||
\qmlproperty real Qt3D.Render::SpotLight::quadraticAttenuation
|
||||
Specifies the quadratic attenuation of the spot light.
|
||||
|
||||
\note The exact meaning and use of this property is up to the
|
||||
|
|
@ -214,7 +214,7 @@ QVector3D QSpotLight::localDirection() const
|
|||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty float Qt3D.Render::SpotLight::cutOffAngle
|
||||
\qmlproperty real Qt3D.Render::SpotLight::cutOffAngle
|
||||
Specifies the cut off angle of the spot light.
|
||||
|
||||
\note The exact meaning and use of this property is up to the
|
||||
|
|
|
|||
Loading…
Reference in New Issue