diff options
author | Nico Vertriest <nico.vertriest@qt.io> | 2017-08-18 15:42:44 +0200 |
---|---|---|
committer | Nico Vertriest <nico.vertriest@qt.io> | 2017-08-29 12:43:36 +0000 |
commit | 85f22204273600ad1958192efd1729bd829509f4 (patch) | |
tree | 997ee277129c9212af29ffa4ec53960fd4ebfeb3 /src/render | |
parent | 142cc363d7175c7cc9c7271154e12f7f23bfe514 (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')
-rw-r--r-- | src/render/lights/qabstractlight.cpp | 25 | ||||
-rw-r--r-- | src/render/lights/qspotlight.cpp | 6 | ||||
-rw-r--r-- | src/render/materialsystem/qshaderprogram.cpp | 8 | ||||
-rw-r--r-- | src/render/picking/qpicktriangleevent.cpp | 7 |
4 files changed, 34 insertions, 12 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 */ diff --git a/src/render/materialsystem/qshaderprogram.cpp b/src/render/materialsystem/qshaderprogram.cpp index 2a65d257c..e6f9631d0 100644 --- a/src/render/materialsystem/qshaderprogram.cpp +++ b/src/render/materialsystem/qshaderprogram.cpp @@ -81,7 +81,7 @@ */ /*! - \enum QShaderProgram::ShaderStatus + \enum QShaderProgram::Status This enum identifies the status of shader used. @@ -137,6 +137,9 @@ QShaderProgram::QShaderProgram(QShaderProgramPrivate &dd, QNode *parent) { } +/*! + Posts a scene change with parameter \a change. +*/ void QShaderProgram::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) { Q_D(QShaderProgram); @@ -381,6 +384,9 @@ QString QShaderProgram::log() const Holds the status of the current shader program. */ +/*! + Returns the status of the current shader program. +*/ QShaderProgram::Status QShaderProgram::status() const { Q_D(const QShaderProgram); diff --git a/src/render/picking/qpicktriangleevent.cpp b/src/render/picking/qpicktriangleevent.cpp index 2a4cdfea2..cde7a4952 100644 --- a/src/render/picking/qpicktriangleevent.cpp +++ b/src/render/picking/qpicktriangleevent.cpp @@ -236,6 +236,13 @@ uint QPickTriangleEvent::vertex3Index() const return d->m_vertex3Index; } +/*! + \property Qt3DRender::QPickTriangleEvent::uvw + +*/ +/*! + Returns the 3D coordinates u,v, and w. +*/ QVector3D QPickTriangleEvent::uvw() const { Q_D(const QPickTriangleEvent); |