diff options
author | Topi Reinio <topi.reinio@digia.com> | 2015-11-04 12:47:51 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@theqtcompany.com> | 2015-11-23 14:15:40 +0000 |
commit | 85ffad3142cd4c3baa0bb77b0674a17287b01534 (patch) | |
tree | d0ab865a944d837b965546248b19e1ab69e99a82 /src/render/materialsystem | |
parent | ed9628c87fac466ee6106d12996373ddf56f2c73 (diff) |
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 <venugopal.shivashankar@digia.com>
Diffstat (limited to 'src/render/materialsystem')
-rw-r--r-- | src/render/materialsystem/qannotation.cpp | 6 | ||||
-rw-r--r-- | src/render/materialsystem/qgraphicsapifilter.cpp | 10 | ||||
-rw-r--r-- | src/render/materialsystem/qmaterial.cpp | 2 | ||||
-rw-r--r-- | src/render/materialsystem/qparametermapping.cpp | 12 | ||||
-rw-r--r-- | src/render/materialsystem/qrenderpass.cpp | 2 | ||||
-rw-r--r-- | src/render/materialsystem/qshaderdata.cpp | 13 | ||||
-rw-r--r-- | src/render/materialsystem/qshaderprogram.cpp | 4 |
7 files changed, 24 insertions, 25 deletions
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) { |