summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2015-02-06 14:17:50 +0100
committerNico Vertriest <nico.vertriest@digia.com>2015-03-11 13:52:10 +0000
commit462dd4fa9dc03a65f5c680f6eae2db623d2fe19e (patch)
tree7817ca7391dffcd3011579973d2ae9b0abfc7cef /src
parentcb7753f3ffa85eed0fbd98cb2e4f0e453c595d6d (diff)
Doc: link and qdoc errors Qt3D
Task-number: QTBUG-44180 Change-Id: Ic798dee5d33dbf18dbc9d978a0f07217895a30ee Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/core/doc/qt3dcore.qdocconf2
-rw-r--r--src/core/nodes/qcomponent.cpp6
-rw-r--r--src/core/qchangearbiter.cpp2
-rw-r--r--src/core/resources/qresourcemanager.cpp2
-rw-r--r--src/core/services/qservicelocator.cpp7
-rw-r--r--src/render/backend/jobs/renderviewjobutils.cpp4
-rw-r--r--src/render/defaults/qdiffusemapmaterial.cpp51
-rw-r--r--src/render/defaults/qdiffusespecularmapmaterial.cpp57
-rw-r--r--src/render/defaults/qforwardrenderer.cpp31
-rw-r--r--src/render/defaults/qnormaldiffusemapalphamaterial.cpp2
-rw-r--r--src/render/defaults/qnormaldiffusemapmaterial.cpp61
-rw-r--r--src/render/defaults/qnormaldiffusespecularmapmaterial.cpp64
-rw-r--r--src/render/doc/qt3drender.qdocconf4
-rw-r--r--src/render/frontend/framegraph-components/qframegraph.cpp5
-rw-r--r--src/render/frontend/framegraph-components/qframegraphnode.cpp3
-rw-r--r--src/render/frontend/framegraph-components/qframegraphselector.cpp4
16 files changed, 120 insertions, 185 deletions
diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf
index 66833ef97..609a16073 100644
--- a/src/core/doc/qt3dcore.qdocconf
+++ b/src/core/doc/qt3dcore.qdocconf
@@ -26,7 +26,7 @@ qhp.Qt3DCore.subprojects.classes.sortPages = true
tagfile = ../../../doc/qt3dcore/qt3dcore.tags
-depends += qtcore qtqml qtquick qtdoc
+depends += qtcore qtqml qtquick qtdoc qtwidgets qtgui
headerdirs += ..
sourcedirs += ..
diff --git a/src/core/nodes/qcomponent.cpp b/src/core/nodes/qcomponent.cpp
index e684bdb10..da4b38799 100644
--- a/src/core/nodes/qcomponent.cpp
+++ b/src/core/nodes/qcomponent.cpp
@@ -100,7 +100,7 @@ QComponent::~QComponent()
}
/*!
- \return whether the QComponent is shareable across entities or not.
+ Returns whether the QComponent is shareable across entities or not.
*/
bool QComponent::shareable() const
{
@@ -109,7 +109,7 @@ bool QComponent::shareable() const
}
/*!
- \returns whether the QComponent is enabled or not.
+ Returns whether the QComponent is enabled or not.
*/
bool QComponent::isEnabled() const
{
@@ -155,7 +155,7 @@ void QComponent::copy(const QNode *ref)
}
/*!
- * \return a QVector containing all the entities that reference this component.
+ * Returns a QVector containing all the entities that reference this component.
*/
QVector<QEntity *> QComponent::entities() const
{
diff --git a/src/core/qchangearbiter.cpp b/src/core/qchangearbiter.cpp
index 86ddc7d72..1e2fa1284 100644
--- a/src/core/qchangearbiter.cpp
+++ b/src/core/qchangearbiter.cpp
@@ -58,7 +58,7 @@ namespace Qt3D {
\brief Act as a messages router between observables and observers.
- Observables can be of two types: QNode observables and QObservableInterfaces.
+ Observables can be of two types: QNode observables and \l {QObservableInterface}s.
QNode notifications are sent from the frontend QNode and delivered to the backend observers.
QObservableInterface notifications are sent from backend nodes to backend observers and/or to the
registered QPostman, which in turn delivers the notifications to the target frontend QNode.
diff --git a/src/core/resources/qresourcemanager.cpp b/src/core/resources/qresourcemanager.cpp
index ed6cf4601..c425650b2 100644
--- a/src/core/resources/qresourcemanager.cpp
+++ b/src/core/resources/qresourcemanager.cpp
@@ -51,7 +51,7 @@
Internally, memory can be reorganized for best performance while being transparent to the user.
The memory allocation scheme and locking policies can be customized by providing template
- parameters. The defaults are ArrayAllocationPolicy and NonLockingPolicy respectively.
+ parameters. The defaults are ArrayAllocatingPolicy and NonLockingPolicy respectively.
*/
/*!
diff --git a/src/core/services/qservicelocator.cpp b/src/core/services/qservicelocator.cpp
index a98ae16d2..65421f69f 100644
--- a/src/core/services/qservicelocator.cpp
+++ b/src/core/services/qservicelocator.cpp
@@ -127,7 +127,7 @@ QServiceLocator::~QServiceLocator()
existing provider for this service. The service provider does not take ownership
of the provider.
- \sa unregisterService(), serviceCount(), service()
+ \sa unregisterServiceProvider(), serviceCount(), service()
*/
void QServiceLocator::registerServiceProvider(int serviceType, QAbstractServiceProvider *provider)
{
@@ -139,6 +139,8 @@ void QServiceLocator::registerServiceProvider(int serviceType, QAbstractServiceP
/*!
Unregisters any existing provider for the \a serviceType.
+
+ \sa registerServiceProvider()
*/
void QServiceLocator::unregisterServiceProvider(int serviceType)
{
@@ -164,7 +166,8 @@ int QServiceLocator::serviceCount() const
has been explicitly registered, this returns a null pointer for non-Qt3D provided
default services and a null pointer for non-default services.
- \sa registerService()
+ \sa registerServiceProvider()
+
*/
/*!
diff --git a/src/render/backend/jobs/renderviewjobutils.cpp b/src/render/backend/jobs/renderviewjobutils.cpp
index 62d9f2202..5827dd88e 100644
--- a/src/render/backend/jobs/renderviewjobutils.cpp
+++ b/src/render/backend/jobs/renderviewjobutils.cpp
@@ -60,8 +60,8 @@ namespace Render {
/*!
\internal
- Walks up the framegraph tree from \p fgLeaf and builds up as much state
- as possible and populates \p rv. For cases where we can't get the specific state
+ Walks up the framegraph tree from \a fgLeaf and builds up as much state
+ as possible and populates \a rv. For cases where we can't get the specific state
(e.g. because it depends upon more than just the framegraph) we store the data from
the framegraph that will be needed to later when the rest of the data becomes available
*/
diff --git a/src/render/defaults/qdiffusemapmaterial.cpp b/src/render/defaults/qdiffusemapmaterial.cpp
index 63612b6c4..16da18cd9 100644
--- a/src/render/defaults/qdiffusemapmaterial.cpp
+++ b/src/render/defaults/qdiffusemapmaterial.cpp
@@ -146,10 +146,8 @@ void QDiffuseMapMaterialPrivate::init()
*/
/*!
- \fn Qt3D::QDiffuseMapMaterial::QDiffuseMapMaterial()
Constructs a new Qt3D::QDiffuseMapMaterial instance with parent object \a parent.
*/
-
QDiffuseMapMaterial::QDiffuseMapMaterial(QNode *parent)
: QMaterial(*new QDiffuseMapMaterialPrivate(this), parent)
{
@@ -167,9 +165,11 @@ QDiffuseMapMaterial::~QDiffuseMapMaterial()
}
/*!
- \fn Qt3D::QDiffuseMapMaterial::ambient() const
- \return the current QColor ambient value.
+ \property Qt3D::QDiffuseMapMaterial::ambient
+
+ Holds the current QColor ambient value.
*/
+
QColor QDiffuseMapMaterial::ambient() const
{
Q_D(const QDiffuseMapMaterial);
@@ -177,8 +177,9 @@ QColor QDiffuseMapMaterial::ambient() const
}
/*!
- \fn Qt3D::QDiffuseMapMaterial::specular() const
- \return the current QColor specular value.
+ \property QDiffuseMapMaterial::specular
+
+ Holds the current QColor specular value.
*/
QColor QDiffuseMapMaterial::specular() const
{
@@ -187,8 +188,9 @@ QColor QDiffuseMapMaterial::specular() const
}
/*!
- \fn Qt3D::QDiffuseMapMaterial::shininess() const
- \return the current shininess as a float value.
+ \property QDiffuseMapMaterial::shininess
+
+ Holds the current shininess as a float value.
*/
float QDiffuseMapMaterial::shininess() const
{
@@ -197,9 +199,11 @@ 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
+ \property QAbstractTextureProvider *QDiffuseMapMaterial::diffuse
+
+ Holds the current QTexture used as the diffuse map.
+
+ \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.
@@ -211,8 +215,9 @@ QAbstractTextureProvider *QDiffuseMapMaterial::diffuse() const
}
/*!
- \fn Qt3D::QDiffuseMapMaterial::textureScale() const
- \return the current texture scale.
+ \property QDiffuseMapMaterial::textureScale
+
+ Holds the current texture scale.
*/
float QDiffuseMapMaterial::textureScale() const
{
@@ -220,50 +225,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 71eefa9d4..16a758e2e 100644
--- a/src/render/defaults/qdiffusespecularmapmaterial.cpp
+++ b/src/render/defaults/qdiffusespecularmapmaterial.cpp
@@ -154,8 +154,7 @@ void QDiffuseSpecularMapMaterialPrivate::init()
*/
/*!
- \fn Qt3D::QDiffuseSpecularMapMaterial::QDiffuseSpecularMapMaterial()
- Constructs a new Qt3D::QDiffuseSpecularMapMaterial instance with parent object \a parent.
+ Constructs a new Qt3D::QDiffuseSpecularMapMaterial instance with parent object \a parent.
*/
QDiffuseSpecularMapMaterial::QDiffuseSpecularMapMaterial(QNode *parent)
: QMaterial(*new QDiffuseSpecularMapMaterialPrivate(this), parent)
@@ -174,9 +173,10 @@ QDiffuseSpecularMapMaterial::~QDiffuseSpecularMapMaterial()
}
/*!
- \fn Qt3D::QDiffuseSpecularMapMaterial::ambient() const
- \return the current QColor ambient value.
- */
+ \property Qt3D::QDiffuseSpecularMapMaterial::ambient
+
+ Holds the current QColor ambient value.
+*/
QColor QDiffuseSpecularMapMaterial::ambient() const
{
Q_D(const QDiffuseSpecularMapMaterial);
@@ -184,9 +184,11 @@ 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
+ \property *QDiffuseSpecularMapMaterial::diffuse
+
+ Holds the current diffuse map texture.
+
+ \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.
@@ -198,9 +200,11 @@ 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
+ \property Qt3D::QDiffuseSpecularMapMaterial::specular
+
+ Holds the current specular map texture.
+
+ \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.
@@ -212,8 +216,10 @@ 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 +228,9 @@ float QDiffuseSpecularMapMaterial::shininess() const
}
/*!
- \fn Qt3D::QDiffuseSpecularMapMaterial::textureScale() const
- \return the current texture scale.
+ \property Qt3D::QDiffuseSpecularMapMaterial::textureScale
+
+ Holds the current texture scale.
*/
float QDiffuseSpecularMapMaterial::textureScale() const
{
@@ -231,50 +238,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..feb8af0ad 100644
--- a/src/render/defaults/qforwardrenderer.cpp
+++ b/src/render/defaults/qforwardrenderer.cpp
@@ -74,7 +74,7 @@ void QForwardRendererPrivate::init()
/*!
\class Qt3D::QForwardRenderer
- \brief The Qt3D::QForwardRenderer provides a default FrameGraph implementation of a forward renderer.
+ \brief The Qt3D::QForwardRenderer provides a default \l {QFrameGraph}{FrameGraph} implementation of a forward renderer.
\inmodule Qt3DRender
\since 5.5
@@ -85,7 +85,7 @@ void QForwardRendererPrivate::init()
This a is a single leaf Framegraph tree which contains a Qt3D::QViewport, a Qt3D::QCameraSelector
and a Qt3D::QClearBuffer.
The Qt3D::QForwardRenderer has a default requirement annotation whose name is "renderingStyle" and value "forward".
- If you need to filter out your techniques, you should do so based on that annocation.
+ If you need to filter out your techniques, you should do so based on that annotation.
By default the viewport occupies the whole screen and the clear color is white.
*/
@@ -108,20 +108,12 @@ 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);
@@ -129,9 +121,9 @@ void QForwardRenderer::setClearColor(const QColor &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
+
+ \note A camera is a QEntity having a QCameraLens as one of its components.
*/
void QForwardRenderer::setCamera(QEntity *camera)
{
@@ -140,8 +132,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 +143,9 @@ 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,9 @@ 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.
*/
QEntity *QForwardRenderer::camera() const
{
diff --git a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp
index 66a78fed6..13d0f1594 100644
--- a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp
+++ b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp
@@ -141,9 +141,7 @@ void QNormalDiffuseMapAlphaMaterialPrivate::init()
This material uses an effect with a single render pass approach and performs per fragment lighting.
Techniques are provided for OpenGL 2, OpenGL 3 or above as well as OpenGL ES 2.
*/
-
/*!
- \fn Qt3D::QNormalDiffuseMapAlphaMaterial::QNormalDiffuseMapAlphaMaterial()
Constructs a new Qt3D::QNormalDiffuseMapAlphaMaterial instance with parent object \a parent.
*/
QNormalDiffuseMapAlphaMaterial::QNormalDiffuseMapAlphaMaterial(QNode *parent)
diff --git a/src/render/defaults/qnormaldiffusemapmaterial.cpp b/src/render/defaults/qnormaldiffusemapmaterial.cpp
index cde3145f9..de1e63579 100644
--- a/src/render/defaults/qnormaldiffusemapmaterial.cpp
+++ b/src/render/defaults/qnormaldiffusemapmaterial.cpp
@@ -155,7 +155,6 @@ void QNormalDiffuseMapMaterialPrivate::init()
*/
/*!
- \fn Qt3D::QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial()
Constructs a new Qt3D::QNormalDiffuseMapMaterial instance with parent object \a parent.
*/
QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial(QNode *parent)
@@ -189,8 +188,9 @@ QNormalDiffuseMapMaterial::~QNormalDiffuseMapMaterial()
}
/*!
- \fn Qt3D::QNormalDiffuseMapMaterial::ambient() const
- \return the current QColor ambient value.
+ \property QNormalDiffuseMapMaterial::ambient
+
+ Holds the current QColor ambient value.
*/
QColor QNormalDiffuseMapMaterial::ambient() const
{
@@ -199,8 +199,9 @@ QColor QNormalDiffuseMapMaterial::ambient() const
}
/*!
- \fn Qt3D::QNormalDiffuseMapMaterial::specular() const
- \return the current QColor specular value.
+ \property QNormalDiffuseMapMaterial::specular
+
+ Holds the current QColor specular value.
*/
QColor QNormalDiffuseMapMaterial::specular() const
{
@@ -209,9 +210,11 @@ 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
+ \property *QNormalDiffuseMapMaterial::diffuse
+
+ Holds the current diffuse map texture.
+
+ \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.
@@ -223,9 +226,11 @@ 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
+ \property *QNormalDiffuseMapMaterial::normal
+
+ Holds the current normal map texture.
+
+ \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.
*/
@@ -236,8 +241,9 @@ QAbstractTextureProvider *QNormalDiffuseMapMaterial::normal() const
}
/*!
- \fn Qt3D::QNormalDiffuseMapMaterial::shininess() const
- \return the current shininess as a float value.
+ \property QNormalDiffuseMapMaterial::shininess
+
+ Holds the current shininess as a float value.
*/
float QNormalDiffuseMapMaterial::shininess() const
{
@@ -246,8 +252,9 @@ float QNormalDiffuseMapMaterial::shininess() const
}
/*!
- \fn Qt3D::QNormalDiffuseMapMaterial::textureScale() const
- \return the current texture scale.
+ \property QNormalDiffuseMapMaterial::textureScale
+
+ Holds the current texture scale.
*/
float QNormalDiffuseMapMaterial::textureScale() const
{
@@ -255,60 +262,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 b37ffa7aa..81e9ccd62 100644
--- a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp
+++ b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp
@@ -161,7 +161,6 @@ void QNormalDiffuseSpecularMapMaterialPrivate::init()
*/
/*!
- \fn Qt3D::QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial()
Constructs a new Qt3D::QNormalDiffuseSpecularMapMaterial instance with parent object \a parent.
*/
QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial(QNode *parent)
@@ -196,8 +195,9 @@ QNormalDiffuseSpecularMapMaterial::~QNormalDiffuseSpecularMapMaterial()
}
/*!
- \fn Qt3D::QNormalDiffuseSpecularMapMaterial::ambient() const
- \return the current QColor ambient value.
+ \property NormalDiffuseSpecularMapMaterial::ambient
+
+ Holds the current QColor ambient value.
*/
QColor QNormalDiffuseSpecularMapMaterial::ambient() const
{
@@ -206,9 +206,11 @@ 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
+ \property *QNormalDiffuseSpecularMapMaterial::diffuse
+
+ Holds the current diffuse map texture.
+
+ \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.
@@ -220,9 +222,11 @@ 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
+ \property QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::normal
+
+ Holds the current normal map texture.
+
+ \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.
*/
@@ -233,9 +237,11 @@ 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
+ \property *QNormalDiffuseSpecularMapMaterial::specular
+
+ Holds the current specular map texture.
+
+ \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.
@@ -247,8 +253,9 @@ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::specular() const
}
/*!
- \fn Qt3D::QNormalDiffuseSpecularMapMaterial::shininess() const
- \return the current shininess as a float value.
+ \property QNormalDiffuseSpecularMapMaterial::shininess
+
+ Holds the current shininess as a float value.
*/
float QNormalDiffuseSpecularMapMaterial::shininess() const
{
@@ -257,8 +264,9 @@ float QNormalDiffuseSpecularMapMaterial::shininess() const
}
/*!
- \fn Qt3D::QNormalDiffuseSpecularMapMaterial::textureScale() const
- \return the current texture scale.
+ \property QNormalDiffuseSpecularMapMaterial::textureScale
+
+ Holds the current texture scale.
*/
float QNormalDiffuseSpecularMapMaterial::textureScale() const
{
@@ -266,60 +274,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/doc/qt3drender.qdocconf b/src/render/doc/qt3drender.qdocconf
index b36800a50..7f42489df 100644
--- a/src/render/doc/qt3drender.qdocconf
+++ b/src/render/doc/qt3drender.qdocconf
@@ -26,7 +26,7 @@ qhp.Qt3DRender.subprojects.classes.sortPages = true
tagfile = ../../../doc/qt3drender/qt3drender.tags
-depends += qtcore qtqml qtquick qt3dcore qtdoc
+depends += qtcore qtqml qtquick qt3dcore qtdoc qtgui
headerdirs += ..
sourcedirs += ..
@@ -36,5 +36,7 @@ exampledirs += src/snippets
imagedirs += images
+Cpp.ignoretokens += QT3DRENDERERSHARED_EXPORT
+
navigation.landingpage = "Qt3D Render"
navigation.cppclassespage = "Qt3D Render C++ Classes"
diff --git a/src/render/frontend/framegraph-components/qframegraph.cpp b/src/render/frontend/framegraph-components/qframegraph.cpp
index 4069b4bdd..0b5482ae5 100644
--- a/src/render/frontend/framegraph-components/qframegraph.cpp
+++ b/src/render/frontend/framegraph-components/qframegraph.cpp
@@ -59,8 +59,8 @@ void QFrameGraph::copy(const QNode *ref)
}
/*!
- * \class FrameGraph
- *
+ * \class Qt3D::QFrameGraph
+ * \inmodule Qt3DRender
* \brief Component that has an activeFrameGraph property that should
* reference the root FrameGraphItem of a frame graph tree. The Entity
* that contains a FrameGraph property defines the rendering method to
@@ -69,7 +69,6 @@ void QFrameGraph::copy(const QNode *ref)
* Note that only a single FrameGraph can be active at any moment.
*
* \since 5.3
- * \namespace Qt3D
*/
QFrameGraph::QFrameGraph(QNode *parent)
diff --git a/src/render/frontend/framegraph-components/qframegraphnode.cpp b/src/render/frontend/framegraph-components/qframegraphnode.cpp
index 5bd45e753..6a70ddb32 100644
--- a/src/render/frontend/framegraph-components/qframegraphnode.cpp
+++ b/src/render/frontend/framegraph-components/qframegraphnode.cpp
@@ -38,7 +38,7 @@
#include "qframegraphnode_p.h"
/*!
- * \class FrameGraphNode
+ * \class Qt3D::QFrameGraphNode
*
* \brief Base class of all FrameGraph configuration nodes.
*
@@ -46,7 +46,6 @@
* but rather through one of its subclasses.
*
* \since 5.3
- * \namespace Qt3D
*/
QT_BEGIN_NAMESPACE
diff --git a/src/render/frontend/framegraph-components/qframegraphselector.cpp b/src/render/frontend/framegraph-components/qframegraphselector.cpp
index 6550543c5..3bd2cc398 100644
--- a/src/render/frontend/framegraph-components/qframegraphselector.cpp
+++ b/src/render/frontend/framegraph-components/qframegraphselector.cpp
@@ -53,7 +53,7 @@ QFrameGraphSelectorPrivate::QFrameGraphSelectorPrivate(QFrameGraphSelector *qq)
the FrameGraph at runtime
The selection is made by executing Qt3D::QFrameGraphSelectorFunctor that will
- return a vector containing the indices of the FrameGraph subtree to be used
+ return a vector containing the indices of the \l {QFrameGraph}{FrameGraph} subtree to be used
for the current frame.
*/
@@ -79,7 +79,7 @@ QFrameGraphSelectorFunctorPtr QFrameGraphSelector::selectionFunctor() const
}
/*!
- Sets the functor \a functor to be used for selecting FrameGrapg subtrees at
+ Sets the functor \a functor to be used for selecting \l {QFrameGraph}{FrameGraph} subtrees at
runtime.
*/
void QFrameGraphSelector::setSelectionFunctor(QFrameGraphSelectorFunctorPtr functor)