diff options
author | Topi Reinio <topi.reinio@digia.com> | 2015-04-13 12:55:34 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2015-04-14 07:41:11 +0000 |
commit | f03dc3a2599a0f05cded8b984489b89113c7f037 (patch) | |
tree | 306902e9865550448dcf035ffa18c0be45834e62 /src/render/defaults | |
parent | 075c0298d1c75dd2d61849b559edcb357d638689 (diff) |
Doc: Fix multiple C++ documentation issues
- Remove multiple \namespace commands for namespace Qt3D. QDoc in 5.5
is now able to collate namespace members from multiple modules.
- Mark 'Q...Private' classes and functions taking private arguments as
\internal
- Use correct \qtvariable for Qt 3D Core and Render
- Add src/plugins directory to Qt 3D Core documentation build to
correctly generate Assimp-related documentation.
- Ensure documentation for C++ properties is visible by
using the \property command instead of documenting the
setter/getter functions.
- Add export and logging macros to qdoc ignore directives
- Remove unnecessary use of \fn command
- Language and styling fixes
Change-Id: I2481fa30ad2f6869b85c038c20ff1730b8522d46
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'src/render/defaults')
-rw-r--r-- | src/render/defaults/qdiffusemapmaterial.cpp | 66 | ||||
-rw-r--r-- | src/render/defaults/qdiffusespecularmapmaterial.cpp | 78 | ||||
-rw-r--r-- | src/render/defaults/qforwardrenderer.cpp | 36 | ||||
-rw-r--r-- | src/render/defaults/qnormaldiffusemapalphamaterial.cpp | 8 | ||||
-rw-r--r-- | src/render/defaults/qnormaldiffusemapmaterial.cpp | 85 | ||||
-rw-r--r-- | src/render/defaults/qnormaldiffusespecularmapmaterial.cpp | 100 | ||||
-rw-r--r-- | src/render/defaults/qpervertexcolormaterial.cpp | 4 | ||||
-rw-r--r-- | src/render/defaults/qphongmaterial.cpp | 42 |
8 files changed, 202 insertions, 217 deletions
diff --git a/src/render/defaults/qdiffusemapmaterial.cpp b/src/render/defaults/qdiffusemapmaterial.cpp index a32cb3c3a..117f3ecbb 100644 --- a/src/render/defaults/qdiffusemapmaterial.cpp +++ b/src/render/defaults/qdiffusemapmaterial.cpp @@ -52,6 +52,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QDiffuseMapMaterialPrivate + \internal +*/ QDiffuseMapMaterialPrivate::QDiffuseMapMaterialPrivate(QDiffuseMapMaterial *qq) : QMaterialPrivate(qq) , m_diffuseMapEffect(new QEffect()) @@ -146,7 +150,6 @@ void QDiffuseMapMaterialPrivate::init() */ /*! - \fn Qt3D::QDiffuseMapMaterial::QDiffuseMapMaterial() Constructs a new Qt3D::QDiffuseMapMaterial instance with parent object \a parent. */ @@ -162,13 +165,17 @@ QDiffuseMapMaterial::QDiffuseMapMaterial(QNode *parent) d->init(); } +/*! + Destroys the QDiffuseMapMaterial instance. +*/ QDiffuseMapMaterial::~QDiffuseMapMaterial() { } /*! - \fn Qt3D::QDiffuseMapMaterial::ambient() const - \return the current QColor ambient value. + \property Qt3D::QDiffuseMapMaterial::ambient + + Holds the current ambient color. */ QColor QDiffuseMapMaterial::ambient() const { @@ -177,8 +184,9 @@ QColor QDiffuseMapMaterial::ambient() const } /*! - \fn Qt3D::QDiffuseMapMaterial::specular() const - \return the current QColor specular value. + \property Qt3D::QDiffuseMapMaterial::specular + + Holds the current specular color. */ QColor QDiffuseMapMaterial::specular() const { @@ -187,8 +195,9 @@ QColor QDiffuseMapMaterial::specular() const } /*! - \fn Qt3D::QDiffuseMapMaterial::shininess() const - \return the current shininess as a float value. + \property Qt3D::QDiffuseMapMaterial::shininess + + Holds the current shininess as a float value. */ float QDiffuseMapMaterial::shininess() const { @@ -197,12 +206,18 @@ float QDiffuseMapMaterial::shininess() const } /*! - \fn Qt3D::QDiffuseMapMaterial::diffuse() const - \return the current QTexture used as the diffuse map. - \b {Note:} By default the diffuse texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QDiffuseMapMaterial::diffuse + + Holds the current QTexture used as the diffuse map. + + By default, the diffuse texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QDiffuseMapMaterial::diffuse() const { @@ -211,8 +226,9 @@ QAbstractTextureProvider *QDiffuseMapMaterial::diffuse() const } /*! - \fn Qt3D::QDiffuseMapMaterial::textureScale() const - \return the current texture scale. + \property Qt3D::QDiffuseMapMaterial::textureScale + + Holds the current texture scale as a float value. */ float QDiffuseMapMaterial::textureScale() const { @@ -220,50 +236,30 @@ float QDiffuseMapMaterial::textureScale() const return d->m_textureScaleParameter->value().toFloat(); } -/*! - \fn Qt3D::QDiffuseMapMaterial::setAmbient(const QColor &ambient) - Sets the current ambient color to \a ambient. - */ void QDiffuseMapMaterial::setAmbient(const QColor &ambient) { Q_D(const QDiffuseMapMaterial); d->m_ambientParameter->setValue(ambient); } -/*! - \fn Qt3D::QDiffuseMapMaterial::setSpecular(const QColor &specular) - Sets the current specular color to \a specular. - */ void QDiffuseMapMaterial::setSpecular(const QColor &specular) { Q_D(QDiffuseMapMaterial); d->m_specularParameter->setValue(specular); } -/*! - \fn Qt3D::QDiffuseMapMaterial::setShininess(float shininess) - Sets the current shininess value to \a shininess. - */ void QDiffuseMapMaterial::setShininess(float shininess) { Q_D(QDiffuseMapMaterial); d->m_shininessParameter->setValue(shininess); } -/*! - \fn Qt3D::QDiffuseMapMaterial::setDiffuse(QTexture *diffuseMap) - Sets the current diffuse map to \a diffuseMap. - */ void QDiffuseMapMaterial::setDiffuse(QAbstractTextureProvider *diffuseMap) { Q_D(QDiffuseMapMaterial); d->m_diffuseParameter->setValue(QVariant::fromValue(diffuseMap)); } -/*! - \fn Qt3D::QDiffuseMapMaterial::setTextureScale(float textureScale) - Sets the current texture scale to \a textureScale. - */ void QDiffuseMapMaterial::setTextureScale(float textureScale) { Q_D(QDiffuseMapMaterial); diff --git a/src/render/defaults/qdiffusespecularmapmaterial.cpp b/src/render/defaults/qdiffusespecularmapmaterial.cpp index 7420ddea0..61fc5fa12 100644 --- a/src/render/defaults/qdiffusespecularmapmaterial.cpp +++ b/src/render/defaults/qdiffusespecularmapmaterial.cpp @@ -53,6 +53,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QDiffuseSpecularMapMaterialPrivate + \internal +*/ QDiffuseSpecularMapMaterialPrivate::QDiffuseSpecularMapMaterialPrivate(QDiffuseSpecularMapMaterial *qq) : QMaterialPrivate(qq) , m_diffuseSpecularMapEffect(new QEffect()) @@ -154,7 +158,6 @@ void QDiffuseSpecularMapMaterialPrivate::init() */ /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::QDiffuseSpecularMapMaterial() Constructs a new Qt3D::QDiffuseSpecularMapMaterial instance with parent object \a parent. */ QDiffuseSpecularMapMaterial::QDiffuseSpecularMapMaterial(QNode *parent) @@ -169,13 +172,17 @@ QDiffuseSpecularMapMaterial::QDiffuseSpecularMapMaterial(QNode *parent) d->init(); } +/*! + Destroys the QDiffuseSpecularMapMaterial instance. +*/ QDiffuseSpecularMapMaterial::~QDiffuseSpecularMapMaterial() { } /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::ambient() const - \return the current QColor ambient value. + \property Qt3D::QDiffuseSpecularMapMaterial::ambient + + Holds the current ambient color. */ QColor QDiffuseSpecularMapMaterial::ambient() const { @@ -184,12 +191,18 @@ QColor QDiffuseSpecularMapMaterial::ambient() const } /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::diffuse() const - \return the current diffuse map texture. - \b {Note:} By default the diffuse texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QDiffuseSpecularMapMaterial::diffuse + + Holds the current diffuse map texture. + + By default, the diffuse texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QDiffuseSpecularMapMaterial::diffuse() const { @@ -198,12 +211,18 @@ QAbstractTextureProvider *QDiffuseSpecularMapMaterial::diffuse() const } /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::specular() const - \return the current specular map texture. - \b {Note:} By default the specular texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QDiffuseSpecularMapMaterial::specular + + Holds the current specular map texture. + + By default, the specular texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QDiffuseSpecularMapMaterial::specular() const { @@ -212,8 +231,9 @@ QAbstractTextureProvider *QDiffuseSpecularMapMaterial::specular() const } /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::shininess() const - \return the current shininess as a float value. + \property Qt3D::QDiffuseSpecularMapMaterial::shininess + + Holds the current shininess as a float value. */ float QDiffuseSpecularMapMaterial::shininess() const { @@ -222,8 +242,8 @@ float QDiffuseSpecularMapMaterial::shininess() const } /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::textureScale() const - \return the current texture scale. + \property Qt3D::QDiffuseSpecularMapMaterial::textureScale + Holds the current texture scale as a float value. */ float QDiffuseSpecularMapMaterial::textureScale() const { @@ -231,50 +251,30 @@ float QDiffuseSpecularMapMaterial::textureScale() const return d->m_textureScaleParameter->value().toFloat(); } -/*! - \fn Qt3D::QDiffuseSpecularMapMaterial::setAmbient(const QColor &ambient) - Sets the current ambient color to \a ambient - */ void QDiffuseSpecularMapMaterial::setAmbient(const QColor &ambient) { Q_D(QDiffuseSpecularMapMaterial); d->m_ambientParameter->setValue(ambient); } -/*! - \fn Qt3D::QDiffuseSpecularMapMaterial::setDiffuse(QTexture *diffuse) - Sets the current diffuse map to \a diffuse. - */ void QDiffuseSpecularMapMaterial::setDiffuse(QAbstractTextureProvider *diffuse) { Q_D(QDiffuseSpecularMapMaterial); d->m_diffuseParameter->setValue(QVariant::fromValue(diffuse)); } -/*! - \fn Qt3D::QDiffuseSpecularMapMaterial::setSpecular(QTexture *specular) - Sets the current specular map to \a specular. - */ void QDiffuseSpecularMapMaterial::setSpecular(QAbstractTextureProvider *specular) { Q_D(QDiffuseSpecularMapMaterial); d->m_specularParameter->setValue(QVariant::fromValue(specular)); } -/*! - \fn Qt3D::QDiffuseSpecularMapMaterial::setShininess(float shininess) - Sets the current shininess value to \a shininess. - */ void QDiffuseSpecularMapMaterial::setShininess(float shininess) { Q_D(QDiffuseSpecularMapMaterial); d->m_shininessParameter->setValue(shininess); } -/*! - \fn Qt3D::QDiffuseSpecularMapMaterial::setTextureScale(float textureScale) - Sets the current texture scale to \a textureScale. - */ void QDiffuseSpecularMapMaterial::setTextureScale(float textureScale) { Q_D(QDiffuseSpecularMapMaterial); diff --git a/src/render/defaults/qforwardrenderer.cpp b/src/render/defaults/qforwardrenderer.cpp index c8bf9e8d7..f7d13515e 100644 --- a/src/render/defaults/qforwardrenderer.cpp +++ b/src/render/defaults/qforwardrenderer.cpp @@ -46,6 +46,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QForwardRendererPrivate + \internal +*/ QForwardRendererPrivate::QForwardRendererPrivate(QForwardRenderer *qq) : QTechniqueFilterPrivate(qq) , m_viewport(new QViewport()) @@ -91,7 +95,6 @@ void QForwardRendererPrivate::init() */ /*! - \fn Qt3D::QForwardRenderer::QForwardRenderer(QNode *parent) Constructs a new Qt3D::QForwardRenderer instance with parent object \a parent. */ QForwardRenderer::QForwardRenderer(QNode *parent) @@ -104,35 +107,25 @@ QForwardRenderer::QForwardRenderer(QNode *parent) d->init(); } +/*! + Destroys the QForwardRenderer instance. +*/ QForwardRenderer::~QForwardRenderer() { } -/*! - \fn Qt3D::QForwardRenderer::setViewportRect(const QRectF &viewportRect) - Sets the current viewport rect to \a viewportRect. - */ void QForwardRenderer::setViewportRect(const QRectF &viewportRect) { Q_D(QForwardRenderer); d->m_viewport->setRect(viewportRect); } -/*! - \fn Qt3D::QForwardRenderer::setClearColor(const QColor &clearColor) - Sets the clearColor to \a clearColor. - */ void QForwardRenderer::setClearColor(const QColor &clearColor) { Q_D(QForwardRenderer); d->m_viewport->setClearColor(clearColor); } -/*! - \fn Qt3D::QForwardRenderer::setCamera(QEntity *camera) - Sets the camera which should be used to render the scene to \a camera. - \b {Note:} A camera is a QEntity having a QCameraLens has one of its components - */ void QForwardRenderer::setCamera(QEntity *camera) { Q_D(QForwardRenderer); @@ -140,8 +133,9 @@ void QForwardRenderer::setCamera(QEntity *camera) } /*! - \fn Qt3D::QForwardRenderer::viewportRect() const - \return the current viewport rect. + \property Qt3D::QForwardRenderer::viewportRect + + Holds the current viewport rect. */ QRectF QForwardRenderer::viewportRect() const { @@ -150,8 +144,8 @@ QRectF QForwardRenderer::viewportRect() const } /*! - \fn Qt3D::QForwardRenderer::clearColor() const - \return the current clearColor. + \property Qt3D::QForwardRenderer::clearColor + Holds the current clearColor. */ QColor QForwardRenderer::clearColor() const { @@ -160,8 +154,10 @@ QColor QForwardRenderer::clearColor() const } /*! - \fn Qt3D::QForwardRenderer::camera() const - \return the current QEntity camera used to render the scene. + \property Qt3D::QForwardRenderer::camera + Holds the current QEntity camera used to render the scene. + + \note A camera is a QEntity that has a QCameraLens as one of its components. */ QEntity *QForwardRenderer::camera() const { diff --git a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp index 4f94893bc..09b2f951a 100644 --- a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp +++ b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp @@ -56,6 +56,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QNormalDiffuseMapAlphaMaterialPrivate + \internal +*/ QNormalDiffuseMapAlphaMaterialPrivate::QNormalDiffuseMapAlphaMaterialPrivate(QNormalDiffuseMapAlphaMaterial *qq) : QNormalDiffuseMapMaterialPrivate(qq) , m_alphaCoverage(new QAlphaCoverage()) @@ -143,7 +147,6 @@ void QNormalDiffuseMapAlphaMaterialPrivate::init() */ /*! - \fn Qt3D::QNormalDiffuseMapAlphaMaterial::QNormalDiffuseMapAlphaMaterial() Constructs a new Qt3D::QNormalDiffuseMapAlphaMaterial instance with parent object \a parent. */ QNormalDiffuseMapAlphaMaterial::QNormalDiffuseMapAlphaMaterial(QNode *parent) @@ -151,6 +154,9 @@ QNormalDiffuseMapAlphaMaterial::QNormalDiffuseMapAlphaMaterial(QNode *parent) { } +/*! + Destroys the QNormalDiffuseMapAlphaMaterial instance. +*/ QNormalDiffuseMapAlphaMaterial::~QNormalDiffuseMapAlphaMaterial() { } diff --git a/src/render/defaults/qnormaldiffusemapmaterial.cpp b/src/render/defaults/qnormaldiffusemapmaterial.cpp index ce5565020..01de6f4d5 100644 --- a/src/render/defaults/qnormaldiffusemapmaterial.cpp +++ b/src/render/defaults/qnormaldiffusemapmaterial.cpp @@ -53,6 +53,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QNormalDiffuseMapMaterialPrivate + \internal +*/ QNormalDiffuseMapMaterialPrivate::QNormalDiffuseMapMaterialPrivate(QNormalDiffuseMapMaterial *qq) : QMaterialPrivate(qq) , m_normalDiffuseEffect(new QEffect()) @@ -155,7 +159,6 @@ void QNormalDiffuseMapMaterialPrivate::init() */ /*! - \fn Qt3D::QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial() Constructs a new Qt3D::QNormalDiffuseMapMaterial instance with parent object \a parent. */ QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial(QNode *parent) @@ -171,6 +174,7 @@ QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial(QNode *parent) d->init(); } +/*! \internal */ QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial(QNormalDiffuseMapMaterialPrivate &dd, QNode *parent) : QMaterial(dd, parent) { @@ -184,13 +188,16 @@ QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial(QNormalDiffuseMapMaterialPr d->init(); } +/*! + Destroys the QNormalDiffuseMapMaterial instance. +*/ QNormalDiffuseMapMaterial::~QNormalDiffuseMapMaterial() { } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::ambient() const - \return the current QColor ambient value. + \property Qt3D::QNormalDiffuseMapMaterial::ambient + Holds the current ambient color. */ QColor QNormalDiffuseMapMaterial::ambient() const { @@ -199,8 +206,8 @@ QColor QNormalDiffuseMapMaterial::ambient() const } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::specular() const - \return the current QColor specular value. + \property Qt3D::QNormalDiffuseMapMaterial::specular + Holds the current specular color. */ QColor QNormalDiffuseMapMaterial::specular() const { @@ -209,12 +216,18 @@ QColor QNormalDiffuseMapMaterial::specular() const } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::diffuse() const - \return the current diffuse map texture. - \b {Note:} By default the diffuse texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QNormalDiffuseMapMaterial::diffuse + + Holds the current diffuse map texture. + + By default, the diffuse texture has these properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap modeM + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QNormalDiffuseMapMaterial::diffuse() const { @@ -223,11 +236,17 @@ QAbstractTextureProvider *QNormalDiffuseMapMaterial::diffuse() const } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::normal() const - \return the current normal map texture. - \b {Note:} By default the normal texture has linear minification - and magnification filters, the wrap mode is repeat and maximum anisotropy - is set to 16.0. + \property Qt3D::QNormalDiffuseMapMaterial::normal + + Holds the current normal map texture. + + By default, the normal texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QNormalDiffuseMapMaterial::normal() const { @@ -236,8 +255,9 @@ QAbstractTextureProvider *QNormalDiffuseMapMaterial::normal() const } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::shininess() const - \return the current shininess as a float value. + \property Qt3D::QNormalDiffuseMapMaterial::shininess + + Holds the current shininess as a float value. */ float QNormalDiffuseMapMaterial::shininess() const { @@ -246,8 +266,9 @@ float QNormalDiffuseMapMaterial::shininess() const } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::textureScale() const - \return the current texture scale. + \property Qt3D::QNormalDiffuseMapMaterial::textureScale + + Holds the current texture scale as a float value. */ float QNormalDiffuseMapMaterial::textureScale() const { @@ -255,60 +276,36 @@ float QNormalDiffuseMapMaterial::textureScale() const return d->m_textureScaleParameter->value().toFloat(); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setAmbient(const QColor &ambient) - Sets the current ambient color to \a ambient - */ void QNormalDiffuseMapMaterial::setAmbient(const QColor &ambient) { Q_D(QNormalDiffuseMapMaterial); d->m_ambientParameter->setValue(ambient); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setSpecular(const QColor &specular) - Sets the current specular color to \a specular. - */ void QNormalDiffuseMapMaterial::setSpecular(const QColor &specular) { Q_D(QNormalDiffuseMapMaterial); d->m_specularParameter->setValue(specular); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setDiffuse(QTexture *diffuse) - Sets the current diffuse map to \a diffuse. - */ void QNormalDiffuseMapMaterial::setDiffuse(QAbstractTextureProvider *diffuse) { Q_D(QNormalDiffuseMapMaterial); d->m_diffuseParameter->setValue(QVariant::fromValue(diffuse)); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setNormal(QTexture *normal) - Sets the current normal map to \a normal. - */ void QNormalDiffuseMapMaterial::setNormal(QAbstractTextureProvider *normal) { Q_D(QNormalDiffuseMapMaterial); d->m_normalParameter->setValue(QVariant::fromValue(normal)); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setShininess(float shininess) - Sets the current shininess value to \a shininess. - */ void QNormalDiffuseMapMaterial::setShininess(float shininess) { Q_D(QNormalDiffuseMapMaterial); d->m_shininessParameter->setValue(shininess); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setTextureScale(float textureScale) - Sets the current texture scale to \a textureScale. - */ void QNormalDiffuseMapMaterial::setTextureScale(float textureScale) { Q_D(QNormalDiffuseMapMaterial); diff --git a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp index 9a9342db3..8f7441b9f 100644 --- a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp +++ b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp @@ -52,6 +52,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QNormalDiffuseSpecularMapMaterialPrivate + \internal +*/ QNormalDiffuseSpecularMapMaterialPrivate::QNormalDiffuseSpecularMapMaterialPrivate(QNormalDiffuseSpecularMapMaterial *qq) : QMaterialPrivate(qq) , m_normalDiffuseSpecularEffect(new QEffect()) @@ -161,7 +165,6 @@ void QNormalDiffuseSpecularMapMaterialPrivate::init() */ /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial() Constructs a new Qt3D::QNormalDiffuseSpecularMapMaterial instance with parent object \a parent. */ QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial(QNode *parent) @@ -177,7 +180,7 @@ QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial(QNode *pare d->init(); } - +/*! \internal */ QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial(QNormalDiffuseSpecularMapMaterialPrivate &dd, QNode *parent) : QMaterial(dd, parent) { @@ -191,13 +194,16 @@ QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial(QNormalDiff d->init(); } +/*! + Destroys the Qt3D::QNormalDiffuseSpecularMapMaterial instance. +*/ QNormalDiffuseSpecularMapMaterial::~QNormalDiffuseSpecularMapMaterial() { } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::ambient() const - \return the current QColor ambient value. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::ambient + Holds the current ambient color. */ QColor QNormalDiffuseSpecularMapMaterial::ambient() const { @@ -206,12 +212,18 @@ QColor QNormalDiffuseSpecularMapMaterial::ambient() const } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::diffuse() const - \return the current diffuse map texture. - \b {Note:} By default the diffuse texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::diffuse + + Holds the current diffuse map texture. + + By default, the diffuse texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::diffuse() const { @@ -220,11 +232,17 @@ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::diffuse() const } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::normal() const - \return the current normal map texture. - \b {Note:} By default the normal texture has linear minification - and magnification filters, the wrap mode is repeat and maximum anisotropy - is set to 16.0. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::normal + + Holds the current normal map texture. + + By default, the normal texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::normal() const { @@ -233,12 +251,18 @@ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::normal() const } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::specular() const - \return the current specular map texture. - \b {Note:} By default the specular texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::specular + + Holds the current specular map texture. + + By default, the specular texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::specular() const { @@ -247,8 +271,9 @@ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::specular() const } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::shininess() const - \return the current shininess as a float value. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::shininess + + Holds the current shininess as a float value. */ float QNormalDiffuseSpecularMapMaterial::shininess() const { @@ -257,8 +282,9 @@ float QNormalDiffuseSpecularMapMaterial::shininess() const } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::textureScale() const - \return the current texture scale. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::textureScale + + Holds the current texture scale as a float value. */ float QNormalDiffuseSpecularMapMaterial::textureScale() const { @@ -266,60 +292,36 @@ float QNormalDiffuseSpecularMapMaterial::textureScale() const return d->m_textureScaleParameter->value().toFloat(); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setAmbient(const QColor &ambient) - Sets the current ambient color to \a ambient - */ void QNormalDiffuseSpecularMapMaterial::setAmbient(const QColor &ambient) { Q_D(QNormalDiffuseSpecularMapMaterial); d->m_ambientParameter->setValue(ambient); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setDiffuse(QTexture *diffuse) - Sets the current diffuse map to \a diffuse. - */ void QNormalDiffuseSpecularMapMaterial::setDiffuse(QAbstractTextureProvider *diffuse) { Q_D(QNormalDiffuseSpecularMapMaterial); d->m_diffuseParameter->setValue(QVariant::fromValue(diffuse)); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setNormal(QTexture *normal) - Sets the current normal map to \a normal. - */ void QNormalDiffuseSpecularMapMaterial::setNormal(QAbstractTextureProvider *normal) { Q_D(QNormalDiffuseSpecularMapMaterial); d->m_normalParameter->setValue(QVariant::fromValue(normal)); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setSpecular(QTexture *specular) - Sets the current specular map to \a specular. - */ void QNormalDiffuseSpecularMapMaterial::setSpecular(QAbstractTextureProvider *specular) { Q_D(QNormalDiffuseSpecularMapMaterial); d->m_specularParameter->setValue(QVariant::fromValue(specular)); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setShininess(float shininess) - Sets the current shininess value to \a shininess. - */ void QNormalDiffuseSpecularMapMaterial::setShininess(float shininess) { Q_D(QNormalDiffuseSpecularMapMaterial); d->m_shininessParameter->setValue(shininess); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setTextureScale(float textureScale) - Sets the current texture scale to \a textureScale. - */ void QNormalDiffuseSpecularMapMaterial::setTextureScale(float textureScale) { Q_D(QNormalDiffuseSpecularMapMaterial); diff --git a/src/render/defaults/qpervertexcolormaterial.cpp b/src/render/defaults/qpervertexcolormaterial.cpp index e2bc66f86..a3191f6b9 100644 --- a/src/render/defaults/qpervertexcolormaterial.cpp +++ b/src/render/defaults/qpervertexcolormaterial.cpp @@ -51,6 +51,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QPerVertexColorMaterialPrivate + \internal +*/ QPerVertexColorMaterialPrivate::QPerVertexColorMaterialPrivate(QPerVertexColorMaterial *qq) : QMaterialPrivate(qq) , m_vertexEffect(new QEffect()) diff --git a/src/render/defaults/qphongmaterial.cpp b/src/render/defaults/qphongmaterial.cpp index a6e336776..68023e3a1 100644 --- a/src/render/defaults/qphongmaterial.cpp +++ b/src/render/defaults/qphongmaterial.cpp @@ -51,6 +51,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QPhongMaterialPrivate + \internal +*/ QPhongMaterialPrivate::QPhongMaterialPrivate(QPhongMaterial *qq) : QMaterialPrivate(qq) , m_phongEffect(new QEffect()) @@ -110,16 +114,16 @@ QPhongMaterial::QPhongMaterial(QNode *parent) /*! \fn Qt3D::QPhongMaterial::~QPhongMaterial() - Destroys the QPhongMaterial + Destroys the QPhongMaterial. */ QPhongMaterial::~QPhongMaterial() { } /*! - \fn QColor Qt3D::QPhongMaterial::ambient() const + \property Qt3D::QPhongMaterial::ambient - Returns the ambient color. + Holds the ambient color. */ QColor QPhongMaterial::ambient() const { @@ -128,9 +132,9 @@ QColor QPhongMaterial::ambient() const } /*! - \fn QColor Qt3D::QPhongMaterial::diffuse() const + \property Qt3D::QPhongMaterial::diffuse - Returns the diffuse color. + Holds the diffuse color. */ QColor QPhongMaterial::diffuse() const { @@ -139,9 +143,9 @@ QColor QPhongMaterial::diffuse() const } /*! - \fn QColor Qt3D::QPhongMaterial::specular() const + \property QColor Qt3D::QPhongMaterial::specular - Returns the specular color. + Holds the specular color. */ QColor QPhongMaterial::specular() const { @@ -150,9 +154,9 @@ QColor QPhongMaterial::specular() const } /*! - \fn Qt3D::QPhongMaterial::shininess() const + \property Qt3D::QPhongMaterial::shininess - Returns the shininess exponent. + Holds the shininess exponent. */ float QPhongMaterial::shininess() const { @@ -160,44 +164,24 @@ float QPhongMaterial::shininess() const return d->m_shininessParameter->value().toFloat(); } -/*! - \fn Qt3D::QPhongMaterial::setAmbient(const QColor &ambient) - - Sets the current ambient color to \a ambient. -*/ void QPhongMaterial::setAmbient(const QColor &ambient) { Q_D(QPhongMaterial); d->m_shininessParameter->setValue(ambient); } -/*! - \fn Qt3D::QPhongMaterial::setDiffuse(const QColor &diffuse) - - Sets the current diffuse color to \a diffuse. -*/ void QPhongMaterial::setDiffuse(const QColor &diffuse) { Q_D(QPhongMaterial); d->m_diffuseParameter->setValue(diffuse); } -/*! - \fn Qt3D::QPhongMaterial::setSpecular(const QColor &specular) - - Sets the current specular color to \a specular. -*/ void QPhongMaterial::setSpecular(const QColor &specular) { Q_D(QPhongMaterial); d->m_specularParameter->setValue(specular); } -/*! - \fn Qt3D::QPhongMaterial::setShininess(float shininess) - - Sets the current shininess exponent to \a shininess. -*/ void QPhongMaterial::setShininess(float shininess) { Q_D(QPhongMaterial); |