summaryrefslogtreecommitdiffstats
path: root/src/render/defaults
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-11-04 12:47:51 +0100
committerTopi Reiniƶ <topi.reinio@theqtcompany.com>2015-11-23 14:15:40 +0000
commit85ffad3142cd4c3baa0bb77b0674a17287b01534 (patch)
treed0ab865a944d837b965546248b19e1ab69e99a82 /src/render/defaults
parented9628c87fac466ee6106d12996373ddf56f2c73 (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/defaults')
-rw-r--r--src/render/defaults/qdiffusemapmaterial.cpp2
-rw-r--r--src/render/defaults/qdiffusespecularmapmaterial.cpp2
-rw-r--r--src/render/defaults/qgoochmaterial.cpp16
-rw-r--r--src/render/defaults/qnormaldiffusemapalphamaterial.cpp2
-rw-r--r--src/render/defaults/qnormaldiffusemapmaterial.cpp2
-rw-r--r--src/render/defaults/qnormaldiffusespecularmapmaterial.cpp2
-rw-r--r--src/render/defaults/qpervertexcolormaterial.cpp4
-rw-r--r--src/render/defaults/qphongmaterial.cpp6
-rw-r--r--src/render/defaults/qskyboxentity.cpp4
9 files changed, 20 insertions, 20 deletions
diff --git a/src/render/defaults/qdiffusemapmaterial.cpp b/src/render/defaults/qdiffusemapmaterial.cpp
index 6906177e0..d738e1592 100644
--- a/src/render/defaults/qdiffusemapmaterial.cpp
+++ b/src/render/defaults/qdiffusemapmaterial.cpp
@@ -132,7 +132,7 @@ void QDiffuseMapMaterialPrivate::init()
\class Qt3DRender::QDiffuseMapMaterial
\brief The QDiffuseMapMaterial provides a default implementation of the phong lighting effect where the diffuse light component
is read from a texture map.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
diff --git a/src/render/defaults/qdiffusespecularmapmaterial.cpp b/src/render/defaults/qdiffusespecularmapmaterial.cpp
index c03664681..746739ed3 100644
--- a/src/render/defaults/qdiffusespecularmapmaterial.cpp
+++ b/src/render/defaults/qdiffusespecularmapmaterial.cpp
@@ -140,7 +140,7 @@ void QDiffuseSpecularMapMaterialPrivate::init()
\class Qt3DRender::QDiffuseSpecularMapMaterial
\brief The QDiffuseSpecularMapMaterial provides a default implementation of the phong lighting and bump effect where the diffuse and specular light components
are read from texture maps.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
diff --git a/src/render/defaults/qgoochmaterial.cpp b/src/render/defaults/qgoochmaterial.cpp
index 30e196fc7..d35bbb68d 100644
--- a/src/render/defaults/qgoochmaterial.cpp
+++ b/src/render/defaults/qgoochmaterial.cpp
@@ -132,7 +132,7 @@ void QGoochMaterialPrivate::init()
\class Qt3DRender::QGoochMaterial
\brief The QGoochMaterial provides a material that implements the Gooch
shading model, popular in CAD and CAM applications.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The Gooch lighting model uses both color and brightness to help show the
@@ -174,7 +174,7 @@ QGoochMaterial::QGoochMaterial(QGoochMaterialPrivate &dd, QNode *parent)
}
/*!
- \property Qt3DCore::QGoochMaterial::diffuse
+ \property Qt3DRender::QGoochMaterial::diffuse
Holds the current diffuse color.
*/
@@ -185,7 +185,7 @@ QColor QGoochMaterial::diffuse() const
}
/*!
- \property Qt3DCore::QGoochMaterial::specular
+ \property Qt3DRender::QGoochMaterial::specular
Holds the current specular color.
*/
@@ -196,7 +196,7 @@ QColor QGoochMaterial::specular() const
}
/*!
- \property Qt3DCore::QGoochMaterial::cool
+ \property Qt3DRender::QGoochMaterial::cool
Holds the current cool color.
*/
@@ -207,7 +207,7 @@ QColor QGoochMaterial::cool() const
}
/*!
- \property Qt3DCore::QGoochMaterial::warm
+ \property Qt3DRender::QGoochMaterial::warm
Holds the current warm color.
*/
@@ -218,7 +218,7 @@ QColor QGoochMaterial::warm() const
}
/*!
- \property Qt3DCore::QGoochMaterial::alpha
+ \property Qt3DRender::QGoochMaterial::alpha
Holds the current alpha value. The start point of the color ramp
used by the Gooch shader is calculated as {c = cool + alpha * diffuse}.
@@ -230,7 +230,7 @@ float QGoochMaterial::alpha() const
}
/*!
- \property Qt3DCore::QGoochMaterial::beta
+ \property Qt3DRender::QGoochMaterial::beta
Holds the current beta value. The start point of the color ramp
used by the Gooch shader is calculated as {c = warm + beta * diffuse}.
@@ -242,7 +242,7 @@ float QGoochMaterial::beta() const
}
/*!
- \property Qt3DCore::QGoochMaterial::shininess
+ \property Qt3DRender::QGoochMaterial::shininess
Holds the current shininess value. Higher values of shininess result in
a smaller and brighter highlight.
diff --git a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp
index c67dc3bfe..602a111d7 100644
--- a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp
+++ b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp
@@ -129,7 +129,7 @@ void QNormalDiffuseMapAlphaMaterialPrivate::init()
\brief The QNormalDiffuseMapAlphaMaterial provides a default implementation of the phong lighting and bump effect where the diffuse light component
is read from a texture map and the normals of the mesh being rendered from a normal texture map. In addition, it defines an alpha to coverage and
a depth test to be performed in the rendering pass.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
diff --git a/src/render/defaults/qnormaldiffusemapmaterial.cpp b/src/render/defaults/qnormaldiffusemapmaterial.cpp
index b31337053..259ac54d8 100644
--- a/src/render/defaults/qnormaldiffusemapmaterial.cpp
+++ b/src/render/defaults/qnormaldiffusemapmaterial.cpp
@@ -141,7 +141,7 @@ void QNormalDiffuseMapMaterialPrivate::init()
\class Qt3DRender::QNormalDiffuseMapMaterial
\brief The QNormalDiffuseMapMaterial provides a default implementation of the phong lighting and bump effect where the diffuse light component
is read from a texture map and the normals of the mesh being rendered from a normal texture map.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
diff --git a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp
index 420f22a7d..8f263153d 100644
--- a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp
+++ b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp
@@ -147,7 +147,7 @@ void QNormalDiffuseSpecularMapMaterialPrivate::init()
\class Qt3DRender::QNormalDiffuseSpecularMapMaterial
\brief The QNormalDiffuseSpecularMapMaterial provides a default implementation of the phong lighting and bump effect where the diffuse and specular light components
are read from texture maps and the normals of the mesh being rendered from a normal texture map.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The specular lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
diff --git a/src/render/defaults/qpervertexcolormaterial.cpp b/src/render/defaults/qpervertexcolormaterial.cpp
index 27f7de224..5ea8f9fbf 100644
--- a/src/render/defaults/qpervertexcolormaterial.cpp
+++ b/src/render/defaults/qpervertexcolormaterial.cpp
@@ -74,7 +74,7 @@ QPerVertexColorMaterialPrivate::QPerVertexColorMaterialPrivate()
/*!
\class Qt3DRender::QPerVertexColorMaterial
\brief The QPerVertexColorMaterial class provides a default implementation for rendering the color properties set for each vertex.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
This lighting effect is based on the combination of 2 lighting components ambient and diffuse. Ambient is set by the vertex color.
@@ -90,7 +90,7 @@ QPerVertexColorMaterialPrivate::QPerVertexColorMaterialPrivate()
*/
/*!
- \fn Qt3DRender::QPerVertexColorMaterial::QPerVertexColorMaterial(QNode *parent)
+ \fn Qt3DRender::QPerVertexColorMaterial::QPerVertexColorMaterial(Qt3DCore::QNode *parent)
Constructs a new QPerVertexColorMaterial instance with parent object \a parent.
*/
diff --git a/src/render/defaults/qphongmaterial.cpp b/src/render/defaults/qphongmaterial.cpp
index 2a4663f27..4c08d3713 100644
--- a/src/render/defaults/qphongmaterial.cpp
+++ b/src/render/defaults/qphongmaterial.cpp
@@ -78,7 +78,7 @@ QPhongMaterialPrivate::QPhongMaterialPrivate()
/*!
\class Qt3DRender::QPhongMaterial
\brief The QPhongMaterial class provides a default implementation of the phong lighting effect.
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
The phong lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
@@ -96,7 +96,7 @@ QPhongMaterialPrivate::QPhongMaterialPrivate()
*/
/*!
- \fn Qt3DRender::QPhongMaterial::QPhongMaterial(QNode *parent)
+ \fn Qt3DRender::QPhongMaterial::QPhongMaterial(Qt3DCore::QNode *parent)
Constructs a new QPhongMaterial instance with parent object \a parent.
*/
@@ -143,7 +143,7 @@ QColor QPhongMaterial::diffuse() const
}
/*!
- \property QColor Qt3DRender::QPhongMaterial::specular
+ \property Qt3DRender::QPhongMaterial::specular
Holds the specular color.
*/
diff --git a/src/render/defaults/qskyboxentity.cpp b/src/render/defaults/qskyboxentity.cpp
index 740a3f14a..39a68723b 100644
--- a/src/render/defaults/qskyboxentity.cpp
+++ b/src/render/defaults/qskyboxentity.cpp
@@ -181,9 +181,9 @@ void QSkyboxEntityPrivate::reloadTexture()
/*!
* \class Qt3DRender::QSkyboxEntity
- * \inmodule Qt3DRenderer
+ * \inmodule Qt3DRender
*
- * \brief Qt3DCore::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can
+ * \brief Qt3DRender::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can
* be used to insert a skybox in a 3D scene.
*
* By specifying a base name and an extension, Qt3DCore::QSkyboxEntity