Doc: clarify some properties

Change-Id: Ie0e9183ec4fe1730018f695374d32cb78d0e77ed
Reviewed-by: Andy Maloney <asmaloney@gmail.com>
Reviewed-by: Michael Brasser <michael.brasser@live.com>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>

3 files changed, 36 insertions, 17 deletions

diff --git a/src/extras/defaults/qdiffusespecularmapmaterial.cpp b/src/extras/defaults/qdiffusespecularmapmaterial.cpp
index 0acf610e9..e1d23622c 100644
--- a/src/extras/defaults/qdiffusespecularmapmaterial.cpp
+++ b/src/extras/defaults/qdiffusespecularmapmaterial.cpp
@@ -217,7 +217,7 @@ void QDiffuseSpecularMapMaterialPrivate::handleTextureScaleChanged(const QVarian
 
     \list
     \li Ambient is the color that is emitted by an object without any other light source.
-    \li Diffuse is the color that is emitted for rought surface reflections with the lights.
+    \li Diffuse is the color that is emitted for rough surface reflections with the lights.
     \li Specular is the color emitted for shiny surface reflections with the lights.
     \li The shininess of a surface is controlled by a float property.
     \endlist
@@ -246,7 +246,8 @@ QDiffuseSpecularMapMaterial::~QDiffuseSpecularMapMaterial()
 /*!
     \property QDiffuseSpecularMapMaterial::ambient
 
-    Holds the current ambient color.
+    Holds the current ambient color that is emitted by an object without any
+    other light source.
 */
 QColor QDiffuseSpecularMapMaterial::ambient() const
 {
@@ -297,7 +298,10 @@ QAbstractTexture *QDiffuseSpecularMapMaterial::specular() const
 /*!
     \property QDiffuseSpecularMapMaterial::shininess
 
-    Holds the current shininess as a float value.
+    Holds the current shininess as a float value. Higher values of shininess result in
+    a smaller and brighter highlight.
+
+    Defaults to 150.0.
 */
 float QDiffuseSpecularMapMaterial::shininess() const
 {
diff --git a/src/extras/defaults/qdiffusespecularmaterial.cpp b/src/extras/defaults/qdiffusespecularmaterial.cpp
index 14e1c2766..be187b46a 100644
--- a/src/extras/defaults/qdiffusespecularmaterial.cpp
+++ b/src/extras/defaults/qdiffusespecularmaterial.cpp
@@ -253,7 +253,7 @@ void QDiffuseSpecularMaterialPrivate::handleTextureScaleChanged(const QVariant &
     \list
     \li Ambient is the color that is emitted by an object without any other
         light source.
-    \li Diffuse is the color that is emitted for rought surface reflections
+    \li Diffuse is the color that is emitted for rough surface reflections
         with the lights.
     \li Specular is the color emitted for shiny surface reflections with the
         lights.
@@ -285,12 +285,14 @@ QDiffuseSpecularMaterial::~QDiffuseSpecularMaterial()
 /*!
     \property QDiffuseSpecularMaterial::ambient
 
-    Holds the ambient color.
+    Holds the ambient color that is emitted by an object without any other
+    light source.
 */
 /*!
     \qmlproperty color DiffuseSpecularMaterial::ambient
 
-    Holds the ambient color.
+    Holds the ambient color that is emitted by an object without any other
+    light source.
 */
 QColor QDiffuseSpecularMaterial::ambient() const
 {
@@ -301,14 +303,16 @@ QColor QDiffuseSpecularMaterial::ambient() const
 /*!
     \property QDiffuseSpecularMaterial::diffuse
 
-    Holds the diffuse color of the material. This can be either a plain color
-    value or a texture.
+    Holds the diffuse color of the material that is emitted for rough surface
+    reflections with the lights. This can be either a plain color value or a
+    texture.
 */
 /*!
     \qmlproperty var DiffuseSpecularMaterial::diffuse
 
-    Holds the diffuse color of the material. This can be either a plain color
-    value or a texture.
+    Holds the diffuse color of the material that is emitted for rough surface
+    reflections with the lights. This can be either a plain color value or a
+    texture.
 */
 QVariant QDiffuseSpecularMaterial::diffuse() const
 {
@@ -319,14 +323,16 @@ QVariant QDiffuseSpecularMaterial::diffuse() const
 /*!
     \property QDiffuseSpecularMaterial::specular
 
-    Holds the specular color of the material. This can be either a plain color
-    value or a texture.
+    Holds the specular color of the material that is emitted for shiny surface
+    reflections with the lights. This can be either a plain color value or a
+    texture.
 */
 /*!
     \qmlproperty var DiffuseSpecularMaterial::specular
 
-    Holds the specular color of the material. This can be either a plain color
-    value or a texture.
+    Holds the specular color of the material that is emitted for shiny surface
+    reflections with the lights. This can be either a plain color value or a
+    texture.
 */
 QVariant QDiffuseSpecularMaterial::specular() const
 {
@@ -337,12 +343,18 @@ QVariant QDiffuseSpecularMaterial::specular() const
 /*!
     \property QDiffuseSpecularMaterial::shininess
 
-    Holds the shininess exponent.
+    Holds the shininess exponent. Higher values of shininess result in
+    a smaller and brighter highlight.
+
+    Defaults to 150.0.
 */
 /*!
     \qmlproperty real DiffuseSpecularMaterial::shininess
 
-    Holds the shininess exponent.
+    Holds the shininess exponent. Higher values of shininess result in
+    a smaller and brighter highlight.
+
+    Defaults to 150.0.
 */
 float QDiffuseSpecularMaterial::shininess() const
 {
diff --git a/src/extras/defaults/qskyboxentity.cpp b/src/extras/defaults/qskyboxentity.cpp
index 9cd199f1a..7de552b38 100644
--- a/src/extras/defaults/qskyboxentity.cpp
+++ b/src/extras/defaults/qskyboxentity.cpp
@@ -293,7 +293,10 @@ void QSkyboxEntity::setExtension(const QString &extension)
 /*!
     \property QSkyboxEntity::extension
 
-    Contains the extension of the Skybox.
+    Contains the extension of the filename for the skybox image, including the
+    leading '.'.
+
+    The default value is: .png
 */
 /*!
  * Returns the extension