summaryrefslogtreecommitdiffstats
path: root/src/render/lights
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2017-08-18 15:42:44 +0200
committerNico Vertriest <nico.vertriest@qt.io>2017-08-29 12:43:36 +0000
commit85f22204273600ad1958192efd1729bd829509f4 (patch)
tree997ee277129c9212af29ffa4ec53960fd4ebfeb3 /src/render/lights
parent142cc363d7175c7cc9c7271154e12f7f23bfe514 (diff)
Doc: add doc to undocumented methods qt3d
qabstractlight.h:65: warning: No documentation for 'Qt3DRender::QAbstractLight::Type' qspotlight.h:64: warning: No documentation for 'Qt3DRender::QSpotLight::attenuation()' qshaderprogram.h:78: warning: No documentation for 'Qt3DRender::QShaderProgram::Status' qshaderprogram.h:121: warning: No documentation for 'Qt3DRender::QShaderProgram::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change)' qpicktriangleevent.h:57: warning: No documentation for 'Qt3DRender::QPickTriangleEvent::uvw' Change-Id: Iedb73cc73bc28a5e9dd3498a0bb6547eb1a96ffc Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
Diffstat (limited to 'src/render/lights')
-rw-r--r--src/render/lights/qabstractlight.cpp25
-rw-r--r--src/render/lights/qspotlight.cpp6
2 files changed, 20 insertions, 11 deletions
diff --git a/src/render/lights/qabstractlight.cpp b/src/render/lights/qabstractlight.cpp
index a826654c7..e5376f712 100644
--- a/src/render/lights/qabstractlight.cpp
+++ b/src/render/lights/qabstractlight.cpp
@@ -53,15 +53,6 @@ namespace Qt3DRender
* \since 5.6
*/
-/*!
- \enum QAbstractLight::Type
-
- This enum type identifies the particular type of light.
- \value PointLight
- \value DirectionalLight
- \value SpotLight
-*/
-
QAbstractLightPrivate::QAbstractLightPrivate(QAbstractLight::Type type)
: m_type(type)
, m_shaderData(new QShaderData)
@@ -75,6 +66,20 @@ QAbstractLightPrivate::~QAbstractLightPrivate()
{
}
+/*!
+ \property Qt3DRender::QAbstractLight::type
+
+ Contains the type of light.
+*/
+/*!
+ \enum Qt3DRender::QAbstractLight::Type
+
+ Identifies the particular type of light.
+
+ \value PointLight
+ \value DirectionalLight
+ \value SpotLight
+*/
Qt3DCore::QNodeCreatedChangeBasePtr QAbstractLight::createNodeCreationChange() const
{
auto creationChange = Qt3DCore::QNodeCreatedChangePtr<QAbstractLightData>::create(this);
@@ -104,8 +109,6 @@ QAbstractLight::~QAbstractLight()
}
/*!
- \property Qt3DRender::QAbstractLight::type
-
Holds the current QAbstractLight type.
*/
QAbstractLight::Type QAbstractLight::type() const
diff --git a/src/render/lights/qspotlight.cpp b/src/render/lights/qspotlight.cpp
index 81c18387b..09335d432 100644
--- a/src/render/lights/qspotlight.cpp
+++ b/src/render/lights/qspotlight.cpp
@@ -116,6 +116,12 @@ QSpotLight::QSpotLight(QSpotLightPrivate &dd, QNode *parent)
}
/*!
+ \fn QVector3D Qt3DRender::QSpotLight::attenuation() const
+
+ Returns the attenuation of the spot light.
+*/
+
+/*!
\qmlproperty float Qt3D.Render::SpotLight::constantAttenuation
Specifies the constant attenuation of the spot light
*/