From 85ffad3142cd4c3baa0bb77b0674a17287b01534 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 4 Nov 2015 12:47:51 +0100 Subject: Doc: Fix QDoc warnings and do further cleanup Fix the documentation issues that still remained broken after renaming the namespaces/QML modules. Do further cleanup and minor doc editing. Change-Id: Iff38c8c1b99e7f712dc3f9ad07ecd37a747b3a26 Reviewed-by: Venugopal Shivashankar --- src/render/defaults/qdiffusemapmaterial.cpp | 2 +- .../defaults/qdiffusespecularmapmaterial.cpp | 2 +- src/render/defaults/qgoochmaterial.cpp | 16 +++++------ .../defaults/qnormaldiffusemapalphamaterial.cpp | 2 +- src/render/defaults/qnormaldiffusemapmaterial.cpp | 2 +- .../defaults/qnormaldiffusespecularmapmaterial.cpp | 2 +- src/render/defaults/qpervertexcolormaterial.cpp | 4 +-- src/render/defaults/qphongmaterial.cpp | 6 ++-- src/render/defaults/qskyboxentity.cpp | 4 +-- src/render/framegraph/qcameraselector.cpp | 6 +++- src/render/framegraph/qframegraph.cpp | 17 +++++++----- src/render/framegraph/qframegraphnode.cpp | 8 +++--- src/render/framegraph/qframegraphselector.cpp | 2 +- src/render/framegraph/qlayerfilter.cpp | 10 +++---- src/render/framegraph/qnodraw.cpp | 7 +++-- src/render/framegraph/qstateset.cpp | 28 +++++++++++-------- src/render/frontend/qlayer.cpp | 10 +++---- src/render/io/qabstractsceneloader.cpp | 2 +- src/render/lights/qabstractlight.cpp | 8 +++--- src/render/lights/qdirectionallight.cpp | 2 +- src/render/lights/qpointlight.cpp | 6 ++-- src/render/lights/qspotlight.cpp | 16 +++++------ src/render/materialsystem/qannotation.cpp | 6 ++-- src/render/materialsystem/qgraphicsapifilter.cpp | 10 ++++--- src/render/materialsystem/qmaterial.cpp | 2 +- src/render/materialsystem/qparametermapping.cpp | 12 ++++---- src/render/materialsystem/qrenderpass.cpp | 2 +- src/render/materialsystem/qshaderdata.cpp | 13 ++++----- src/render/materialsystem/qshaderprogram.cpp | 4 +-- src/render/picking/qobjectpicker.cpp | 12 ++++---- src/render/renderstates/qblendstate.cpp | 32 +++++++++++----------- src/render/renderstates/qclipplane.cpp | 2 +- src/render/renderstates/qcolormask.cpp | 10 +++---- src/render/texture/qabstracttextureimage.cpp | 22 +++++++-------- src/render/texture/qabstracttextureprovider.cpp | 5 ++-- src/render/texture/qtextureimage.cpp | 8 +++--- src/render/texture/qtextureproviders.cpp | 22 +++++++-------- src/render/texture/qwrapmode.cpp | 2 +- 38 files changed, 167 insertions(+), 159 deletions(-) (limited to 'src/render') diff --git a/src/render/defaults/qdiffusemapmaterial.cpp b/src/render/defaults/qdiffusemapmaterial.cpp index 6906177e0..d738e1592 100644 --- a/src/render/defaults/qdiffusemapmaterial.cpp +++ b/src/render/defaults/qdiffusemapmaterial.cpp @@ -132,7 +132,7 @@ void QDiffuseMapMaterialPrivate::init() \class Qt3DRender::QDiffuseMapMaterial \brief The QDiffuseMapMaterial provides a default implementation of the phong lighting effect where the diffuse light component is read from a texture map. - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular. diff --git a/src/render/defaults/qdiffusespecularmapmaterial.cpp b/src/render/defaults/qdiffusespecularmapmaterial.cpp index c03664681..746739ed3 100644 --- a/src/render/defaults/qdiffusespecularmapmaterial.cpp +++ b/src/render/defaults/qdiffusespecularmapmaterial.cpp @@ -140,7 +140,7 @@ void QDiffuseSpecularMapMaterialPrivate::init() \class Qt3DRender::QDiffuseSpecularMapMaterial \brief The QDiffuseSpecularMapMaterial provides a default implementation of the phong lighting and bump effect where the diffuse and specular light components are read from texture maps. - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular. diff --git a/src/render/defaults/qgoochmaterial.cpp b/src/render/defaults/qgoochmaterial.cpp index 30e196fc7..d35bbb68d 100644 --- a/src/render/defaults/qgoochmaterial.cpp +++ b/src/render/defaults/qgoochmaterial.cpp @@ -132,7 +132,7 @@ void QGoochMaterialPrivate::init() \class Qt3DRender::QGoochMaterial \brief The QGoochMaterial provides a material that implements the Gooch shading model, popular in CAD and CAM applications. - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 The Gooch lighting model uses both color and brightness to help show the @@ -174,7 +174,7 @@ QGoochMaterial::QGoochMaterial(QGoochMaterialPrivate &dd, QNode *parent) } /*! - \property Qt3DCore::QGoochMaterial::diffuse + \property Qt3DRender::QGoochMaterial::diffuse Holds the current diffuse color. */ @@ -185,7 +185,7 @@ QColor QGoochMaterial::diffuse() const } /*! - \property Qt3DCore::QGoochMaterial::specular + \property Qt3DRender::QGoochMaterial::specular Holds the current specular color. */ @@ -196,7 +196,7 @@ QColor QGoochMaterial::specular() const } /*! - \property Qt3DCore::QGoochMaterial::cool + \property Qt3DRender::QGoochMaterial::cool Holds the current cool color. */ @@ -207,7 +207,7 @@ QColor QGoochMaterial::cool() const } /*! - \property Qt3DCore::QGoochMaterial::warm + \property Qt3DRender::QGoochMaterial::warm Holds the current warm color. */ @@ -218,7 +218,7 @@ QColor QGoochMaterial::warm() const } /*! - \property Qt3DCore::QGoochMaterial::alpha + \property Qt3DRender::QGoochMaterial::alpha Holds the current alpha value. The start point of the color ramp used by the Gooch shader is calculated as {c = cool + alpha * diffuse}. @@ -230,7 +230,7 @@ float QGoochMaterial::alpha() const } /*! - \property Qt3DCore::QGoochMaterial::beta + \property Qt3DRender::QGoochMaterial::beta Holds the current beta value. The start point of the color ramp used by the Gooch shader is calculated as {c = warm + beta * diffuse}. @@ -242,7 +242,7 @@ float QGoochMaterial::beta() const } /*! - \property Qt3DCore::QGoochMaterial::shininess + \property Qt3DRender::QGoochMaterial::shininess Holds the current shininess value. Higher values of shininess result in a smaller and brighter highlight. diff --git a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp index c67dc3bfe..602a111d7 100644 --- a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp +++ b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp @@ -129,7 +129,7 @@ void QNormalDiffuseMapAlphaMaterialPrivate::init() \brief The QNormalDiffuseMapAlphaMaterial provides a default implementation of the phong lighting and bump effect where the diffuse light component is read from a texture map and the normals of the mesh being rendered from a normal texture map. In addition, it defines an alpha to coverage and a depth test to be performed in the rendering pass. - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular. diff --git a/src/render/defaults/qnormaldiffusemapmaterial.cpp b/src/render/defaults/qnormaldiffusemapmaterial.cpp index b31337053..259ac54d8 100644 --- a/src/render/defaults/qnormaldiffusemapmaterial.cpp +++ b/src/render/defaults/qnormaldiffusemapmaterial.cpp @@ -141,7 +141,7 @@ void QNormalDiffuseMapMaterialPrivate::init() \class Qt3DRender::QNormalDiffuseMapMaterial \brief The QNormalDiffuseMapMaterial provides a default implementation of the phong lighting and bump effect where the diffuse light component is read from a texture map and the normals of the mesh being rendered from a normal texture map. - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular. diff --git a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp index 420f22a7d..8f263153d 100644 --- a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp +++ b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp @@ -147,7 +147,7 @@ void QNormalDiffuseSpecularMapMaterialPrivate::init() \class Qt3DRender::QNormalDiffuseSpecularMapMaterial \brief The QNormalDiffuseSpecularMapMaterial provides a default implementation of the phong lighting and bump effect where the diffuse and specular light components are read from texture maps and the normals of the mesh being rendered from a normal texture map. - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular. diff --git a/src/render/defaults/qpervertexcolormaterial.cpp b/src/render/defaults/qpervertexcolormaterial.cpp index 27f7de224..5ea8f9fbf 100644 --- a/src/render/defaults/qpervertexcolormaterial.cpp +++ b/src/render/defaults/qpervertexcolormaterial.cpp @@ -74,7 +74,7 @@ QPerVertexColorMaterialPrivate::QPerVertexColorMaterialPrivate() /*! \class Qt3DRender::QPerVertexColorMaterial \brief The QPerVertexColorMaterial class provides a default implementation for rendering the color properties set for each vertex. - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 This lighting effect is based on the combination of 2 lighting components ambient and diffuse. Ambient is set by the vertex color. @@ -90,7 +90,7 @@ QPerVertexColorMaterialPrivate::QPerVertexColorMaterialPrivate() */ /*! - \fn Qt3DRender::QPerVertexColorMaterial::QPerVertexColorMaterial(QNode *parent) + \fn Qt3DRender::QPerVertexColorMaterial::QPerVertexColorMaterial(Qt3DCore::QNode *parent) Constructs a new QPerVertexColorMaterial instance with parent object \a parent. */ diff --git a/src/render/defaults/qphongmaterial.cpp b/src/render/defaults/qphongmaterial.cpp index 2a4663f27..4c08d3713 100644 --- a/src/render/defaults/qphongmaterial.cpp +++ b/src/render/defaults/qphongmaterial.cpp @@ -78,7 +78,7 @@ QPhongMaterialPrivate::QPhongMaterialPrivate() /*! \class Qt3DRender::QPhongMaterial \brief The QPhongMaterial class provides a default implementation of the phong lighting effect. - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 The phong lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular. @@ -96,7 +96,7 @@ QPhongMaterialPrivate::QPhongMaterialPrivate() */ /*! - \fn Qt3DRender::QPhongMaterial::QPhongMaterial(QNode *parent) + \fn Qt3DRender::QPhongMaterial::QPhongMaterial(Qt3DCore::QNode *parent) Constructs a new QPhongMaterial instance with parent object \a parent. */ @@ -143,7 +143,7 @@ QColor QPhongMaterial::diffuse() const } /*! - \property QColor Qt3DRender::QPhongMaterial::specular + \property Qt3DRender::QPhongMaterial::specular Holds the specular color. */ diff --git a/src/render/defaults/qskyboxentity.cpp b/src/render/defaults/qskyboxentity.cpp index 740a3f14a..39a68723b 100644 --- a/src/render/defaults/qskyboxentity.cpp +++ b/src/render/defaults/qskyboxentity.cpp @@ -181,9 +181,9 @@ void QSkyboxEntityPrivate::reloadTexture() /*! * \class Qt3DRender::QSkyboxEntity - * \inmodule Qt3DRenderer + * \inmodule Qt3DRender * - * \brief Qt3DCore::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can + * \brief Qt3DRender::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can * be used to insert a skybox in a 3D scene. * * By specifying a base name and an extension, Qt3DCore::QSkyboxEntity diff --git a/src/render/framegraph/qcameraselector.cpp b/src/render/framegraph/qcameraselector.cpp index d223c2ac0..6515cc0d1 100644 --- a/src/render/framegraph/qcameraselector.cpp +++ b/src/render/framegraph/qcameraselector.cpp @@ -45,7 +45,8 @@ QT_BEGIN_NAMESPACE namespace Qt3DRender { /*! - \class Qt3DRender::CameraSelector + \class Qt3DRender::QCameraSelector + \inmodule Qt3DRender */ /*! \internal */ @@ -81,6 +82,9 @@ QCameraSelector::~QCameraSelector() QNode::cleanup(); } +/*! + \property Qt3DRender::QCameraSelector::camera +*/ void QCameraSelector::setCamera(Qt3DCore::QEntity *camera) { Q_D(QCameraSelector); diff --git a/src/render/framegraph/qframegraph.cpp b/src/render/framegraph/qframegraph.cpp index 080d83e48..c1a338211 100644 --- a/src/render/framegraph/qframegraph.cpp +++ b/src/render/framegraph/qframegraph.cpp @@ -56,13 +56,13 @@ QFrameGraphPrivate::QFrameGraphPrivate() } /*! - \class FrameGraph - \inmodule Qt3DRenderer + \class Qt3DRender::QFrameGraph + \inmodule Qt3DRender \since 5.3 - \brief Defines the rendering method to be used by the renderer + \brief Defines the rendering method to be used by the renderer. - FrameGraph is the Component that has an activeFrameGraph property + QFrameGraph is the 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 be used by the renderer. @@ -79,7 +79,9 @@ QFrameGraphPrivate::QFrameGraphPrivate() \brief For OpenGL ... */ -/*! \fn void Qt3DRender::QFrameGraph::copy(const QNode *ref) +/*! + \fn void Qt3DRender::QFrameGraph::copy(const Qt3DCore::QNode *ref) + Copies the \a ref instance into this one. */ void QFrameGraph::copy(const QNode *ref) @@ -90,7 +92,8 @@ void QFrameGraph::copy(const QNode *ref) } /*! - \fn Qt3DRender::QFrameGraph::QFrameGraph(QNode *parent) + \fn Qt3DRender::QFrameGraph::QFrameGraph(Qt3DCore::QNode *parent) + Constructs a new QFrameGraph with the specified \a parent. */ QFrameGraph::QFrameGraph(QNode *parent) @@ -110,7 +113,7 @@ QFrameGraph::QFrameGraph(QFrameGraphPrivate &dd, QNode *parent) } /*! - \qmlproperty Qt3D.Renderer::FrameGraphNode Qt3D.Renderer::FrameGraph::activeFrameGraph + \qmlproperty FrameGraphNode Qt3D.Render::FrameGraph::activeFrameGraph Holds the current activeFrameGraph root node. */ diff --git a/src/render/framegraph/qframegraphnode.cpp b/src/render/framegraph/qframegraphnode.cpp index acddc838e..18d191b38 100644 --- a/src/render/framegraph/qframegraphnode.cpp +++ b/src/render/framegraph/qframegraphnode.cpp @@ -52,8 +52,8 @@ QFrameGraphNodePrivate::QFrameGraphNodePrivate() } /*! - \class QFrameGraphNode - \inmodule Qt3DRenderer + \class Qt3DRender::QFrameGraphNode + \inmodule Qt3DRender \since 5.5 \brief Base class of all FrameGraph configuration nodes. @@ -66,7 +66,7 @@ QFrameGraphNodePrivate::QFrameGraphNodePrivate() /*! \qmltype FrameGraphNode \inqmlmodule Qt3D.Render - \instantiates QFrameGraphNode + \instantiates Qt3DRender::QFrameGraphNode \inherits Node \since 5.5 \qmlabstract @@ -108,7 +108,7 @@ QFrameGraphNode::QFrameGraphNode(QFrameGraphNodePrivate &dd, QNode *parent) } /*! - \qmlproperty bool Qt3D.Renderer::FrameGraphNode::enabled + \qmlproperty bool Qt3D.Render::FrameGraphNode::enabled Holds whether the frame graph node is enabled or disabled. */ diff --git a/src/render/framegraph/qframegraphselector.cpp b/src/render/framegraph/qframegraphselector.cpp index 6d2dc7e6e..c612bd8ca 100644 --- a/src/render/framegraph/qframegraphselector.cpp +++ b/src/render/framegraph/qframegraphselector.cpp @@ -52,7 +52,7 @@ QFrameGraphSelectorPrivate::QFrameGraphSelectorPrivate() /*! \class Qt3DRender::QFrameGraphSelector - \inmodule Qt3DRenderer + \inmodule Qt3DRender \brief Qt3DRender::QFrameGraphSelector provide a way to select a one or more subtree of the FrameGraph at runtime diff --git a/src/render/framegraph/qlayerfilter.cpp b/src/render/framegraph/qlayerfilter.cpp index 9c9ab58cd..1bb3fea09 100644 --- a/src/render/framegraph/qlayerfilter.cpp +++ b/src/render/framegraph/qlayerfilter.cpp @@ -52,8 +52,8 @@ QLayerFilterPrivate::QLayerFilterPrivate() } /*! - \class QLayerFilter - \inmodule Qt3DRenderer + \class Qt3DRender::QLayerFilter + \inmodule Qt3DRender \since 5.5 \brief The QLayerFilter class provides ... */ @@ -67,7 +67,7 @@ QLayerFilterPrivate::QLayerFilterPrivate() \brief For ... */ -/*! \fn void Qt3DRender::QLayerFilter::copy(const QNode *ref) +/*! \fn void Qt3DRender::QLayerFilter::copy(const Qt3DCore::QNode *ref) Copies the \a ref instance into this one. */ void QLayerFilter::copy(const QNode *ref) @@ -78,7 +78,7 @@ void QLayerFilter::copy(const QNode *ref) } -/*! \fn Qt3DRender::QLayerFilter::QLayerFilter(QNode *parent) +/*! \fn Qt3DRender::QLayerFilter::QLayerFilter(Qt3DCore::QNode *parent) Constructs a new QLayerFilter with the specified \a parent. */ QLayerFilter::QLayerFilter(QNode *parent) @@ -103,7 +103,7 @@ QLayerFilter::QLayerFilter(QLayerFilterPrivate &dd, QNode *parent) */ /*! - \qmlproperty stringlist Qt3D.Renderer::LayerFilter::layers + \qmlproperty stringlist Qt3D.Render::LayerFilter::layers */ diff --git a/src/render/framegraph/qnodraw.cpp b/src/render/framegraph/qnodraw.cpp index 2e9137ffe..5d3b9107d 100644 --- a/src/render/framegraph/qnodraw.cpp +++ b/src/render/framegraph/qnodraw.cpp @@ -41,12 +41,13 @@ QT_BEGIN_NAMESPACE namespace Qt3DRender { /*! - * \class Qt3DRender::QNoDraw::QNoDraw + * \class Qt3DRender::QNoDraw + * \inmodule Qt3DRender * - * \brief When a Qt3DCore::QNoDraw node is present in a FrameGraph branch, this + * \brief When a QNoDraw node is present in a FrameGraph branch, this * prevents the renderer from rendering any primitive. * - * Qt3DCore::QNoDraw should be used when the FrameGraph needs to set up some render + * QNoDraw should be used when the FrameGraph needs to set up some render * states or clear some buffers without requiring any mesh to be drawn. It has * the same effect as having a Qt3DRender::QRenderPassFilter that matches none of * available Qt3DRender::QRenderPass instances of the scene without the overhead cost diff --git a/src/render/framegraph/qstateset.cpp b/src/render/framegraph/qstateset.cpp index 3e9bdbe0f..1ddded123 100644 --- a/src/render/framegraph/qstateset.cpp +++ b/src/render/framegraph/qstateset.cpp @@ -46,6 +46,10 @@ using namespace Qt3DCore; namespace Qt3DRender { +/*! + \class Qt3DRender::QStateSetPrivate + \internal +*/ QStateSetPrivate::QStateSetPrivate() : QFrameGraphNodePrivate() { @@ -55,19 +59,19 @@ QStateSetPrivate::QStateSetPrivate() * \class Qt3DRender::QStateSet * \inmodule Qt3DRender * - * \brief The Qt3DCore::QStateSet FrameGraph node offers a way of specifying a set - * of Qt3DCore::QRenderState to be applied during the execution of a FrameGraph - * branch. + * \brief The QStateSet \l {QFrameGraphNode}{FrameGraph} node offers a way of + * specifying a set of QRenderState objects to be applied during the execution + * of a framegraph branch. * - * States set on a Qt3DCore::QStateSet are set globally, contrary to the per - * Material states that can be set on a Qt3DRender::QRenderPass. By default an empty - * Qt3DCore::QStateSet will result in all render states being disabled when - * executed. Adding a Qt3DCore::QRenderState state explicitly enables that render + * States set on a QStateSet are set globally, contrary to the per-material + * states that can be set on a QRenderPass. By default, an empty + * QStateSet will result in all render states being disabled when + * executed. Adding a QRenderState state explicitly enables that render * state at runtime. * * \since 5.5 * - * \sa Qt3DCore::QRenderState, Qt3DRender::QRenderPass + * \sa QRenderState, QRenderPass */ QStateSet::QStateSet(QNode *parent) @@ -95,9 +99,9 @@ void QStateSet::copy(const QNode *ref) } /*! - * Adds a new Qt3DCore::QRenderState \a state to the Qt3DCore::QStateSet instance. + * Adds a new QRenderState \a state to the QStateSet instance. * - * \note Not setting any Qt3DCore::QRenderState state on a Qt3DCore::QStateSet instance + * \note Not setting any QRenderState state on a QStateSet instance * implies all the render states will be disabled at render time. */ void QStateSet::addRenderState(QRenderState *state) @@ -121,7 +125,7 @@ void QStateSet::addRenderState(QRenderState *state) } /*! - * Removes the Qt3DCore::QRenderState \a state from the Qt3DCore::QStateSet instance. + * Removes the QRenderState \a state from the QStateSet instance. */ void QStateSet::removeRenderState(QRenderState *state) { @@ -136,7 +140,7 @@ void QStateSet::removeRenderState(QRenderState *state) } /*! - * Returns the list of Qt3DCore::QRenderState that compose the Qt3DCore::QStateSet instance. + * Returns the list of QRenderState objects that compose the QStateSet instance. */ QList QStateSet::renderStates() const { diff --git a/src/render/frontend/qlayer.cpp b/src/render/frontend/qlayer.cpp index 64e8faa22..107b9d250 100644 --- a/src/render/frontend/qlayer.cpp +++ b/src/render/frontend/qlayer.cpp @@ -51,8 +51,8 @@ QLayerPrivate::QLayerPrivate() } /*! - \class QLayer - \inmodule Qt3DRenderer + \class Qt3DRender::QLayer + \inmodule Qt3DRender \since 5.5 \brief The QLayer class provides ... */ @@ -67,7 +67,7 @@ QLayerPrivate::QLayerPrivate() */ -/*! \fn void Qt3DRender::QLayer::copy(const QNode *ref) +/*! \fn void Qt3DRender::QLayer::copy(const Qt3DCore::QNode *ref) Copies the \a ref instance into this one. */ void QLayer::copy(const QNode *ref) @@ -77,7 +77,7 @@ void QLayer::copy(const QNode *ref) d_func()->m_names = layer->d_func()->m_names; } -/*! \fn Qt3DRender::QLayer::QLayer(QObject *parent) +/*! \fn Qt3DRender::QLayer::QLayer(Qt3DCore::QNode *parent) Constructs a new QLayer with the specified \a parent. */ @@ -103,7 +103,7 @@ QLayer::QLayer(QLayerPrivate &dd, QNode *parent) */ /*! - \qmlproperty stringlist Qt3D.Renderer::Layer::names + \qmlproperty stringlist Qt3D.Render::Layer::names */ diff --git a/src/render/io/qabstractsceneloader.cpp b/src/render/io/qabstractsceneloader.cpp index debae5c89..6c90c15ad 100644 --- a/src/render/io/qabstractsceneloader.cpp +++ b/src/render/io/qabstractsceneloader.cpp @@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE namespace Qt3DRender { /*! - \class Qt3DRender::Render::QAbstractSceneLoaderPrivate + \class Qt3DRender::QAbstractSceneLoaderPrivate \internal */ QAbstractSceneLoaderPrivate::QAbstractSceneLoaderPrivate() diff --git a/src/render/lights/qabstractlight.cpp b/src/render/lights/qabstractlight.cpp index a5f1a6c47..b0132e43a 100644 --- a/src/render/lights/qabstractlight.cpp +++ b/src/render/lights/qabstractlight.cpp @@ -45,7 +45,7 @@ namespace Qt3DRender /*! * \qmltype AbstractLight * \inqmlmodule Qt3D.Render - * \instantiates QAbstractLight + * \instantiates Qt3DRender::QAbstractLight * \brief Encapsulate a QAbstractLight object in a Qt 3D scene. * \since 5.3 */ @@ -92,7 +92,7 @@ QAbstractLight::QAbstractLight(QAbstractLightPrivate &dd, QNode *parent) /*! - * \property Qt3DCore::QAbstractLight::color + * \property Qt3DRender::QAbstractLight::color * * Holds the current QAbstractLight color. */ @@ -112,7 +112,7 @@ void QAbstractLight::setColor(const QColor &color) } /*! - \property Qt3DCore::QAbstractLight::intensity + \property Qt3DRender::QAbstractLight::intensity Holds the current QAbstractLight intensity. */ @@ -132,7 +132,7 @@ void QAbstractLight::setIntensity(float intensity) } /*! - \property Qt3DCore::QAbstractLight::position + \property Qt3DRender::QAbstractLight::position Holds the current QAbstractLight position. */ diff --git a/src/render/lights/qdirectionallight.cpp b/src/render/lights/qdirectionallight.cpp index c523215a9..2e3f91714 100644 --- a/src/render/lights/qdirectionallight.cpp +++ b/src/render/lights/qdirectionallight.cpp @@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE namespace Qt3DRender { -/*! +/* * * Expected Shader struct * diff --git a/src/render/lights/qpointlight.cpp b/src/render/lights/qpointlight.cpp index 2fb6755cf..21ff60aa0 100644 --- a/src/render/lights/qpointlight.cpp +++ b/src/render/lights/qpointlight.cpp @@ -68,8 +68,8 @@ QPointLightPrivate::QPointLightPrivate() } /*! - \class QPointLight - \inmodule Qt3DRenderer + \class Qt3DRender::QPointLight + \inmodule Qt3DRender \since 5.5 */ @@ -84,7 +84,7 @@ QPointLightPrivate::QPointLightPrivate() */ /*! - \fn Qt3DRender::QPointLight::QPointLight(QNode *parent) + \fn Qt3DRender::QPointLight::QPointLight(Qt3DCore::QNode *parent) Constructs a new QPointLight with the specified \a parent. */ QPointLight::QPointLight(QNode *parent) diff --git a/src/render/lights/qspotlight.cpp b/src/render/lights/qspotlight.cpp index b8f360bf4..ab0d822e7 100644 --- a/src/render/lights/qspotlight.cpp +++ b/src/render/lights/qspotlight.cpp @@ -73,8 +73,8 @@ QSpotLightPrivate::QSpotLightPrivate() } /*! - \class QSpotLight - \inmodule Qt3DRenderer + \class Qt3DRender::QSpotLight + \inmodule Qt3DRender \since 5.5 */ @@ -88,7 +88,7 @@ QSpotLightPrivate::QSpotLightPrivate() \brief For OpenGL ... */ -/*! \fn void Qt3DCore::QSpotLight::copy(const QNode *ref) +/*! \fn void Qt3DRender::QSpotLight::copy(const Qt3DCore::QNode *ref) Copies the \a ref instance into this one. */ @@ -104,7 +104,7 @@ void QSpotLight::copy(const QNode *ref) /*! - \fn Qt3DCore::QSpotLight::QSpotLight(QNode *parent) + \fn Qt3DRender::QSpotLight::QSpotLight(Qt3DCore::QNode *parent) Constructs a new QSpotLight with the specified \a parent. */ QSpotLight::QSpotLight(QNode *parent) @@ -119,12 +119,12 @@ QSpotLight::QSpotLight(QSpotLightPrivate &dd, QNode *parent) } /*! - \qmlproperty vector3d Qt3D.Renderer::SpotLight::direction + \qmlproperty vector3d Qt3D.Render::SpotLight::direction */ /*! - \property Qt3DCore::QSpotLight::direction + \property Qt3DRender::QSpotLight::direction */ @@ -136,12 +136,12 @@ QSpotLight::QSpotLight(QSpotLightPrivate &dd, QNode *parent) /*! - \qmlproperty float Qt3D.Renderer::SpotLight::cutOffAngle + \qmlproperty float Qt3D.Render::SpotLight::cutOffAngle */ /*! - \property Qt3DCore::QSpotLight::cutOffAngle + \property Qt3DRender::QSpotLight::cutOffAngle */ float QSpotLight::cutOffAngle() const diff --git a/src/render/materialsystem/qannotation.cpp b/src/render/materialsystem/qannotation.cpp index 642e0c8c2..6c85da927 100644 --- a/src/render/materialsystem/qannotation.cpp +++ b/src/render/materialsystem/qannotation.cpp @@ -55,7 +55,7 @@ QAnnotationPrivate::QAnnotationPrivate() /*! \class Qt3DRender::QAnnotation - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief The QAnnotation class provides ... */ @@ -117,7 +117,7 @@ void QAnnotation::setName(const QString &name) */ /*! - \qmlproperty variant Qt3D.Renderer::Annotation::value + \qmlproperty variant Qt3D.Render::Annotation::value */ QVariant QAnnotation::value() const @@ -132,7 +132,7 @@ QVariant QAnnotation::value() const */ /*! - \qmlproperty string Qt3D.Renderer::Annotation::name + \qmlproperty string Qt3D.Render::Annotation::name */ QString QAnnotation::name() const diff --git a/src/render/materialsystem/qgraphicsapifilter.cpp b/src/render/materialsystem/qgraphicsapifilter.cpp index 21f5468f0..127426f62 100644 --- a/src/render/materialsystem/qgraphicsapifilter.cpp +++ b/src/render/materialsystem/qgraphicsapifilter.cpp @@ -280,9 +280,10 @@ void QGraphicsApiFilter::setVendor(const QString &vendor) } } -/*! \fn bool Qt3DCore::operator ==(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample) +/*! \fn bool Qt3DRender::operator ==(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample) \relates Qt3DRender::QGraphicsApiFilter - Returns true if \a reference and \a sample are equivalent. + + Returns \c true if \a reference and \a sample are equivalent. */ bool operator ==(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample) { @@ -302,9 +303,10 @@ bool operator ==(const QGraphicsApiFilter &reference, const QGraphicsApiFilter & return false; } -/*! \fn bool Qt3DCore::operator !=(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample) +/*! \fn bool Qt3DRender::operator !=(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample) \relates Qt3DRender::QGraphicsApiFilter - Returns true if \a reference and \a sample are different. + + Returns \c true if \a reference and \a sample are different. */ bool operator !=(const QGraphicsApiFilter &reference, const QGraphicsApiFilter &sample) { diff --git a/src/render/materialsystem/qmaterial.cpp b/src/render/materialsystem/qmaterial.cpp index e0ab55019..48d7f3845 100644 --- a/src/render/materialsystem/qmaterial.cpp +++ b/src/render/materialsystem/qmaterial.cpp @@ -44,7 +44,7 @@ /*! * \class Qt3DRender::QMaterial - * \inmodule Qt3DRenderer + * \inmodule Qt3DRender * * \inherits Component * diff --git a/src/render/materialsystem/qparametermapping.cpp b/src/render/materialsystem/qparametermapping.cpp index 1583983e2..95234889c 100644 --- a/src/render/materialsystem/qparametermapping.cpp +++ b/src/render/materialsystem/qparametermapping.cpp @@ -52,7 +52,7 @@ QParameterMappingPrivate::QParameterMappingPrivate() } /*! \class Qt3DRender::QParameterMapping - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief The QParameterMapping class provides ... */ @@ -66,7 +66,7 @@ QParameterMappingPrivate::QParameterMappingPrivate() \brief For ... */ -/*! \fn void Qt3DRender::QParameterMapping::copy(const QNode *ref) +/*! \fn void Qt3DRender::QParameterMapping::copy(const Qt3DCore::QNode *ref) Copies the \a ref instance into this one. */ void QParameterMapping::copy(const QNode *ref) @@ -78,7 +78,7 @@ void QParameterMapping::copy(const QNode *ref) d_func()->m_bindingType = mapper->d_func()->m_bindingType; } -/*! \fn Qt3DRender::QParameterMapping::QParameterMapping(QNode *parent) +/*! \fn Qt3DRender::QParameterMapping::QParameterMapping(Qt3DCore::QNode *parent) Constructs a new QParameterMapping with the specified \a parent. */ QParameterMapping::QParameterMapping(QNode *parent) @@ -126,7 +126,7 @@ QParameterMapping::~QParameterMapping() */ /*! - \qmlproperty string Qt3D.Renderer::ParameterMapping::parameterName + \qmlproperty string Qt3D.Render::ParameterMapping::parameterName */ @@ -145,7 +145,7 @@ void QParameterMapping::setParameterName(const QString &name) */ /*! - \qmlproperty string Qt3D.Renderer::ParameterMapping::shaderVariableName + \qmlproperty string Qt3D.Render::ParameterMapping::shaderVariableName */ @@ -164,7 +164,7 @@ void QParameterMapping::setShaderVariableName(const QString &name) */ /*! - \qmlproperty BindingType Qt3D.Renderer::ParameterMapping::bindingType + \qmlproperty BindingType Qt3D.Render::ParameterMapping::bindingType \value Uniform \value Attribute diff --git a/src/render/materialsystem/qrenderpass.cpp b/src/render/materialsystem/qrenderpass.cpp index 13cee24d0..b7d07f88f 100644 --- a/src/render/materialsystem/qrenderpass.cpp +++ b/src/render/materialsystem/qrenderpass.cpp @@ -105,7 +105,7 @@ ParameterList QRenderPass::uniforms() const /*! * Sets the pass's \a shaderProgram. This posts a ComponentUpdated * QScenePropertyChange to the QChangeArbiter. The value is set to - * the \a ShaderProgram and the property name to "shaderProgram". + * the \a shaderProgram and the property name to \c {"shaderProgram"}. */ void QRenderPass::setShaderProgram(QShaderProgram *shaderProgram) { diff --git a/src/render/materialsystem/qshaderdata.cpp b/src/render/materialsystem/qshaderdata.cpp index 848b54bf8..87b7b2d74 100644 --- a/src/render/materialsystem/qshaderdata.cpp +++ b/src/render/materialsystem/qshaderdata.cpp @@ -51,10 +51,6 @@ QShaderDataPrivate::QShaderDataPrivate() { } -/*! - \class Qt3DRender::QShaderDataPrivate - \internal -*/ QShaderDataPrivate::QShaderDataPrivate(PropertyReaderInterfacePtr reader) : QComponentPrivate() , m_propertyReader(reader) @@ -63,14 +59,15 @@ QShaderDataPrivate::QShaderDataPrivate(PropertyReaderInterfacePtr reader) /*! * \class Qt3DRender::QShaderData - * \inmodule Qt3DRenderer + * \inmodule Qt3DRender * * \brief Provides a way of specifying values of a Uniform Block or a shader * structure. * - * \note When subclassing and adding properties to Qt3DRender::QShaderData, please note - * that if you need to nest an inner Qt3DRender::QShaderData, the data type of the - * property should be Qt3DRender::QShaderData* instead of the name of your subclass. + * \note When subclassing and adding properties to QShaderData, note that if + * you need to nest an inner Qt3DRender::QShaderData, the data type of the + * property should be Qt3DRender::QShaderData* instead of the name of your + * subclass. * * \since 5.5 */ diff --git a/src/render/materialsystem/qshaderprogram.cpp b/src/render/materialsystem/qshaderprogram.cpp index e92a77d90..da0de2422 100644 --- a/src/render/materialsystem/qshaderprogram.cpp +++ b/src/render/materialsystem/qshaderprogram.cpp @@ -85,7 +85,7 @@ QShaderProgram::QShaderProgram(QShaderProgramPrivate &dd, QNode *parent) } /*! - * Sets the vertexShader from raw data in \a vertexShader. + * Sets the vertex shader from raw data in \a vertexShaderCode. */ void QShaderProgram::setVertexShaderCode(const QByteArray &vertexShaderCode) { @@ -148,7 +148,7 @@ QByteArray QShaderProgram::geometryShaderCode() const } /*! - * Sets the fragmentShader from raw data in \a fragmentShader. + * Sets the fragment shader from raw data in \a fragmentShaderCode. */ void QShaderProgram::setFragmentShaderCode(const QByteArray &fragmentShaderCode) { diff --git a/src/render/picking/qobjectpicker.cpp b/src/render/picking/qobjectpicker.cpp index da13baace..6213c6d0b 100644 --- a/src/render/picking/qobjectpicker.cpp +++ b/src/render/picking/qobjectpicker.cpp @@ -46,16 +46,17 @@ namespace Qt3DRender { /*! \class Qt3DRender::QObjectPicker + \inmodule Qt3DRender - \brief The Qt3DRender::QObjectPicker class instantiates a component that can - be used to interact with a Qt3DCore::QEntity by a process known as picking. + \brief The QObjectPicker class instantiates a component that can + be used to interact with a QEntity by a process known as picking. - The signals pressed(), released(), clicked(), entered(), exited() are + The signals pressed(), released(), clicked(), entered(), and exited() are emitted when the bounding volume defined by the pickAttribute property intersects with a ray. \note Instances of this component shouldn't be shared, not respecting that - condition will most likely result in undefined behaviors. + condition will most likely result in undefined behavior. \since 5.6 */ @@ -80,9 +81,6 @@ namespace Qt3DRender { \qmlsignal Qt3D.Render::ObjectPicker::exited() */ -/*! - \internal -*/ class QObjectPickerPrivate : public Qt3DCore::QComponentPrivate { public: diff --git a/src/render/renderstates/qblendstate.cpp b/src/render/renderstates/qblendstate.cpp index c507e9a5e..bc75aa3ce 100644 --- a/src/render/renderstates/qblendstate.cpp +++ b/src/render/renderstates/qblendstate.cpp @@ -66,7 +66,7 @@ public: /*! \class Qt3DRender::QBlendState - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief Encapsulates blending information. */ @@ -77,7 +77,7 @@ public: \inherits RenderState \inqmlmodule Qt3D.Render \since 5.5 - \brief Encapsulates blending information + \brief Encapsulates blending information. */ /*! @@ -93,7 +93,7 @@ QBlendState::~QBlendState() QNode::cleanup(); } -/*! \fn void QBlendState::copy(const QNode *ref) +/*! \fn void QBlendState::copy(const Qt3DCore::QNode *ref) \internal Copies \a ref into this object. */ @@ -116,7 +116,7 @@ QBlendState::QBlendState(QRenderState::Type type, QNode *parent) } /*! - \enum Qt3DCore::QBlendState::Blending + \enum Qt3DRender::QBlendState::Blending \value Zero 0 \value One 1 @@ -140,12 +140,12 @@ QBlendState::QBlendState(QRenderState::Type type, QNode *parent) */ /*! - \qmlproperty enumeration Qt3D.render::BlendState::srcRGB + \qmlproperty enumeration Qt3D.Render::BlendState::srcRGB */ /*! - \property Qt3DCore::QBlendState::srcRGB + \property Qt3DRender::QBlendState::srcRGB */ QBlendState::Blending QBlendState::srcRGB() const @@ -164,12 +164,12 @@ void QBlendState::setSrcRGB(QBlendState::Blending srcRGB) } /*! - \qmlproperty enumeration Qt3D.render::BlendState::dstRGB + \qmlproperty enumeration Qt3D.Render::BlendState::dstRGB */ /*! - \property Qt3DCore::QBlendState::dstRGB + \property Qt3DRender::QBlendState::dstRGB */ QBlendState::Blending QBlendState::dstRGB() const @@ -188,12 +188,12 @@ void QBlendState::setDstRGB(QBlendState::Blending dstRGB) } /*! - \qmlproperty enumeration Qt3D.render::BlendState::srcAlpha + \qmlproperty enumeration Qt3D.Render::BlendState::srcAlpha */ /*! - \property Qt3DCore::QBlendState::srcAlpha + \property Qt3DRender::QBlendState::srcAlpha */ QBlendState::Blending QBlendState::srcAlpha() const @@ -212,12 +212,12 @@ void QBlendState::setSrcAlpha(QBlendState::Blending srcAlpha) } /*! - \qmlproperty enumeration Qt3D.render::BlendState::dstAlpha + \qmlproperty enumeration Qt3D.Render::BlendState::dstAlpha */ /*! - \property Qt3DCore::QBlendState::dstAlpha + \property Qt3DRender::QBlendState::dstAlpha */ QBlendState::Blending QBlendState::dstAlpha() const @@ -236,8 +236,8 @@ void QBlendState::setDstAlpha(QBlendState::Blending dstAlpha) } /*! - \class QBlendStateSeparate - \inmodule Qt3DRenderer + \class Qt3DRender::QBlendStateSeparate + \inmodule Qt3DRender \since 5.5 \brief Encapsulates blending information. */ @@ -248,11 +248,11 @@ void QBlendState::setDstAlpha(QBlendState::Blending dstAlpha) \inherits RenderState \inqmlmodule Qt3D.Render \since 5.5 - \brief Encapsulates blending information + \brief Encapsulates blending information. */ /*! - The constructor creates a QBlendStateSeparate with the + The constructor creates a QBlendStateSeparate instance with the specified \a parent. */ QBlendStateSeparate::QBlendStateSeparate(QNode *parent) diff --git a/src/render/renderstates/qclipplane.cpp b/src/render/renderstates/qclipplane.cpp index 3850a9dc7..94f2572fd 100644 --- a/src/render/renderstates/qclipplane.cpp +++ b/src/render/renderstates/qclipplane.cpp @@ -54,7 +54,7 @@ public: /*! \class Qt3DRender::QClipPlane - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief Enables an additional OpenGL clipping plane that can be in shaders using gl_ClipDistance diff --git a/src/render/renderstates/qcolormask.cpp b/src/render/renderstates/qcolormask.cpp index d517d30bc..4c9fabd78 100644 --- a/src/render/renderstates/qcolormask.cpp +++ b/src/render/renderstates/qcolormask.cpp @@ -62,7 +62,7 @@ public: /*! \class Qt3DRender::QColorMask - \inmodule Qt3DRenderer + \inmodule Qt3DRender \brief Allows specifying which color components should be written to the currently bound frame buffer. @@ -112,7 +112,7 @@ bool QColorMask::isAlpha() const } /*! - \property Qt3DCore::QColorMask::red + \property Qt3DRender::QColorMask::red Holds whether the red color component should be written to the frame buffer. */ void QColorMask::setRed(bool red) @@ -125,7 +125,7 @@ void QColorMask::setRed(bool red) } /*! - \property Qt3DCore::QColorMask::green + \property Qt3DRender::QColorMask::green Holds whether the green color component should be written to the frame buffer. */ void QColorMask::setGreen(bool green) @@ -138,7 +138,7 @@ void QColorMask::setGreen(bool green) } /*! - \property Qt3DCore::QColorMask::blue + \property Qt3DRender::QColorMask::blue Holds whether the blue color component should be written to the frame buffer. */ void QColorMask::setBlue(bool blue) @@ -151,7 +151,7 @@ void QColorMask::setBlue(bool blue) } /*! - \property Qt3DCore::QColorMask::alpha + \property Qt3DRender::QColorMask::alpha Holds whether the alpha component should be written to the frame buffer. */ void QColorMask::setAlpha(bool alpha) diff --git a/src/render/texture/qabstracttextureimage.cpp b/src/render/texture/qabstracttextureimage.cpp index ce4efeaf8..ef3414e62 100644 --- a/src/render/texture/qabstracttextureimage.cpp +++ b/src/render/texture/qabstracttextureimage.cpp @@ -60,8 +60,8 @@ namespace Qt3DRender { */ /*! - \class QAbstractTextureImage - \inmodule Qt3DRenderer + \class Qt3DRender::QAbstractTextureImage + \inmodule Qt3DRender \since 5.5 \brief Encapsulates the necessary information to create an OpenGL texture image. @@ -79,7 +79,7 @@ namespace Qt3DRender { */ /*! - Constructs a new Qt3DCore::QAbstractTextureImage instance with \a parent as parent. + Constructs a new QAbstractTextureImage instance with \a parent as parent. */ QAbstractTextureImage::QAbstractTextureImage(QNode *parent) : QNode(*new QAbstractTextureImagePrivate, parent) @@ -96,13 +96,13 @@ QAbstractTextureImage::~QAbstractTextureImage() /*! - \qmlproperty int Qt3D.render::AbstractTextureImage::mipmapLevel + \qmlproperty int Qt3D.Render::AbstractTextureImage::mipmapLevel Holds the mipmap level of the texture image. */ /*! - \property Qt3DCore::QAbstractTextureImage::mipmapLevel + \property Qt3DRender::QAbstractTextureImage::mipmapLevel Holds the mipmap level of the texture image. */ @@ -113,13 +113,13 @@ int QAbstractTextureImage::mipmapLevel() const } /*! - \qmlproperty int Qt3D.Renderer::AbstractTextureImage::layer + \qmlproperty int Qt3D.Render::AbstractTextureImage::layer Holds the layer of the texture image. */ /*! - \property Qt3DCore::QAbstractTextureImage::layer + \property Qt3DRender::QAbstractTextureImage::layer Holds the layer of the texture image. */ @@ -130,7 +130,7 @@ int QAbstractTextureImage::layer() const } /*! - \qmlproperty enumeration Qt3D.Renderer::AbstractTextureImage::cubeMapFace + \qmlproperty enumeration Qt3D.Render::AbstractTextureImage::cubeMapFace Holds the cube map face of the texture image. @@ -142,12 +142,12 @@ int QAbstractTextureImage::layer() const \value CubeMapNegativeZ 0x851A GL_TEXTURE_CUBE_MAP_NEGATIVE_Z \note The cube map face has a meaning only for - \l {QAbstractTextureProvider::}{TargetCubeMap} and - \l {QAbstractTextureProvider::}{TargetCubeMapArray}. + \l [CPP] {Qt3DRender::QAbstractTextureProvider::}{TargetCubeMap} and + \l [CPP] {Qt3DRender::QAbstractTextureProvider::}{TargetCubeMapArray}. */ /*! - \property Qt3DCore::QAbstractTextureImage::cubeMapFace + \property Qt3DRender::QAbstractTextureImage::cubeMapFace Holds the cube map face of the texture image. diff --git a/src/render/texture/qabstracttextureprovider.cpp b/src/render/texture/qabstracttextureprovider.cpp index e85121f7f..2f91fd385 100644 --- a/src/render/texture/qabstracttextureprovider.cpp +++ b/src/render/texture/qabstracttextureprovider.cpp @@ -95,7 +95,7 @@ void QAbstractTextureProvider::copy(const QNode *ref) \since 5.5 \brief A base class to be used to provide textures. - Qt3DRender::QAbstractTextureProvider shouldn't be used directly but rather + The QAbstractTextureProvider class shouldn't be used directly but rather through one of its subclasses. Each subclass implements a given texture target (2D, 2DArray, 3D, CubeMap ...) Each subclass provides a set of functors for each layer, cube map face and mipmap level. In turn the @@ -103,7 +103,6 @@ void QAbstractTextureProvider::copy(const QNode *ref) with data. */ - QAbstractTextureProvider::QAbstractTextureProvider(QNode *parent) : QNode(*new QAbstractTextureProviderPrivate, parent) { @@ -320,7 +319,7 @@ QAbstractTextureProvider::Target QAbstractTextureProvider::target() const /*! Adds a new Qt3DCore::QAbstractTextureImage \a textureImage to the texture provider. - \note Qt3DCore::QAbstractTextureImage should never be shared between multiple + \note Qt3DRender::QAbstractTextureImage should never be shared between multiple Qt3DRender::QAbstractTextureProvider instances. */ void QAbstractTextureProvider::addTextureImage(QAbstractTextureImage *textureImage) diff --git a/src/render/texture/qtextureimage.cpp b/src/render/texture/qtextureimage.cpp index 154f1e0aa..a069f6a56 100644 --- a/src/render/texture/qtextureimage.cpp +++ b/src/render/texture/qtextureimage.cpp @@ -97,8 +97,8 @@ private: }; /*! - \class QTextureImage - \inmodule Qt3DRenderer + \class Qt3DRender::QTextureImage + \inmodule Qt3DRender \since 5.5 \brief Encapsulates the necessary information to create an OpenGL texture image from an image source. @@ -150,7 +150,7 @@ QUrl QTextureImage::source() const */ /*! - \qmlproperty url Qt3D.Renderer::TextureImage::source + \qmlproperty url Qt3D.Render::TextureImage::source This property holdsthe source url from which data for the texture image will be loaded. @@ -180,7 +180,7 @@ QTextureDataFunctorPtr QTextureImage::dataFunctor() const } /*! - Copies \ref into this texture image. + Copies \a ref into this texture image. */ void QTextureImage::copy(const QNode *ref) { diff --git a/src/render/texture/qtextureproviders.cpp b/src/render/texture/qtextureproviders.cpp index 62c8f66c7..1a42ebe9e 100644 --- a/src/render/texture/qtextureproviders.cpp +++ b/src/render/texture/qtextureproviders.cpp @@ -42,7 +42,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QTexture1D - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a Target1D target format. */ @@ -61,7 +61,7 @@ QTexture1D::~QTexture1D() /*! \class Qt3DRender::QTexture1DArray - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a Target1DArray target format. */ @@ -80,7 +80,7 @@ QTexture1DArray::~QTexture1DArray() /*! \class Qt3DRender::QTexture2D - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a Target2D target format. */ @@ -99,7 +99,7 @@ QTexture2D::~QTexture2D() /*! \class Qt3DRender::QTexture2DArray - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a Target2DArray target format. */ @@ -119,7 +119,7 @@ QTexture2DArray::~QTexture2DArray() /*! \class Qt3DRender::QTexture3D - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a Target3D target format. */ @@ -138,7 +138,7 @@ QTexture3D::~QTexture3D() /*! \class Qt3DRender::QTextureCubeMap - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a TargetCubeMap target format. */ @@ -157,7 +157,7 @@ QTextureCubeMap::~QTextureCubeMap() /*! \class Qt3DRender::QTextureCubeMapArray - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a TargetCubeMapArray target format. */ @@ -177,7 +177,7 @@ QTextureCubeMapArray::~QTextureCubeMapArray() /*! \class Qt3DRender::QTexture2DMultisample - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a Target2DMultisample target format. */ @@ -196,7 +196,7 @@ QTexture2DMultisample::~QTexture2DMultisample() /*! \class Qt3DRender::QTexture2DMultisampleArray - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a Target2DMultisampleArray target format. */ @@ -215,7 +215,7 @@ QTexture2DMultisampleArray::~QTexture2DMultisampleArray() /*! \class Qt3DRender::QTextureRectangle - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a TargetRectangle target format. */ @@ -234,7 +234,7 @@ QTextureRectangle::~QTextureRectangle() /*! \class Qt3DRender::QTextureBuffer - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief A QAbstractTextureProvider with a TargetBuffer target format. */ diff --git a/src/render/texture/qwrapmode.cpp b/src/render/texture/qwrapmode.cpp index 2e5ace4d2..4baa6711b 100644 --- a/src/render/texture/qwrapmode.cpp +++ b/src/render/texture/qwrapmode.cpp @@ -60,7 +60,7 @@ public: /*! \class Qt3DRender::QTextureWrapMode - \inmodule Qt3DRenderer + \inmodule Qt3DRender \since 5.5 \brief Defines the wrap mode a Qt3DRender::QAbstractTextureProvider -- cgit v1.2.3