Add note to material system nodes that can't be disabled

Task-number: QTBUG-67017
Change-Id: I20acb3aa5e778be7752e1568b08001838f094eb3
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>

4 files changed, 16 insertions, 0 deletions

diff --git a/src/render/materialsystem/qeffect.cpp b/src/render/materialsystem/qeffect.cpp
index b611657c4..ba19154fd 100644
--- a/src/render/materialsystem/qeffect.cpp
+++ b/src/render/materialsystem/qeffect.cpp
@@ -69,6 +69,8 @@ QEffectPrivate::QEffectPrivate()
 
     An QEffect instance should be shared among several QMaterial instances when possible.
 
+    \note QEffect node can not be disabled.
+
     \code
     QEffect *effect = new QEffect();
 
@@ -115,6 +117,8 @@ QEffectPrivate::QEffectPrivate()
     A Parameter defined on an Effect is overridden by a QParameter (of the same
     name) defined in a Material, TechniqueFilter, RenderPassFilter.
 
+    \note Effect node can not be disabled.
+
     \code
     Effect {
         id: effect
diff --git a/src/render/materialsystem/qfilterkey.cpp b/src/render/materialsystem/qfilterkey.cpp
index 547c56d26..0cffde7c1 100644
--- a/src/render/materialsystem/qfilterkey.cpp
+++ b/src/render/materialsystem/qfilterkey.cpp
@@ -61,6 +61,8 @@ QFilterKeyPrivate::QFilterKeyPrivate()
 
     Filter keys are used by QTechnique and QRenderPass to specify at which stage of rendering the
     technique or the render pass is used.
+
+    \note QFilterKey node can not be disabled.
 */
 
 /*!
@@ -74,6 +76,8 @@ QFilterKeyPrivate::QFilterKeyPrivate()
     A FilterKey is a storage type for filter key and value pair.
     Filter keys are used by Technique and RenderPass to specify at which stage of rendering the
     technique or the render pass is used.
+
+    \note FilterKey node can not be disabled.
 */
 
 QFilterKey::QFilterKey(QNode *parent)
diff --git a/src/render/materialsystem/qparameter.cpp b/src/render/materialsystem/qparameter.cpp
index afaf42158..92f3cf0c2 100644
--- a/src/render/materialsystem/qparameter.cpp
+++ b/src/render/materialsystem/qparameter.cpp
@@ -77,6 +77,8 @@
     \note when the targeted uniform is an array, the name should be the name
     of the uniform with [0] appended to it.
 
+    \note Parameter node can not be disabled.
+
     \code
     Parameter {
         name: "diffuseValues[0]"
@@ -139,6 +141,8 @@
     \note when the targeted uniform is an array, the name should be the name
     of the uniform with [0] appended to it.
 
+    \note QParameter node can not be disabled.
+
     \code
     QParameter *param = new QParameter();
     QVariantList values = QVariantList() << 0.0f << 1.0f << 2.0f << 3.0f << 4.0f << 883.0f << 1340.0f << 1584.0f;
diff --git a/src/render/materialsystem/qtechnique.cpp b/src/render/materialsystem/qtechnique.cpp
index b668eb25f..e5f109d46 100644
--- a/src/render/materialsystem/qtechnique.cpp
+++ b/src/render/materialsystem/qtechnique.cpp
@@ -90,6 +90,8 @@ QTechniquePrivate::~QTechniquePrivate()
     QSurfaceFormat::setDefaultFormat(). Setting the QSurfaceFormat on the view
     will likely have no effect on Qt3D related rendering.
 
+    \note Technique node can not be disabled.
+
     \qml
     Technique {
         id: gl3Technique
@@ -155,6 +157,8 @@ QTechniquePrivate::~QTechniquePrivate()
     QSurfaceFormat::setDefaultFormat(). Setting the QSurfaceFormat on the view
     will likely have no effect on Qt3D related rendering.
 
+    \note QTechnique node can not be disabled.
+
     \code
     QTechnique *gl3Technique = new QTechnique();