Document public members of QSGSimpleMaterialShader

Change-Id: I2e46989d4076ff639d7264985e030df0f1cb2a88
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>

diff --git a/src/quick/scenegraph/util/qsgsimplematerial.cpp b/src/quick/scenegraph/util/qsgsimplematerial.cpp
index ee7a272..35ad56a 100644 (file)
--- a/src/quick/scenegraph/util/qsgsimplematerial.cpp
+++ b/src/quick/scenegraph/util/qsgsimplematerial.cpp
@@ -180,17 +180,29 @@
 
 /*!
     \fn void QSGSimpleMaterialShader::resolveUniforms()
-    \internal
+
+    Reimplement this function to resolve the location of named uniforms
+    in the shader program.
+
+    This function is called when the material shader is initialized.
  */
 
 /*!
     \fn const char *QSGSimpleMaterialShader::uniformMatrixName() const
-    \internal
+
+    Reimplement this function to give a different name to the uniform for
+    item transformation. The default value is \c qt_Matrix.
+
  */
 
 /*!
     \fn const char *QSGSimpleMaterialShader::uniformOpacityName() const
-    \internal
+
+    Reimplement this function to give a different name to the uniform for
+    item opacity. The default value is \c qt_Opacity.
+
+    If the shader program does not implement the item opacity, the
+    implemented function should return a null pointer.
  */
 
 /*!