summaryrefslogtreecommitdiffstats
path: root/src/render/frontend
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-04-13 12:55:34 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2015-04-14 07:41:11 +0000
commitf03dc3a2599a0f05cded8b984489b89113c7f037 (patch)
tree306902e9865550448dcf035ffa18c0be45834e62 /src/render/frontend
parent075c0298d1c75dd2d61849b559edcb357d638689 (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/frontend')
-rw-r--r--src/render/frontend/framegraph-components/qcameraselector.cpp9
-rw-r--r--src/render/frontend/framegraph-components/qclearbuffer.cpp5
-rw-r--r--src/render/frontend/framegraph-components/qframegraph.cpp15
-rw-r--r--src/render/frontend/framegraph-components/qframegraphnode.cpp14
-rw-r--r--src/render/frontend/framegraph-components/qframegraphselector.cpp4
-rw-r--r--src/render/frontend/framegraph-components/qlayerfilter.cpp5
-rw-r--r--src/render/frontend/framegraph-components/qrenderpassfilter.cpp6
-rw-r--r--src/render/frontend/framegraph-components/qrendertargetselector.cpp5
-rw-r--r--src/render/frontend/framegraph-components/qsortcriterion.cpp5
-rw-r--r--src/render/frontend/framegraph-components/qsortmethod.cpp5
-rw-r--r--src/render/frontend/framegraph-components/qtechniquefilter.cpp5
-rw-r--r--src/render/frontend/framegraph-components/qviewport.cpp5
-rw-r--r--src/render/frontend/qabstractlight.cpp29
-rw-r--r--src/render/frontend/qabstractmesh.cpp8
-rw-r--r--src/render/frontend/qabstractsceneloader.cpp5
-rw-r--r--src/render/frontend/qabstracttextureimage.cpp37
-rw-r--r--src/render/frontend/qabstracttextureprovider.cpp125
-rw-r--r--src/render/frontend/qannotation.cpp4
-rw-r--r--src/render/frontend/qcolormask.cpp37
-rw-r--r--src/render/frontend/qcuboidmesh.cpp5
-rw-r--r--src/render/frontend/qdirectionallight.cpp5
-rw-r--r--src/render/frontend/qeffect.cpp7
-rw-r--r--src/render/frontend/qlayer.cpp5
-rw-r--r--src/render/frontend/qmaterial.cpp15
-rw-r--r--src/render/frontend/qmesh.cpp5
-rw-r--r--src/render/frontend/qparameter.cpp5
-rw-r--r--src/render/frontend/qparametermapping.cpp5
-rw-r--r--src/render/frontend/qplanemesh.cpp5
-rw-r--r--src/render/frontend/qpointlight.cpp5
-rw-r--r--src/render/frontend/qrenderattachment.cpp5
-rw-r--r--src/render/frontend/qrenderpass.cpp5
-rw-r--r--src/render/frontend/qrenderstate.cpp5
-rw-r--r--src/render/frontend/qrendertarget.cpp5
-rw-r--r--src/render/frontend/qshaderdata.cpp15
-rw-r--r--src/render/frontend/qshaderprogram.cpp5
-rw-r--r--src/render/frontend/qspotlight.cpp5
-rw-r--r--src/render/frontend/qtechnique.cpp7
-rw-r--r--src/render/frontend/qtextureimage.cpp6
-rw-r--r--src/render/frontend/qwrapmode.cpp4
39 files changed, 316 insertions, 136 deletions
diff --git a/src/render/frontend/framegraph-components/qcameraselector.cpp b/src/render/frontend/framegraph-components/qcameraselector.cpp
index acd6711a2..e679d6b8f 100644
--- a/src/render/frontend/framegraph-components/qcameraselector.cpp
+++ b/src/render/frontend/framegraph-components/qcameraselector.cpp
@@ -44,11 +44,20 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::CameraSelector
+*/
+
+/*! \internal */
QCameraSelector::QCameraSelector(QCameraSelectorPrivate &dd, QNode *parent)
: QFrameGraphNode(dd, parent)
{
}
+/*!
+ \class Qt3D::QCameraSelectorPrivate
+ \internal
+*/
QCameraSelectorPrivate::QCameraSelectorPrivate(Qt3D::QCameraSelector *qq)
: QFrameGraphNodePrivate(qq)
, m_camera(Q_NULLPTR)
diff --git a/src/render/frontend/framegraph-components/qclearbuffer.cpp b/src/render/frontend/framegraph-components/qclearbuffer.cpp
index 48df3b945..41a069551 100644
--- a/src/render/frontend/framegraph-components/qclearbuffer.cpp
+++ b/src/render/frontend/framegraph-components/qclearbuffer.cpp
@@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QClearBufferPrivate
+ \internal
+*/
QClearBufferPrivate::QClearBufferPrivate(QClearBuffer *qq)
: QFrameGraphNodePrivate(qq)
, m_buffersType(QClearBuffer::None)
@@ -63,6 +67,7 @@ QClearBuffer::QClearBuffer(QNode *parent)
{
}
+/*! \internal */
QClearBuffer::QClearBuffer(QClearBufferPrivate &dd, QNode *parent)
: QFrameGraphNode(dd, parent)
{
diff --git a/src/render/frontend/framegraph-components/qframegraph.cpp b/src/render/frontend/framegraph-components/qframegraph.cpp
index 4069b4bdd..4f44703b0 100644
--- a/src/render/frontend/framegraph-components/qframegraph.cpp
+++ b/src/render/frontend/framegraph-components/qframegraph.cpp
@@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QFrameGraphPrivate
+ \internal
+*/
QFrameGraphPrivate::QFrameGraphPrivate(QFrameGraph *qq)
: QComponentPrivate(qq)
, m_activeFrameGraph(Q_NULLPTR)
@@ -59,7 +63,7 @@ void QFrameGraph::copy(const QNode *ref)
}
/*!
- * \class FrameGraph
+ * \class Qt3D::FrameGraph
*
* \brief Component that has an activeFrameGraph property that should
* reference the root FrameGraphItem of a frame graph tree. The Entity
@@ -69,7 +73,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)
@@ -77,13 +80,16 @@ QFrameGraph::QFrameGraph(QNode *parent)
{
}
+/*! \internal */
QFrameGraph::QFrameGraph(QFrameGraphPrivate &dd, QNode *parent)
: QComponent(dd, parent)
{
}
/*!
- * Returns the current activeFrameGraph root node.
+ * \property Qt3D::QFrameGraph::activeFrameGraph
+ *
+ * Holds the current activeFrameGraph root node.
*/
QFrameGraphNode *QFrameGraph::activeFrameGraph() const
{
@@ -91,9 +97,6 @@ QFrameGraphNode *QFrameGraph::activeFrameGraph() const
return d->m_activeFrameGraph;
}
-/*!
- * Sets the root node \a activeFrameGraph of the FrameGraph.
- */
void QFrameGraph::setActiveFrameGraph(QFrameGraphNode *activeFrameGraph)
{
Q_D(QFrameGraph);
diff --git a/src/render/frontend/framegraph-components/qframegraphnode.cpp b/src/render/frontend/framegraph-components/qframegraphnode.cpp
index 5bd45e753..7bf379b4b 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::FrameGraphNode
*
* \brief Base class of all FrameGraph configuration nodes.
*
@@ -46,13 +46,16 @@
* but rather through one of its subclasses.
*
* \since 5.3
- * \namespace Qt3D
*/
QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QFrameGraphNodePrivate
+ \internal
+*/
QFrameGraphNodePrivate::QFrameGraphNodePrivate(QFrameGraphNode *qq)
: QNodePrivate(qq)
, m_enabled(true)
@@ -69,6 +72,7 @@ QFrameGraphNode::QFrameGraphNode(QNode *parent)
{
}
+/*! \internal */
QFrameGraphNode::QFrameGraphNode(QFrameGraphNodePrivate &dd, QNode *parent)
: QNode(dd, parent)
{
@@ -98,6 +102,12 @@ QList<QFrameGraphNode *> QFrameGraphNode::frameGraphChildren() const
return d->m_fgChildren;
}
+/*!
+ \property Qt3D::QFrameGraphNode::enabled
+
+ Holds whether the frame graph node is enabled or disabled.
+*/
+
bool QFrameGraphNode::isEnabled() const
{
Q_D(const QFrameGraphNode);
diff --git a/src/render/frontend/framegraph-components/qframegraphselector.cpp b/src/render/frontend/framegraph-components/qframegraphselector.cpp
index 6550543c5..84f88dff7 100644
--- a/src/render/frontend/framegraph-components/qframegraphselector.cpp
+++ b/src/render/frontend/framegraph-components/qframegraphselector.cpp
@@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QFrameGraphSelectorPrivate
+ \internal
+*/
QFrameGraphSelectorPrivate::QFrameGraphSelectorPrivate(QFrameGraphSelector *qq)
: QFrameGraphNodePrivate(qq)
{
diff --git a/src/render/frontend/framegraph-components/qlayerfilter.cpp b/src/render/frontend/framegraph-components/qlayerfilter.cpp
index 9ba19cd7e..838aca131 100644
--- a/src/render/frontend/framegraph-components/qlayerfilter.cpp
+++ b/src/render/frontend/framegraph-components/qlayerfilter.cpp
@@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QLayerFilterPrivate
+ \internal
+*/
QLayerFilterPrivate::QLayerFilterPrivate(QLayerFilter *qq)
: QFrameGraphNodePrivate(qq)
{
@@ -61,6 +65,7 @@ QLayerFilter::QLayerFilter(QNode *parent)
{
}
+/*! \internal */
QLayerFilter::QLayerFilter(QLayerFilterPrivate &dd, QNode *parent)
: QFrameGraphNode(dd, parent)
{
diff --git a/src/render/frontend/framegraph-components/qrenderpassfilter.cpp b/src/render/frontend/framegraph-components/qrenderpassfilter.cpp
index 5f22b90f2..442233f0c 100644
--- a/src/render/frontend/framegraph-components/qrenderpassfilter.cpp
+++ b/src/render/frontend/framegraph-components/qrenderpassfilter.cpp
@@ -44,10 +44,16 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QRenderPassFilterPrivate
+ \internal
+*/
+
QRenderPassFilter::QRenderPassFilter(QNode *parent)
: QFrameGraphNode(*new QRenderPassFilterPrivate(this), parent)
{}
+/*! \internal */
QRenderPassFilter::QRenderPassFilter(QRenderPassFilterPrivate &dd, QNode *parent)
: QFrameGraphNode(dd, parent)
{
diff --git a/src/render/frontend/framegraph-components/qrendertargetselector.cpp b/src/render/frontend/framegraph-components/qrendertargetselector.cpp
index ff250b4e2..3307d4879 100644
--- a/src/render/frontend/framegraph-components/qrendertargetselector.cpp
+++ b/src/render/frontend/framegraph-components/qrendertargetselector.cpp
@@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QRenderTargetSelectorPrivate
+ \internal
+*/
QRenderTargetSelectorPrivate::QRenderTargetSelectorPrivate(QRenderTargetSelector *qq)
: QFrameGraphNodePrivate(qq)
, m_target(Q_NULLPTR)
@@ -86,6 +90,7 @@ QRenderTarget *QRenderTargetSelector::target() const
return d->m_target;
}
+/*! \internal */
QRenderTargetSelector::QRenderTargetSelector(QRenderTargetSelectorPrivate &dd, QNode *parent)
: QFrameGraphNode(dd, parent)
{
diff --git a/src/render/frontend/framegraph-components/qsortcriterion.cpp b/src/render/frontend/framegraph-components/qsortcriterion.cpp
index f7381ec6d..631a9e595 100644
--- a/src/render/frontend/framegraph-components/qsortcriterion.cpp
+++ b/src/render/frontend/framegraph-components/qsortcriterion.cpp
@@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QSortCriterionPrivate
+ \internal
+*/
QSortCriterionPrivate::QSortCriterionPrivate(QSortCriterion *qq)
: QNodePrivate(qq)
, m_sort(QSortCriterion::StateChangeCost)
@@ -76,6 +80,7 @@ void QSortCriterion::setSort(QSortCriterion::SortType &sort)
}
}
+/*! \internal */
QSortCriterion::QSortCriterion(QSortCriterionPrivate &dd, QNode *parent)
: QNode(dd, parent)
{
diff --git a/src/render/frontend/framegraph-components/qsortmethod.cpp b/src/render/frontend/framegraph-components/qsortmethod.cpp
index 08725b6f6..f778e33a3 100644
--- a/src/render/frontend/framegraph-components/qsortmethod.cpp
+++ b/src/render/frontend/framegraph-components/qsortmethod.cpp
@@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QSortMethodPrivate
+ \internal
+*/
QSortMethodPrivate::QSortMethodPrivate(QSortMethod *qq)
: QFrameGraphNodePrivate(qq)
{
@@ -62,6 +66,7 @@ QSortMethod::QSortMethod(QNode *parent)
{
}
+/*! \internal */
QSortMethod::QSortMethod(QSortMethodPrivate &dd, QNode *parent)
: QFrameGraphNode(dd, parent)
{
diff --git a/src/render/frontend/framegraph-components/qtechniquefilter.cpp b/src/render/frontend/framegraph-components/qtechniquefilter.cpp
index 4fbbb0c75..2e625988a 100644
--- a/src/render/frontend/framegraph-components/qtechniquefilter.cpp
+++ b/src/render/frontend/framegraph-components/qtechniquefilter.cpp
@@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QTechniqueFilterPrivate
+ \internal
+*/
QTechniqueFilterPrivate::QTechniqueFilterPrivate(QTechniqueFilter *qq)
: QFrameGraphNodePrivate(qq)
{
@@ -64,6 +68,7 @@ QTechniqueFilter::QTechniqueFilter(QNode *parent)
{
}
+/*! \internal */
QTechniqueFilter::QTechniqueFilter(QTechniqueFilterPrivate &dd, QNode *parent)
: QFrameGraphNode(dd, parent)
{
diff --git a/src/render/frontend/framegraph-components/qviewport.cpp b/src/render/frontend/framegraph-components/qviewport.cpp
index 481cf54b2..fda834176 100644
--- a/src/render/frontend/framegraph-components/qviewport.cpp
+++ b/src/render/frontend/framegraph-components/qviewport.cpp
@@ -43,6 +43,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QViewportPrivate
+ \internal
+*/
QViewportPrivate::QViewportPrivate(QViewport *qq) :
QFrameGraphNodePrivate(qq)
{
@@ -62,6 +66,7 @@ QViewport::QViewport(QNode *parent)
{
}
+/*! \internal */
QViewport::QViewport(QViewportPrivate &dd, QNode *parent)
: QFrameGraphNode(dd, parent)
{
diff --git a/src/render/frontend/qabstractlight.cpp b/src/render/frontend/qabstractlight.cpp
index 7dbbc531c..1a0865536 100644
--- a/src/render/frontend/qabstractlight.cpp
+++ b/src/render/frontend/qabstractlight.cpp
@@ -50,6 +50,10 @@ namespace Qt3D
*/
+/*!
+ \class Qt3D::QAbstractLightPrivate
+ \internal
+*/
QAbstractLightPrivate::QAbstractLightPrivate(QAbstractLight *qq)
: QShaderDataPrivate(qq)
, m_color(QColor(255, 255, 255))
@@ -67,6 +71,10 @@ void QAbstractLight::copy(const QNode *ref)
}
/*!
+ \class Qt3D::QAbstractLight
+*/
+
+/*!
* Constructs a new QAbstractLight with the given \a parent.
*/
QAbstractLight::QAbstractLight(Qt3D::QNode *parent) :
@@ -74,7 +82,7 @@ QAbstractLight::QAbstractLight(Qt3D::QNode *parent) :
{
}
-
+/*! \internal */
QAbstractLight::QAbstractLight(QAbstractLightPrivate &dd, QNode *parent)
: QShaderData(dd, parent)
{
@@ -82,7 +90,9 @@ QAbstractLight::QAbstractLight(QAbstractLightPrivate &dd, QNode *parent)
/*!
- * Returns the current QAbstractLight color.
+ * \property Qt3D::QAbstractLight::color
+ *
+ * Holds the current QAbstractLight color.
*/
QColor QAbstractLight::color() const
{
@@ -90,11 +100,6 @@ QColor QAbstractLight::color() const
return d->m_color;
}
-/*!
- * Sets the current QAbstractLight \a color;
- *
- * \sa void QAbstractLight::colorChanged();
- */
void QAbstractLight::setColor(const QColor &color)
{
Q_D(QAbstractLight);
@@ -104,6 +109,11 @@ void QAbstractLight::setColor(const QColor &color)
}
}
+/*!
+ \property Qt3D::QAbstractLight::intensity
+
+ Holds the current QAbstractLight intensity.
+*/
float QAbstractLight::intensity() const
{
Q_D(const QAbstractLight);
@@ -119,6 +129,11 @@ void QAbstractLight::setIntensity(float intensity)
}
}
+/*!
+ \property Qt3D::QAbstractLight::position
+
+ Holds the current QAbstractLight position.
+*/
void QAbstractLight::setPosition(const QVector3D &position)
{
Q_D(QAbstractLight);
diff --git a/src/render/frontend/qabstractmesh.cpp b/src/render/frontend/qabstractmesh.cpp
index 94495f23d..6a12ac66d 100644
--- a/src/render/frontend/qabstractmesh.cpp
+++ b/src/render/frontend/qabstractmesh.cpp
@@ -39,8 +39,7 @@
#include <Qt3DCore/qscenepropertychange.h>
/*!
- * \class QAbstractMesh
- * \namespace Qt3D
+ * \class Qt3D::QAbstractMesh
*
* \brief Provides an abstract class that should be the base of all Mesh
* primitives in a scene
@@ -55,6 +54,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QAbstractMeshPrivate
+ \internal
+*/
QAbstractMeshPrivate::QAbstractMeshPrivate(QAbstractMesh *qq)
: QComponentPrivate(qq)
{
@@ -73,6 +76,7 @@ QAbstractMesh::QAbstractMesh(QNode *parent)
{
}
+/*! \internal */
QAbstractMesh::QAbstractMesh(QAbstractMeshPrivate &dd, QNode *parent)
: QComponent(dd, parent)
{
diff --git a/src/render/frontend/qabstractsceneloader.cpp b/src/render/frontend/qabstractsceneloader.cpp
index 9e0b06aec..916d4c801 100644
--- a/src/render/frontend/qabstractsceneloader.cpp
+++ b/src/render/frontend/qabstractsceneloader.cpp
@@ -47,6 +47,10 @@ namespace Qt3D {
namespace Render {
+/*!
+ \class Qt3D::Render::QAbstractSceneLoaderPrivate
+ \internal
+*/
QAbstractSceneLoaderPrivate::QAbstractSceneLoaderPrivate(QAbstractSceneLoader *qq)
: QComponentPrivate(qq)
, m_status(QAbstractSceneLoader::Loading)
@@ -54,6 +58,7 @@ QAbstractSceneLoaderPrivate::QAbstractSceneLoaderPrivate(QAbstractSceneLoader *q
m_shareable = false;
}
+/*! \internal */
QAbstractSceneLoader::QAbstractSceneLoader(QAbstractSceneLoaderPrivate &dd, QNode *parent)
: QComponent(dd, parent)
{
diff --git a/src/render/frontend/qabstracttextureimage.cpp b/src/render/frontend/qabstracttextureimage.cpp
index 8f012652c..df2adbf21 100644
--- a/src/render/frontend/qabstracttextureimage.cpp
+++ b/src/render/frontend/qabstracttextureimage.cpp
@@ -43,6 +43,11 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
/*!
+ \class Qt3D::QAbstractTextureImagePrivate
+ \internal
+*/
+
+/*!
\class Qt3D::QAbstractTextureImage
\since 5.5
\brief Encapsulates the necessary information to create an OpenGL texture image.
@@ -73,7 +78,9 @@ QAbstractTextureImage::~QAbstractTextureImage()
}
/*!
- \return the mipmal level of the texture image.
+ \property Qt3D::QAbstractTextureImage::mipmapLevel
+
+ Holds the mipmap level of the texture image.
*/
int QAbstractTextureImage::mipmapLevel() const
{
@@ -82,7 +89,9 @@ int QAbstractTextureImage::mipmapLevel() const
}
/*!
- \return the layer of the texture image.
+ \property Qt3D::QAbstractTextureImage::layer
+
+ Holds the layer of the texture image.
*/
int QAbstractTextureImage::layer() const
{
@@ -91,7 +100,13 @@ int QAbstractTextureImage::layer() const
}
/*!
- \return the cube map face of the texture image.
+ \property Qt3D::QAbstractTextureImage::cubeMapFace
+
+ Holds the cube map face of the texture image.
+
+ \note The cube map face has a meaning only for
+ \l {QAbstractTextureProvider::}{TargetCubeMap} and
+ \l {QAbstractTextureProvider::}{TargetCubeMapArray}.
*/
QAbstractTextureProvider::CubeMapFace QAbstractTextureImage::cubeMapFace() const
{
@@ -99,9 +114,6 @@ QAbstractTextureProvider::CubeMapFace QAbstractTextureImage::cubeMapFace() const
return d->m_face;
}
-/*!
- Sets the mipmap level of the texture image to \a level.
- */
void QAbstractTextureImage::setMipmapLevel(int level)
{
Q_D(QAbstractTextureImage);
@@ -111,11 +123,6 @@ void QAbstractTextureImage::setMipmapLevel(int level)
}
}
-/*!
- Sets the layer of the texture image to \a layer.
- \note: has a meaning only for Target2DArray, TargetCubeMapArray and Target3D
- Qt3D::QAbstractTextureProvider.
- */
void QAbstractTextureImage::setLayer(int layer)
{
Q_D(QAbstractTextureImage);
@@ -125,11 +132,6 @@ void QAbstractTextureImage::setLayer(int layer)
}
}
-/*!
- Sets the cube map face of the texture image to \a face.
- \note: has a meaning only for TargetCubeMap and TargetCubeMapArray
- Qt3D::QAbstractTextureProvider.
- */
void QAbstractTextureImage::setCubeMapFace(QAbstractTextureProvider::CubeMapFace face)
{
Q_D(QAbstractTextureImage);
@@ -140,7 +142,7 @@ void QAbstractTextureImage::setCubeMapFace(QAbstractTextureProvider::CubeMapFace
}
/*!
- Triggers an update of the data functor that is sent to the backend
+ Triggers an update of the data functor that is sent to the backend.
*/
void QAbstractTextureImage::update()
{
@@ -161,6 +163,7 @@ void QAbstractTextureImage::copy(const QNode *ref)
d_func()->m_mipmapLevel = imageRef->mipmapLevel();
}
+/*! \internal */
QAbstractTextureImage::QAbstractTextureImage(QAbstractTextureImagePrivate &dd, QNode *parent)
: QNode(dd, parent)
{
diff --git a/src/render/frontend/qabstracttextureprovider.cpp b/src/render/frontend/qabstracttextureprovider.cpp
index 8d08b76b6..549332c0c 100644
--- a/src/render/frontend/qabstracttextureprovider.cpp
+++ b/src/render/frontend/qabstracttextureprovider.cpp
@@ -43,6 +43,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QAbstractTextureProviderPrivate
+ \internal
+*/
QAbstractTextureProviderPrivate::QAbstractTextureProviderPrivate(QAbstractTextureProvider *qq)
: QNodePrivate(qq)
, m_target(QAbstractTextureProvider::Target2D)
@@ -85,7 +89,7 @@ void QAbstractTextureProvider::copy(const QNode *ref)
/*!
\class Qt3D::QAbstractTextureProvider
\since 5.5
- \brief Qt3D::QAbstractTextureProvider is a base class to be used to provide textures.
+ \brief A base class to be used to provide textures.
Qt3D::QAbstractTextureProvider shouldn't be used directly but rather
through one of its subclasses. Each subclass implements a given texture
@@ -107,6 +111,7 @@ QAbstractTextureProvider::QAbstractTextureProvider(Target target, QNode *parent)
d_func()->m_target = target;
}
+/*! \internal */
QAbstractTextureProvider::QAbstractTextureProvider(QAbstractTextureProviderPrivate &dd, QNode *parent)
: QNode(dd, parent)
{
@@ -117,7 +122,7 @@ QAbstractTextureProvider::~QAbstractTextureProvider()
}
/*!
- Sets the size of the texture provider to width \a, height \a h and depth \a d.
+ Sets the size of the texture provider to width \a w, height \a h and depth \a d.
*/
void QAbstractTextureProvider::setSize(int w, int h, int d)
{
@@ -127,7 +132,9 @@ void QAbstractTextureProvider::setSize(int w, int h, int d)
}
/*!
- Sets the width of the texture provider to \a width.
+ \property Qt3D::QAbstractTextureProvider::width
+
+ Holds the width of the texture provider.
*/
void QAbstractTextureProvider::setWidth(int width)
{
@@ -139,7 +146,9 @@ void QAbstractTextureProvider::setWidth(int width)
}
/*!
- Sets the height of the texture provider to \a height.
+ \property Qt3D::QAbstractTextureProvider::height
+
+ Holds the height of the texture provider.
*/
void QAbstractTextureProvider::setHeight(int height)
{
@@ -151,7 +160,9 @@ void QAbstractTextureProvider::setHeight(int height)
}
/*!
- Sets the depth of the texture provider to \a depth.
+ \property Qt3D::QAbstractTextureProvider::depth
+
+ Holds the depth of the texture provider.
*/
void QAbstractTextureProvider::setDepth(int depth)
{
@@ -162,27 +173,18 @@ void QAbstractTextureProvider::setDepth(int depth)
}
}
-/*!
- \returns the width of the texture provider.
- */
int QAbstractTextureProvider::width() const
{
Q_D(const QAbstractTextureProvider);
return d->m_width;
}
-/*!
- \returns the height of the texture provider.
- */
int QAbstractTextureProvider::height() const
{
Q_D(const QAbstractTextureProvider);
return d->m_height;
}
-/*!
- \returns the depth of the texture provider.
- */
int QAbstractTextureProvider::depth() const
{
Q_D(const QAbstractTextureProvider);
@@ -190,11 +192,13 @@ int QAbstractTextureProvider::depth() const
}
/*!
- Sets the maximum layers count to \a maximumLayers, by defaults, the maximum
- layer count is 1.
+ \property Qt3D::QAbstractTextureProvider::maximumLayers
+
+ Holds the maximum layer count of the texture provider. By default, the
+ maximum layer count is 1.
- \note this has a meaning only for texture providers that
- have 3D or array target formats.
+ \note this has a meaning only for texture providers that have 3D or
+ array target formats.
*/
void QAbstractTextureProvider::setMaximumLayers(int maximumLayers)
{
@@ -205,10 +209,6 @@ void QAbstractTextureProvider::setMaximumLayers(int maximumLayers)
}
}
-/*!
- \return return the maximum layers count of the texture provider.
- \note this has a meaning only for texture providers that have 3D or array target formats.
- */
int QAbstractTextureProvider::maximumLayers() const
{
Q_D(const QAbstractTextureProvider);
@@ -216,7 +216,9 @@ int QAbstractTextureProvider::maximumLayers() const
}
/*!
- Sets the format of the texture provider to \a format.
+ \property Qt3D::QAbstractTextureProvider::format
+
+ Holds the format of the texture provider.
*/
void QAbstractTextureProvider::setFormat(TextureFormat format)
{
@@ -227,9 +229,6 @@ void QAbstractTextureProvider::setFormat(TextureFormat format)
}
}
-/*!
- \returns the format of the texture provider.
- */
QAbstractTextureProvider::TextureFormat QAbstractTextureProvider::format() const
{
Q_D(const QAbstractTextureProvider);
@@ -237,7 +236,9 @@ QAbstractTextureProvider::TextureFormat QAbstractTextureProvider::format() const
}
/*!
- Sets the current status of the texture provider to \a status.
+ \property Qt3D::QAbstractTextureProvider::status readonly
+
+ Holds the current status of the texture provider.
*/
void QAbstractTextureProvider::setStatus(Status status)
{
@@ -248,9 +249,6 @@ void QAbstractTextureProvider::setStatus(Status status)
}
}
-/*!
- \returns the current status of the texture provider.
- */
QAbstractTextureProvider::Status QAbstractTextureProvider::status() const
{
Q_D(const QAbstractTextureProvider);
@@ -258,8 +256,11 @@ QAbstractTextureProvider::Status QAbstractTextureProvider::status() const
}
/*!
- \returns the target format of the texture provider.
- \note: The target format can only be set once.
+ \property Qt3D::QAbstractTextureProvider::target readonly
+
+ Holds the target format of the texture provider.
+
+ \note The target format can only be set once.
*/
QAbstractTextureProvider::Target QAbstractTextureProvider::target() const
{
@@ -268,8 +269,10 @@ QAbstractTextureProvider::Target QAbstractTextureProvider::target() const
}
/*!
- Adds a new Qt3D::QAbstractTextureImage \a texture image to the texture provider.
- \note: Qt3D::QAbstractTextureImage should never be shared by several Qt3D::QAbstractTextureProvider
+ Adds a new Qt3D::QAbstractTextureImage \a textureImage to the texture provider.
+
+ \note Qt3D::QAbstractTextureImage should never be shared between multiple
+ Qt3D::QAbstractTextureProvider instances.
*/
void QAbstractTextureProvider::addTextureImage(QAbstractTextureImage *textureImage)
{
@@ -297,7 +300,7 @@ void QAbstractTextureProvider::addTextureImage(QAbstractTextureImage *textureIma
}
/*!
- Removes a Qt3D::QAbstractTextureImage \a texture image form the texture provider.
+ Removes a Qt3D::QAbstractTextureImage \a textureImage from the texture provider.
*/
void QAbstractTextureProvider::removeTextureImage(QAbstractTextureImage *textureImage)
{
@@ -312,7 +315,8 @@ void QAbstractTextureProvider::removeTextureImage(QAbstractTextureImage *texture
}
/*!
-\return the list of QAbstractTextureImage * contained in the texture provider.
+ Returns a list of pointers to QAbstractTextureImage objects contained in
+ the texture provider.
*/
QList<QAbstractTextureImage *> QAbstractTextureProvider::textureImages() const
{
@@ -321,7 +325,9 @@ QList<QAbstractTextureImage *> QAbstractTextureProvider::textureImages() const
}
/*!
- Sets whether the texture provider should auto generate mipmaps.
+ \property Qt3D::QAbstractTextureProvider::generateMipMaps
+
+ Holds whether the texture provider should auto generate mipmaps.
*/
void QAbstractTextureProvider::setGenerateMipMaps(bool gen)
{
@@ -332,9 +338,6 @@ void QAbstractTextureProvider::setGenerateMipMaps(bool gen)
}
}
-/*!
- \returns whether texture provider auto generates mipmaps.
- */
bool QAbstractTextureProvider::generateMipMaps() const
{
Q_D(const QAbstractTextureProvider);
@@ -342,7 +345,9 @@ bool QAbstractTextureProvider::generateMipMaps() const
}
/*!
- Sets the minification filter of the texture provider to \a f.
+ \property Qt3D::QAbstractTextureProvider::minificationFilter
+
+ Holds the minification filter of the texture provider.
*/
void QAbstractTextureProvider::setMinificationFilter(Filter f)
{
@@ -354,7 +359,9 @@ void QAbstractTextureProvider::setMinificationFilter(Filter f)
}
/*!
- Sets the magnification filter of the texture provider to \a f.
+ \property Qt3D::QAbstractTextureProvider::magnificationFilter
+
+ Holds the magnification filter of the texture provider.
*/
void QAbstractTextureProvider::setMagnificationFilter(Filter f)
{
@@ -365,18 +372,12 @@ void QAbstractTextureProvider::setMagnificationFilter(Filter f)
}
}
-/*!
- \returns the minification filter of the texture provider.
- */
QAbstractTextureProvider::Filter QAbstractTextureProvider::minificationFilter() const
{
Q_D(const QAbstractTextureProvider);
return d->m_minFilter;
}
-/*!
- \returns the magnification filter of the texture provider.
- */
QAbstractTextureProvider::Filter QAbstractTextureProvider::magnificationFilter() const
{
Q_D(const QAbstractTextureProvider);
@@ -384,7 +385,9 @@ QAbstractTextureProvider::Filter QAbstractTextureProvider::magnificationFilter()
}
/*!
- Sets the wrap mode of the texture provider to \a wrapMode.
+ \property Qt3D::QAbstractTextureProvider::wrapMode
+
+ Holds the wrap mode of the texture provider.
*/
void QAbstractTextureProvider::setWrapMode(const QTextureWrapMode &wrapMode)
{
@@ -412,9 +415,6 @@ void QAbstractTextureProvider::setWrapMode(const QTextureWrapMode &wrapMode)
}
}
-/*!
- \returns the wrap mode of the texture provider.
- */
QTextureWrapMode *QAbstractTextureProvider::wrapMode()
{
Q_D(QAbstractTextureProvider);
@@ -422,7 +422,9 @@ QTextureWrapMode *QAbstractTextureProvider::wrapMode()
}
/*!
- Sets the maximum anisotropy of the texture provider to \a anisotropy.
+ \property Qt3D::QAbstractTextureProvider::maximumAnisotropy
+
+ Holds the maximum anisotropy of the texture provider.
*/
void QAbstractTextureProvider::setMaximumAnisotropy(float anisotropy)
{
@@ -433,9 +435,6 @@ void QAbstractTextureProvider::setMaximumAnisotropy(float anisotropy)
}
}
-/*!
- \returns the maximum anisotropy of the texture provider.
- */
float QAbstractTextureProvider::maximumAnisotropy() const
{
Q_D(const QAbstractTextureProvider);
@@ -443,7 +442,9 @@ float QAbstractTextureProvider::maximumAnisotropy() const
}
/*!
- Sets the comparison function of the texture provider to \a function.
+ \property Qt3D::QAbstractTextureProvider::comparisonFunction
+
+ Holds the comparison function of the texture provider.
*/
void QAbstractTextureProvider::setComparisonFunction(QAbstractTextureProvider::ComparisonFunction function)
{
@@ -454,9 +455,6 @@ void QAbstractTextureProvider::setComparisonFunction(QAbstractTextureProvider::C
}
}
-/*!
- \returns the comparison function of the texture provider.
- */
QAbstractTextureProvider::ComparisonFunction QAbstractTextureProvider::comparisonFunction() const
{
Q_D(const QAbstractTextureProvider);
@@ -464,7 +462,9 @@ QAbstractTextureProvider::ComparisonFunction QAbstractTextureProvider::compariso
}
/*!
- Sets the comparison mode of the texture provider to \a mode.
+ \property Qt3D::QAbstractTextureProvider::comparisonMode
+
+ Holds the comparison mode of the texture provider.
*/
void QAbstractTextureProvider::setComparisonMode(QAbstractTextureProvider::ComparisonMode mode)
{
@@ -475,9 +475,6 @@ void QAbstractTextureProvider::setComparisonMode(QAbstractTextureProvider::Compa
}
}
-/*!
- \returns the comparison mode of the texture provider.
- */
QAbstractTextureProvider::ComparisonMode QAbstractTextureProvider::comparisonMode() const
{
Q_D(const QAbstractTextureProvider);
diff --git a/src/render/frontend/qannotation.cpp b/src/render/frontend/qannotation.cpp
index 831017a51..75b4d732e 100644
--- a/src/render/frontend/qannotation.cpp
+++ b/src/render/frontend/qannotation.cpp
@@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QAnnotationPrivate
+ \internal
+*/
QAnnotationPrivate::QAnnotationPrivate(QAnnotation *qq)
: QNodePrivate(qq)
{
diff --git a/src/render/frontend/qcolormask.cpp b/src/render/frontend/qcolormask.cpp
index 22f130134..95e2e69b2 100644
--- a/src/render/frontend/qcolormask.cpp
+++ b/src/render/frontend/qcolormask.cpp
@@ -61,16 +61,15 @@ public:
};
/*!
-
\class Qt3D::QColorMask
- \brief QColorMask allows to specify which color components should be written
- to the currently bound frame buffer.
+ \brief Allows specifying which color components should be written to the
+ currently bound frame buffer.
- By default each color component (red, green, blue, alpha) is set to true
- which means they will be written to the frame buffer. Setting any of the
- color component to false will prevent it from being written into the frame
- buffer.
+ By default, the property for each color component (red, green, blue, alpha)
+ is set to \c true which means they will be written to the frame buffer.
+ Setting any of the color component to \c false will prevent it from being
+ written into the frame buffer.
*/
@@ -86,36 +85,24 @@ QColorMask::~QColorMask()
{
}
-/*!
- \return whether the red color component should be written to the frame buffer;
- */
bool QColorMask::isRed() const
{
Q_D(const QColorMask);
return d->m_red;
}
-/*!
- \return whether the green color component should be written to the frame buffer;
- */
bool QColorMask::isGreen() const
{
Q_D(const QColorMask);
return d->m_green;
}
-/*!
- \return whether the blue color component should be written to the frame buffer;
- */
bool QColorMask::isBlue() const
{
Q_D(const QColorMask);
return d->m_blue;
}
-/*!
- \return whether the alpha color component should be written to the frame buffer;
- */
bool QColorMask::isAlpha() const
{
Q_D(const QColorMask);
@@ -123,7 +110,8 @@ bool QColorMask::isAlpha() const
}
/*!
- Sets whether the \a red color component should be written to the frame buffer;
+ \property Qt3D::QColorMask::red
+ Holds whether the red color component should be written to the frame buffer.
*/
void QColorMask::setRed(bool red)
{
@@ -135,7 +123,8 @@ void QColorMask::setRed(bool red)
}
/*!
- Sets whether the \a greem color component should be written to the frame buffer;
+ \property Qt3D::QColorMask::green
+ Holds whether the green color component should be written to the frame buffer.
*/
void QColorMask::setGreen(bool green)
{
@@ -147,7 +136,8 @@ void QColorMask::setGreen(bool green)
}
/*!
- Sets whether the \a blue color component should be written to the frame buffer;
+ \property Qt3D::QColorMask::blue
+ Holds whether the blue color component should be written to the frame buffer.
*/
void QColorMask::setBlue(bool blue)
{
@@ -159,7 +149,8 @@ void QColorMask::setBlue(bool blue)
}
/*!
- Sets whether the \a alpha color component should be written to the frame buffer;
+ \property Qt3D::QColorMask::alpha
+ Holds whether the alpha component should be written to the frame buffer.
*/
void QColorMask::setAlpha(bool alpha)
{
diff --git a/src/render/frontend/qcuboidmesh.cpp b/src/render/frontend/qcuboidmesh.cpp
index 42bd15888..33769b1ca 100644
--- a/src/render/frontend/qcuboidmesh.cpp
+++ b/src/render/frontend/qcuboidmesh.cpp
@@ -48,6 +48,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QCuboidMeshPrivate
+ \internal
+*/
QCuboidMeshPrivate::QCuboidMeshPrivate(QCuboidMesh *qq)
: QAbstractMeshPrivate(qq)
, m_xExtent(1.0)
@@ -77,6 +81,7 @@ QCuboidMesh::QCuboidMesh(QNode *parent)
update();
}
+/*! \internal */
QCuboidMesh::QCuboidMesh(QCuboidMeshPrivate &dd, QNode *parent)
: QAbstractMesh(dd, parent)
{
diff --git a/src/render/frontend/qdirectionallight.cpp b/src/render/frontend/qdirectionallight.cpp
index cf24db3e9..4cfc72a50 100644
--- a/src/render/frontend/qdirectionallight.cpp
+++ b/src/render/frontend/qdirectionallight.cpp
@@ -61,6 +61,10 @@ namespace Qt3D {
* \endcode
*/
+/*!
+ \class Qt3D::QDirectionalLightPrivate
+ \internal
+*/
QDirectionalLightPrivate::QDirectionalLightPrivate(QDirectionalLight *qq)
: QAbstractLightPrivate(qq)
{
@@ -80,6 +84,7 @@ QDirectionalLight::QDirectionalLight(QNode *parent)
{
}
+/*! \internal */
QDirectionalLight::QDirectionalLight(QDirectionalLightPrivate &dd, QNode *parent)
: QAbstractLight(dd, parent)
{
diff --git a/src/render/frontend/qeffect.cpp b/src/render/frontend/qeffect.cpp
index 57527fc4b..03e86282e 100644
--- a/src/render/frontend/qeffect.cpp
+++ b/src/render/frontend/qeffect.cpp
@@ -45,6 +45,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QEffectPrivate
+ \internal
+*/
QEffectPrivate::QEffectPrivate(QEffect *qq)
: QNodePrivate(qq)
{}
@@ -65,6 +69,7 @@ void QEffect::copy(const QNode* ref)
addTechnique(qobject_cast<QTechnique *>(QNode::clone(t)));
}
+/*! \internal */
QEffect::QEffect(QEffectPrivate &dd, QNode *parent)
: QNode(dd, parent)
{
@@ -140,7 +145,7 @@ void QEffect::addTechnique(QTechnique *t)
}
/*!
- * Removes a technique \t from the effect. This posts a ComponentRemoved
+ * Removes a technique \a t from the effect. This posts a ComponentRemoved
* QScenePropertyChange notification to the QChangeArbiter, the value is
* the removed technique's id and the property name is "technique".
*/
diff --git a/src/render/frontend/qlayer.cpp b/src/render/frontend/qlayer.cpp
index a7886304f..4f96a8fe8 100644
--- a/src/render/frontend/qlayer.cpp
+++ b/src/render/frontend/qlayer.cpp
@@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QLayerPrivate
+ \internal
+*/
QLayerPrivate::QLayerPrivate(QLayer *qq)
: QComponentPrivate(qq)
{
@@ -58,6 +62,7 @@ QLayer::QLayer(QNode *parent)
{
}
+/*! \internal */
QLayer::QLayer(QLayerPrivate &dd, QNode *parent)
: QComponent(dd, parent)
{
diff --git a/src/render/frontend/qmaterial.cpp b/src/render/frontend/qmaterial.cpp
index e9de8a21c..4cd5713ba 100644
--- a/src/render/frontend/qmaterial.cpp
+++ b/src/render/frontend/qmaterial.cpp
@@ -43,8 +43,7 @@
#include <Qt3DCore/qscenepropertychange.h>
/*!
- * \class QMaterial
- * \namespace Qt3D
+ * \class Qt3D::QMaterial
*
* \inherits Component
*
@@ -53,16 +52,21 @@
*
* QAbstractMaterial provide a way to specify the rendering of an Entity.
* Any aspect can define its own subclass of QAbstractMaterial so that a
- * Material can be used to describe a visual element, the way sound should
- * reflect on an element, the temperature of a surface and so on.
+ * Material can be used to describe a visual element; for example, the way
+ * sound should reflect off an element, the temperature of a surface,
+ * and so on.
*
- * \sa QEffect, QMesh, QComponent
+ * \sa QEffect, QMesh, {Qt3D::}{QComponent}
*/
QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QMaterialPrivate
+ \internal
+*/
QMaterialPrivate::QMaterialPrivate(QMaterial *qq)
: QComponentPrivate(qq)
, m_effect(Q_NULLPTR)
@@ -85,6 +89,7 @@ QMaterial::QMaterial(QNode *parent)
{
}
+/*! \internal */
QMaterial::QMaterial(QMaterialPrivate &dd, QNode *parent)
: QComponent(dd, parent)
{
diff --git a/src/render/frontend/qmesh.cpp b/src/render/frontend/qmesh.cpp
index c2fb74cf1..a8b7858e5 100644
--- a/src/render/frontend/qmesh.cpp
+++ b/src/render/frontend/qmesh.cpp
@@ -61,6 +61,10 @@ private:
};
+/*!
+ \class Qt3D::QMeshPrivate
+ \internal
+*/
QMeshPrivate::QMeshPrivate(QMesh *qq)
: QAbstractMeshPrivate(qq)
{}
@@ -77,6 +81,7 @@ QMesh::QMesh(QNode *parent)
{
}
+/*! \internal */
QMesh::QMesh(QMeshPrivate &dd, QNode *parent)
: QAbstractMesh(dd, parent)
{
diff --git a/src/render/frontend/qparameter.cpp b/src/render/frontend/qparameter.cpp
index 9a1ec67c5..38833d8a9 100644
--- a/src/render/frontend/qparameter.cpp
+++ b/src/render/frontend/qparameter.cpp
@@ -45,6 +45,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QParameterPrivate
+ \internal
+*/
QParameterPrivate::QParameterPrivate(QParameter *qq)
: QNodePrivate(qq)
{
@@ -63,6 +67,7 @@ void QParameter::copy(const QNode *ref)
d_func()->m_value = param->d_func()->m_value;
}
+/*! \internal */
QParameter::QParameter(QParameterPrivate &dd, QNode *parent)
: QNode(dd, parent)
{
diff --git a/src/render/frontend/qparametermapping.cpp b/src/render/frontend/qparametermapping.cpp
index 61c4946be..0d9910e2e 100644
--- a/src/render/frontend/qparametermapping.cpp
+++ b/src/render/frontend/qparametermapping.cpp
@@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QParameterMappingPrivate
+ \internal
+*/
QParameterMappingPrivate::QParameterMappingPrivate(QParameterMapping *qq)
: QNodePrivate(qq)
, m_bindingType(QParameterMapping::Uniform)
@@ -61,6 +65,7 @@ QParameterMapping::QParameterMapping(QNode *parent)
{
}
+/*! \internal */
QParameterMapping::QParameterMapping(QParameterMappingPrivate &dd, QNode *parent)
: QNode(dd, parent)
{
diff --git a/src/render/frontend/qplanemesh.cpp b/src/render/frontend/qplanemesh.cpp
index 17b22cc9b..7d31df1bd 100644
--- a/src/render/frontend/qplanemesh.cpp
+++ b/src/render/frontend/qplanemesh.cpp
@@ -48,6 +48,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QPlaneMeshPrivate
+ \internal
+*/
QPlaneMeshPrivate::QPlaneMeshPrivate(QPlaneMesh *qq)
: QAbstractMeshPrivate(qq)
, m_width(1.0f)
@@ -71,6 +75,7 @@ void QPlaneMesh::copy(const QNode *ref)
d_func()->m_meshResolution = mesh->d_func()->m_meshResolution;
}
+/*! \internal */
QPlaneMesh::QPlaneMesh(QPlaneMeshPrivate &dd, QNode *parent)
: QAbstractMesh(dd, parent)
{
diff --git a/src/render/frontend/qpointlight.cpp b/src/render/frontend/qpointlight.cpp
index 314875157..2d1c9ed43 100644
--- a/src/render/frontend/qpointlight.cpp
+++ b/src/render/frontend/qpointlight.cpp
@@ -59,6 +59,10 @@ namespace Qt3D {
* \endcode
*/
+/*!
+ \class Qt3D::QPointLightPrivate
+ \internal
+*/
QPointLightPrivate::QPointLightPrivate(QPointLight *qq)
: QAbstractLightPrivate(qq)
{
@@ -69,6 +73,7 @@ QPointLight::QPointLight(QNode *parent)
{
}
+/*! \internal */
QPointLight::QPointLight(QPointLightPrivate &dd, QNode *parent)
: QAbstractLight(dd, parent)
{
diff --git a/src/render/frontend/qrenderattachment.cpp b/src/render/frontend/qrenderattachment.cpp
index fb7892fd9..f4445895e 100644
--- a/src/render/frontend/qrenderattachment.cpp
+++ b/src/render/frontend/qrenderattachment.cpp
@@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QRenderAttachmentPrivate
+ \internal
+*/
QRenderAttachmentPrivate::QRenderAttachmentPrivate(QRenderAttachment *qq)
: QNodePrivate(qq)
, m_texture(Q_NULLPTR)
@@ -65,6 +69,7 @@ QRenderAttachment::QRenderAttachment(QNode *parent)
{
}
+/*! \internal */
QRenderAttachment::QRenderAttachment(QRenderAttachmentPrivate &dd, QNode *parent)
: QNode(dd, parent)
{
diff --git a/src/render/frontend/qrenderpass.cpp b/src/render/frontend/qrenderpass.cpp
index 3fa5d0308..9482248f5 100644
--- a/src/render/frontend/qrenderpass.cpp
+++ b/src/render/frontend/qrenderpass.cpp
@@ -48,6 +48,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QRenderPassPrivate
+ \internal
+*/
QRenderPassPrivate::QRenderPassPrivate(QRenderPass *qq)
: QNodePrivate(qq)
, m_shader(Q_NULLPTR)
@@ -73,6 +77,7 @@ QRenderPass::QRenderPass(QNode *parent)
{
}
+/*! \internal */
QRenderPass::QRenderPass(QRenderPassPrivate &dd, QNode *parent)
: QNode(dd, parent)
{
diff --git a/src/render/frontend/qrenderstate.cpp b/src/render/frontend/qrenderstate.cpp
index 17375c4c2..69154c155 100644
--- a/src/render/frontend/qrenderstate.cpp
+++ b/src/render/frontend/qrenderstate.cpp
@@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QRenderStatePrivate
+ \internal
+*/
QRenderStatePrivate::QRenderStatePrivate(QRenderState *qq, QRenderState::Type type)
: QNodePrivate(qq),
m_type(type)
@@ -54,6 +58,7 @@ QRenderState::Type QRenderState::type() const
return d->m_type;
}
+/*! \internal */
QRenderState::QRenderState(QRenderStatePrivate &dd, QNode *parent)
: QNode(dd, parent)
{
diff --git a/src/render/frontend/qrendertarget.cpp b/src/render/frontend/qrendertarget.cpp
index 3eb3b4e08..764ab04c1 100644
--- a/src/render/frontend/qrendertarget.cpp
+++ b/src/render/frontend/qrendertarget.cpp
@@ -43,6 +43,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QRenderTargetPrivate
+ \internal
+*/
QRenderTargetPrivate::QRenderTargetPrivate(QRenderTarget *qq)
: QComponentPrivate(qq)
{
@@ -61,6 +65,7 @@ QRenderTarget::QRenderTarget(QNode *parent)
{
}
+/*! \internal */
QRenderTarget::QRenderTarget(QRenderTargetPrivate &dd, QNode *parent)
: QComponent(dd, parent)
{
diff --git a/src/render/frontend/qshaderdata.cpp b/src/render/frontend/qshaderdata.cpp
index c209a4c53..02570091c 100644
--- a/src/render/frontend/qshaderdata.cpp
+++ b/src/render/frontend/qshaderdata.cpp
@@ -41,12 +41,20 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QShaderDataPrivate
+ \internal
+*/
QShaderDataPrivate::QShaderDataPrivate(QShaderData *qq)
: QComponentPrivate(qq)
, m_propertyReader(PropertyReaderInterfacePtr(new QShaderDataPropertyReader()))
{
}
+/*!
+ \class Qt3D::QShaderDataPrivate
+ \internal
+*/
QShaderDataPrivate::QShaderDataPrivate(QShaderData *qq, PropertyReaderInterfacePtr reader)
: QComponentPrivate(qq)
, m_propertyReader(reader)
@@ -59,9 +67,9 @@ QShaderDataPrivate::QShaderDataPrivate(QShaderData *qq, PropertyReaderInterfaceP
* \brief Provides a way of specifying values of a Uniform Block or a shader
* structure.
*
- * \note When subclassing and adding properties to Qt3D::QShaderData please not
- * that if you need to nest inner Qt3D::QShaderData, the data type of the
- * property should be Qt3D::QShaderData* and not whatever you named your subclass.
+ * \note When subclassing and adding properties to Qt3D::QShaderData, please note
+ * that if you need to nest an inner Qt3D::QShaderData, the data type of the
+ * property should be Qt3D::QShaderData* instead of the name of your subclass.
*
* \since 5.5
*/
@@ -77,6 +85,7 @@ PropertyReaderInterfacePtr QShaderData::propertyReader() const
return d->m_propertyReader;
}
+/*! \internal */
QShaderData::QShaderData(QShaderDataPrivate &dd, QNode *parent)
: QComponent(dd, parent)
{
diff --git a/src/render/frontend/qshaderprogram.cpp b/src/render/frontend/qshaderprogram.cpp
index 15621d55c..8e9e2eaf4 100644
--- a/src/render/frontend/qshaderprogram.cpp
+++ b/src/render/frontend/qshaderprogram.cpp
@@ -46,6 +46,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QShaderProgramPrivate
+ \internal
+*/
QShaderProgramPrivate::QShaderProgramPrivate(QShaderProgram *qq)
: QNodePrivate(qq)
{
@@ -69,6 +73,7 @@ QShaderProgram::QShaderProgram(QNode *parent)
{
}
+/*! \internal */
QShaderProgram::QShaderProgram(QShaderProgramPrivate &dd, QNode *parent)
: QNode(dd, parent)
{
diff --git a/src/render/frontend/qspotlight.cpp b/src/render/frontend/qspotlight.cpp
index 467ceca19..edb6243a3 100644
--- a/src/render/frontend/qspotlight.cpp
+++ b/src/render/frontend/qspotlight.cpp
@@ -63,6 +63,10 @@ namespace Qt3D {
* \endcode
*/
+/*!
+ \class Qt3D::QSpotLightPrivate
+ \internal
+*/
QSpotLightPrivate::QSpotLightPrivate(QSpotLight *qq)
: QAbstractLightPrivate(qq)
, m_cutOffAngle(45.0f)
@@ -84,6 +88,7 @@ QSpotLight::QSpotLight(QNode *parent)
{
}
+/*! \internal */
QSpotLight::QSpotLight(QSpotLightPrivate &dd, QNode *parent)
: QAbstractLight(dd, parent)
{
diff --git a/src/render/frontend/qtechnique.cpp b/src/render/frontend/qtechnique.cpp
index e78d88e01..d6d931caa 100644
--- a/src/render/frontend/qtechnique.cpp
+++ b/src/render/frontend/qtechnique.cpp
@@ -45,6 +45,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3D {
+/*!
+ \class Qt3D::QTechniquePrivate
+ \internal
+*/
QTechniquePrivate::QTechniquePrivate(QTechnique *qq)
: QNodePrivate(qq)
{
@@ -61,6 +65,7 @@ QTechnique::QTechnique(QNode *parent)
QObject::connect(&d->m_openGLFilter, SIGNAL(openGLFilterChanged()), this, SLOT(openGLFilterChanged()));
}
+/*! \internal */
QTechnique::QTechnique(QTechniquePrivate &dd, QNode *parent)
: QNode(dd, parent)
{
@@ -200,7 +205,7 @@ void QTechnique::addPass(QRenderPass *pass)
/*!
* Removes a \a pass from the technique. This posts a ComponentRemoved
* QScenePropertyChange notification to the QChangeArbiter with the value
- * being the \a pass' id and the property name being "pass".
+ * being the id of \a pass and the property name being "pass".
*/
void QTechnique::removePass(QRenderPass *pass)
{
diff --git a/src/render/frontend/qtextureimage.cpp b/src/render/frontend/qtextureimage.cpp
index 92b69797f..6a46f8b68 100644
--- a/src/render/frontend/qtextureimage.cpp
+++ b/src/render/frontend/qtextureimage.cpp
@@ -114,7 +114,7 @@ QTextureImage::~QTextureImage()
}
/*!
- \return the source url from which data will be loaded of the texture image.
+ Returns the source url from which data for the texture image will be loaded.
*/
QUrl QTextureImage::source() const
{
@@ -124,7 +124,7 @@ QUrl QTextureImage::source() const
/*!
Sets the source url of the texture image to \a source.
- \note: this triggers a call to update()
+ \note This triggers a call to update()
*/
void QTextureImage::setSource(const QUrl &source)
{
@@ -137,7 +137,7 @@ void QTextureImage::setSource(const QUrl &source)
}
/*!
- \returns the a Qt3D::QTextureDataFunctorPtr functor to be used by the
+ Returns the Qt3D::QTextureDataFunctorPtr functor to be used by the
backend to load the texture image data into an OpenGL texture object.
*/
QTextureDataFunctorPtr QTextureImage::dataFunctor() const
diff --git a/src/render/frontend/qwrapmode.cpp b/src/render/frontend/qwrapmode.cpp
index 870c194bf..e73ff6541 100644
--- a/src/render/frontend/qwrapmode.cpp
+++ b/src/render/frontend/qwrapmode.cpp
@@ -64,8 +64,8 @@ public:
\class Qt3D::QTextureWrapMode
\since 5.5
- \brief Qt3D::QTextureWrapMode defines the wrap mode a
- Qt3D::QAbstractTextureProvider should apply to a texture.
+ \brief Defines the wrap mode a Qt3D::QAbstractTextureProvider
+ should apply to a texture.
*/
QTextureWrapMode::QTextureWrapMode(WrapMode wrapMode, QObject *parent)