Docs for QSGimpleMaterialShader

Change-Id: I769eb68a1703a2cc7379af702fb888d3e9697300
Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>

1 files changed, 10 insertions, 1 deletions

diff --git a/src/quick/scenegraph/coreapi/qsgmaterial.cpp b/src/quick/scenegraph/coreapi/qsgmaterial.cpp
index 9f0def4706..850db69948 100644
--- a/src/quick/scenegraph/coreapi/qsgmaterial.cpp
+++ b/src/quick/scenegraph/coreapi/qsgmaterial.cpp
@@ -47,7 +47,12 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \class QSGMaterialShader
-    \brief The QSGMaterialShader class implements a material renders geometry.
+    \brief The QSGMaterialShader class represents an OpenGL shader program
+    in the renderer.
+
+    The QSGMaterialShader API is very low-level. A more convenient API, which
+    provides almost all the same features, is available through
+    QSGSimpleMaterialShader.
 
     The QSGMaterial and QSGMaterialShader form a tight relationship. For one
     scene graph (including nested graphs), there is one unique QSGMaterialShader
@@ -437,6 +442,10 @@ static void qt_print_material_count()
     \class QSGMaterial
     \brief The QSGMaterial class encapsulates rendering state for a shader program.
 
+    The QSGMaterial API is very low-level. A more convenient API, which
+    provides almost all the same features, is available through
+    QSGSimpleMaterialShader.
+
     The QSGMaterial and QSGMaterialShader subclasses form a tight relationship. For
     one scene graph (including nested graphs), there is one unique QSGMaterialShader
     instance which encapsulates the QOpenGLShaderProgram the scene graph uses