Doc: Qt 3D Extras: Fix information on deprecated classes

QDoc has no \see command. Further, Qt 3D Extras module page still
listed the deprecated classes. To fix these and make it easier to
maintain, assign (non-deprecated) classes to groups and list the group
members on the module page.

Change-Id: I6bb2ff9855c2c481b33c7d0d142a173a5e0b3fd8
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>

29 files changed, 31 insertions, 38 deletions

diff --git a/src/doc/src/qt3dextras-module.qdoc b/src/doc/src/qt3dextras-module.qdoc
index 087018139..b9a7cc28a 100644
--- a/src/doc/src/qt3dextras-module.qdoc
+++ b/src/doc/src/qt3dextras-module.qdoc
@@ -67,41 +67,15 @@
 
     \section2 Materials
 
-    \list
-    \li Qt3DExtras::QDiffuseMapMaterial
-    \li Qt3DExtras::QDiffuseSpecularMapMaterial
-    \li Qt3DExtras::QGoochMaterial
-    \li Qt3DExtras::QNormalDiffuseMapMaterial
-    \li Qt3DExtras::QNormalDiffuseMapAlphaMaterial
-    \li Qt3DExtras::QNormalDiffuseSpecularMapMaterial
-    \li Qt3DExtras::QPerVertexColorMaterial
-    \li Qt3DExtras::QPhongMaterial
-    \li Qt3DExtras::QPhongAlphaMaterial
-    \endlist
+    \annotatedlist qt3d-extras-materials
 
     \section2 Meshes and Geometries
 
-    \list
-    \li Qt3DExtras::QConeGeometry
-    \li Qt3DExtras::QConeMesh
-    \li Qt3DExtras::QCuboidGeometry
-    \li Qt3DExtras::QCuboidMesh
-    \li Qt3DExtras::QCylinderGeometry
-    \li Qt3DExtras::QCylinderMesh
-    \li Qt3DExtras::QPlaneGeometry
-    \li Qt3DExtras::QPlaneMesh
-    \li Qt3DExtras::QSphereGeometry
-    \li Qt3DExtras::QSphereMesh
-    \li Qt3DExtras::QTorusGeometry
-    \li Qt3DExtras::QTorusMesh
-    \endlist
+    \annotatedlist qt3d-extras-geometries
 
     \section2 Camera Controllers
 
-    \list
-    \li Qt3DExtras::QFirstPersonCameraController
-    \li Qt3DExtras::QOrbitCameraController
-    \endlist
+    \annotatedlist qt3d-extras-cameracontrollers
 
     \section2 Entities
 
diff --git a/src/extras/defaults/qdiffusemapmaterial.cpp b/src/extras/defaults/qdiffusemapmaterial.cpp
index 26fb99c2c..d5e729b8e 100644
--- a/src/extras/defaults/qdiffusemapmaterial.cpp
+++ b/src/extras/defaults/qdiffusemapmaterial.cpp
@@ -202,7 +202,7 @@ void QDiffuseMapMaterialPrivate::handleTextureScaleChanged(const QVariant &var)
     \inherits Qt3DRender::QMaterial
 
     \deprecated
-    \see Qt3DExtras::QDiffuseSpecularMaterial
+    This class is deprecated; use Qt3DExtras::QDiffuseSpecularMaterial instead.
 
     The specular lighting effect is based on the combination of 3 lighting components ambient,
     diffuse and specular. The relative strengths of these components are controlled by means of
diff --git a/src/extras/defaults/qdiffusespecularmapmaterial.cpp b/src/extras/defaults/qdiffusespecularmapmaterial.cpp
index 727eaed27..0acf610e9 100644
--- a/src/extras/defaults/qdiffusespecularmapmaterial.cpp
+++ b/src/extras/defaults/qdiffusespecularmapmaterial.cpp
@@ -209,7 +209,7 @@ void QDiffuseSpecularMapMaterialPrivate::handleTextureScaleChanged(const QVarian
     \inherits Qt3DRender::QMaterial
 
     \deprecated
-    \see Qt3DExtras::QDiffuseSpecularMaterial
+    This class is deprecated; use Qt3DExtras::QDiffuseSpecularMaterial instead.
 
     The specular lighting effect is based on the combination of 3 lighting components ambient,
     diffuse and specular. The relative strengths of these components are controlled by means of
diff --git a/src/extras/defaults/qdiffusespecularmaterial.cpp b/src/extras/defaults/qdiffusespecularmaterial.cpp
index 83bba9e41..14e1c2766 100644
--- a/src/extras/defaults/qdiffusespecularmaterial.cpp
+++ b/src/extras/defaults/qdiffusespecularmaterial.cpp
@@ -211,6 +211,7 @@ void QDiffuseSpecularMaterialPrivate::handleTextureScaleChanged(const QVariant &
 
 /*!
     \class Qt3DExtras::QDiffuseSpecularMaterial
+    \ingroup qt3d-extras-materials
     \brief The QDiffuseSpecularMaterial class provides a default implementation
     of the phong lighting effect.
     \inmodule Qt3DExtras
diff --git a/src/extras/defaults/qfirstpersoncameracontroller.cpp b/src/extras/defaults/qfirstpersoncameracontroller.cpp
index 2ad997d05..0561bbc37 100644
--- a/src/extras/defaults/qfirstpersoncameracontroller.cpp
+++ b/src/extras/defaults/qfirstpersoncameracontroller.cpp
@@ -44,6 +44,7 @@ namespace Qt3DExtras {
 
 /*!
     \class Qt3DExtras::QFirstPersonCameraController
+    \ingroup qt3d-extras-cameracontrollers
     \brief The QFirstPersonCameraController class allows controlling the scene camera
     from the first person perspective.
     \inmodule Qt3DExtras
diff --git a/src/extras/defaults/qgoochmaterial.cpp b/src/extras/defaults/qgoochmaterial.cpp
index ba7ef8dab..57ec359b3 100644
--- a/src/extras/defaults/qgoochmaterial.cpp
+++ b/src/extras/defaults/qgoochmaterial.cpp
@@ -188,6 +188,7 @@ void QGoochMaterialPrivate::handleShininessChanged(const QVariant &var)
 
 /*!
     \class Qt3DExtras::QGoochMaterial
+    \ingroup qt3d-extras-materials
     \brief The QGoochMaterial provides a material that implements the Gooch
     shading model, popular in CAD and CAM applications.
     \inmodule Qt3DExtras
diff --git a/src/extras/defaults/qmetalroughmaterial.cpp b/src/extras/defaults/qmetalroughmaterial.cpp
index 4d537f20f..1cf114423 100644
--- a/src/extras/defaults/qmetalroughmaterial.cpp
+++ b/src/extras/defaults/qmetalroughmaterial.cpp
@@ -161,6 +161,7 @@ void QMetalRoughMaterialPrivate::handleTextureScaleChanged(const QVariant &var)
 
 /*!
     \class Qt3DExtras::QMetalRoughMaterial
+    \ingroup qt3d-extras-materials
     \brief The QMetalRoughMaterial provides a default implementation of PBR
     lighting.
     \inmodule Qt3DExtras
diff --git a/src/extras/defaults/qmorphphongmaterial.cpp b/src/extras/defaults/qmorphphongmaterial.cpp
index 4b22e8765..ade9f8542 100644
--- a/src/extras/defaults/qmorphphongmaterial.cpp
+++ b/src/extras/defaults/qmorphphongmaterial.cpp
@@ -169,6 +169,7 @@ void QMorphPhongMaterialPrivate::handleInterpolatorChanged(const QVariant &var)
 
 /*!
     \class Qt3DExtras::QMorphPhongMaterial
+    \ingroup qt3d-extras-materials
     \brief The QMorphPhongMaterial class provides a default implementation of the phong lighting effect.
     \inmodule Qt3DExtras
     \since 5.7
diff --git a/src/extras/defaults/qnormaldiffusemapalphamaterial.cpp b/src/extras/defaults/qnormaldiffusemapalphamaterial.cpp
index 9b2a64520..27fda6879 100644
--- a/src/extras/defaults/qnormaldiffusemapalphamaterial.cpp
+++ b/src/extras/defaults/qnormaldiffusemapalphamaterial.cpp
@@ -166,7 +166,7 @@ void QNormalDiffuseMapAlphaMaterialPrivate::init()
     \inherits Qt3DExtras::QNormalDiffuseMapMaterial
 
     \deprecated
-    \see Qt3DExtras::QDiffuseSpecularMaterial
+    This class is deprecated; use Qt3DExtras::QDiffuseSpecularMaterial instead.
 
     The specular lighting effect is based on the combination of 3 lighting components ambient,
     diffuse and specular. The relative strengths of these components are controlled by means of
diff --git a/src/extras/defaults/qnormaldiffusemapmaterial.cpp b/src/extras/defaults/qnormaldiffusemapmaterial.cpp
index beed4085e..7c8260084 100644
--- a/src/extras/defaults/qnormaldiffusemapmaterial.cpp
+++ b/src/extras/defaults/qnormaldiffusemapmaterial.cpp
@@ -219,7 +219,7 @@ void QNormalDiffuseMapMaterialPrivate::handleTextureScaleChanged(const QVariant
     \inherits Qt3DRender::QMaterial
 
     \deprecated
-    \see Qt3DExtras::QDiffuseSpecularMaterial
+    This class is deprecated; use QDiffuseSpecularMaterial instead.
 
     The specular lighting effect is based on the combination of 3 lighting components ambient,
     diffuse and specular. The relative strengths of these components are controlled by means of
diff --git a/src/extras/defaults/qnormaldiffusespecularmapmaterial.cpp b/src/extras/defaults/qnormaldiffusespecularmapmaterial.cpp
index 028fd14e7..5fb2b7e9e 100644
--- a/src/extras/defaults/qnormaldiffusespecularmapmaterial.cpp
+++ b/src/extras/defaults/qnormaldiffusespecularmapmaterial.cpp
@@ -227,7 +227,7 @@ void QNormalDiffuseSpecularMapMaterialPrivate::handleTextureScaleChanged(const Q
     \inherits Qt3DRender::QMaterial
 
     \deprecated
-    \see Qt3DExtras::QDiffuseSpecularMaterial
+    This class is deprecated; use QDiffuseSpecularMaterial instead.
 
     The specular lighting effect is based on the combination of 3 lighting components ambient,
     diffuse and specular. The relative strengths of these components are controlled by means of
diff --git a/src/extras/defaults/qorbitcameracontroller.cpp b/src/extras/defaults/qorbitcameracontroller.cpp
index c4f976f89..61b930569 100644
--- a/src/extras/defaults/qorbitcameracontroller.cpp
+++ b/src/extras/defaults/qorbitcameracontroller.cpp
@@ -49,6 +49,7 @@ QOrbitCameraControllerPrivate::QOrbitCameraControllerPrivate()
 
 /*!
     \class Qt3DExtras::QOrbitCameraController
+    \ingroup qt3d-extras-cameracontrollers
     \brief The QOrbitCameraController class allows controlling the scene camera along orbital path.
     \inmodule Qt3DExtras
     \since 5.7
diff --git a/src/extras/defaults/qpervertexcolormaterial.cpp b/src/extras/defaults/qpervertexcolormaterial.cpp
index 5619a71e7..f0462039e 100644
--- a/src/extras/defaults/qpervertexcolormaterial.cpp
+++ b/src/extras/defaults/qpervertexcolormaterial.cpp
@@ -75,6 +75,7 @@ QPerVertexColorMaterialPrivate::QPerVertexColorMaterialPrivate()
 
 /*!
     \class Qt3DExtras::QPerVertexColorMaterial
+    \ingroup qt3d-extras-materials
     \brief The QPerVertexColorMaterial class provides a default implementation for rendering the
     color properties set for each vertex.
     \inmodule Qt3DExtras
diff --git a/src/extras/defaults/qphongalphamaterial.cpp b/src/extras/defaults/qphongalphamaterial.cpp
index 24cff94e9..2f705072f 100644
--- a/src/extras/defaults/qphongalphamaterial.cpp
+++ b/src/extras/defaults/qphongalphamaterial.cpp
@@ -210,7 +210,7 @@ void QPhongAlphaMaterialPrivate::handleShininessChanged(const QVariant &var)
     \inherits Qt3DRender::QMaterial
 
     \deprecated
-    \see Qt3DExtras::QDiffuseSpecularMaterial
+    This class is deprecated; use QDiffuseSpecularMaterial instead.
 
     The phong lighting effect is based on the combination of 3 lighting components ambient, diffuse
     and specular. The relative strengths of these components are controlled by means of their
diff --git a/src/extras/defaults/qphongmaterial.cpp b/src/extras/defaults/qphongmaterial.cpp
index 17d837568..6318ea140 100644
--- a/src/extras/defaults/qphongmaterial.cpp
+++ b/src/extras/defaults/qphongmaterial.cpp
@@ -185,7 +185,7 @@ void QPhongMaterialPrivate::handleShininessChanged(const QVariant &var)
     \inherits Qt3DRender::QMaterial
 
     \deprecated
-    \see Qt3DExtras::QDiffuseSpecularMaterial
+    This class is deprecated; use QDiffuseSpecularMaterial instead.
 
     The phong lighting effect is based on the combination of 3 lighting components ambient, diffuse
     and specular. The relative strengths of these components are controlled by means of their
diff --git a/src/extras/defaults/qtexturedmetalroughmaterial.cpp b/src/extras/defaults/qtexturedmetalroughmaterial.cpp
index 8e26ddccc..55d061fc3 100644
--- a/src/extras/defaults/qtexturedmetalroughmaterial.cpp
+++ b/src/extras/defaults/qtexturedmetalroughmaterial.cpp
@@ -45,13 +45,12 @@ namespace Qt3DExtras {
 
 /*!
     \class Qt3DExtras::QTexturedMetalRoughMaterial
-    \brief This is deprecated, please use QMetalRoughMaterial instead.
+    \brief This class is deprecated; use QMetalRoughMaterial instead.
     \inmodule Qt3DExtras
     \since 5.9
     \inherits Qt3DExtras::QMetalRoughMaterial
 
     \deprecated
-    \see Qt3DExtras::QMetalRoughMaterial
 */
 
 /*!
diff --git a/src/extras/defaults/qtexturematerial.cpp b/src/extras/defaults/qtexturematerial.cpp
index 32e60360e..6d57f3a49 100644
--- a/src/extras/defaults/qtexturematerial.cpp
+++ b/src/extras/defaults/qtexturematerial.cpp
@@ -143,6 +143,7 @@ void QTextureMaterialPrivate::handleTextureTransformChanged(const QVariant &var)
 
 /*!
     \class Qt3DExtras::QTextureMaterial
+    \ingroup qt3d-extras-materials
     \brief The QTextureMaterial provides a default implementation of a simple unlit
     texture material.
     \inmodule Qt3DExtras
diff --git a/src/extras/geometries/qconegeometry.cpp b/src/extras/geometries/qconegeometry.cpp
index 109d19b66..3626deef3 100644
--- a/src/extras/geometries/qconegeometry.cpp
+++ b/src/extras/geometries/qconegeometry.cpp
@@ -39,6 +39,7 @@
 
 /*!
  * \class Qt3DExtras::QConeGeometry
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QConeGeometry
  * \inmodule Qt3DExtras
  * \brief The QConeGeometry class allows creation of a cone in 3D space.
diff --git a/src/extras/geometries/qconemesh.cpp b/src/extras/geometries/qconemesh.cpp
index 5e327df03..a0d1bd310 100644
--- a/src/extras/geometries/qconemesh.cpp
+++ b/src/extras/geometries/qconemesh.cpp
@@ -106,6 +106,7 @@ namespace Qt3DExtras {
 
 /*!
  * \class Qt3DExtras::QConeMesh
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QConeMesh
  * \inmodule Qt3DExtras
  *
diff --git a/src/extras/geometries/qcuboidgeometry.cpp b/src/extras/geometries/qcuboidgeometry.cpp
index 968c12e49..850566c5a 100644
--- a/src/extras/geometries/qcuboidgeometry.cpp
+++ b/src/extras/geometries/qcuboidgeometry.cpp
@@ -648,6 +648,7 @@ void QCuboidGeometryPrivate::init()
 
 /*!
  * \class Qt3DExtras::QCuboidGeometry
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QCuboidGeometry
  * \inmodule Qt3DExtras
  * \brief The QCuboidGeometry class allows creation of a cuboid in 3D space.
diff --git a/src/extras/geometries/qcuboidmesh.cpp b/src/extras/geometries/qcuboidmesh.cpp
index 9e10d93a4..bdad566fc 100644
--- a/src/extras/geometries/qcuboidmesh.cpp
+++ b/src/extras/geometries/qcuboidmesh.cpp
@@ -96,6 +96,7 @@ namespace  Qt3DExtras {
 
 /*!
  * \class Qt3DExtras::QCuboidMesh
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QCuboidMesh
  * \inmodule Qt3DExtras
  *
diff --git a/src/extras/geometries/qcylindergeometry.cpp b/src/extras/geometries/qcylindergeometry.cpp
index affc3e516..2a70d46d1 100644
--- a/src/extras/geometries/qcylindergeometry.cpp
+++ b/src/extras/geometries/qcylindergeometry.cpp
@@ -409,6 +409,7 @@ void QCylinderGeometryPrivate::init()
 
 /*!
  * \class Qt3DExtras::QCylinderGeometry
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QCylinderGeometry
  * \inmodule Qt3DExtras
  * \brief The QCylinderGeometry class allows creation of a cylinder in 3D space.
diff --git a/src/extras/geometries/qcylindermesh.cpp b/src/extras/geometries/qcylindermesh.cpp
index 02df6295f..792944cd5 100644
--- a/src/extras/geometries/qcylindermesh.cpp
+++ b/src/extras/geometries/qcylindermesh.cpp
@@ -91,6 +91,7 @@ namespace Qt3DExtras {
 
 /*!
  * \class Qt3DExtras::QCylinderMesh
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QCylinderMesh
  * \inmodule Qt3DExtras
  *
diff --git a/src/extras/geometries/qplanegeometry.cpp b/src/extras/geometries/qplanegeometry.cpp
index 99892fa24..db82ecb97 100644
--- a/src/extras/geometries/qplanegeometry.cpp
+++ b/src/extras/geometries/qplanegeometry.cpp
@@ -278,6 +278,7 @@ public:
 
 /*!
  * \class Qt3DExtras::QPlaneGeometry
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QPlaneGeometry
  * \inmodule Qt3DExtras
  * \brief The QPlaneGeometry class allows creation of a plane in 3D space.
diff --git a/src/extras/geometries/qplanemesh.cpp b/src/extras/geometries/qplanemesh.cpp
index 4804df024..223e5a628 100644
--- a/src/extras/geometries/qplanemesh.cpp
+++ b/src/extras/geometries/qplanemesh.cpp
@@ -81,6 +81,7 @@ namespace  Qt3DExtras {
 
 /*!
  * \class Qt3DExtras::QPlaneMesh
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QPlaneMesh
  * \inmodule Qt3DExtras
  *
diff --git a/src/extras/geometries/qspheregeometry.cpp b/src/extras/geometries/qspheregeometry.cpp
index 40a0c4475..83391cfa8 100644
--- a/src/extras/geometries/qspheregeometry.cpp
+++ b/src/extras/geometries/qspheregeometry.cpp
@@ -382,6 +382,7 @@ void QSphereGeometryPrivate::init()
 
 /*!
  * \class Qt3DExtras::QSphereGeometry
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QSphereGeometry
  * \inmodule Qt3DExtras
  * \brief The QSphereGeometry class allows creation of a sphere in 3D space.
diff --git a/src/extras/geometries/qspheremesh.cpp b/src/extras/geometries/qspheremesh.cpp
index 22089d7ab..28854fe29 100644
--- a/src/extras/geometries/qspheremesh.cpp
+++ b/src/extras/geometries/qspheremesh.cpp
@@ -80,6 +80,7 @@ namespace  Qt3DExtras {
 
 /*!
  * \class Qt3DExtras::QSphereMesh
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QSphereMesh
  * \inmodule Qt3DExtras
  *
diff --git a/src/extras/geometries/qtorusgeometry.cpp b/src/extras/geometries/qtorusgeometry.cpp
index 43a2566bb..b93ea55fb 100644
--- a/src/extras/geometries/qtorusgeometry.cpp
+++ b/src/extras/geometries/qtorusgeometry.cpp
@@ -362,6 +362,7 @@ void QTorusGeometryPrivate::init()
 
 /*!
  * \class Qt3DExtras::QTorusGeometry
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QTorusGeometry
  * \inmodule Qt3DExtras
  * \brief The QTorusGeometry class allows creation of a torus in 3D space.
diff --git a/src/extras/geometries/qtorusmesh.cpp b/src/extras/geometries/qtorusmesh.cpp
index 8e7c678db..fd10afc1e 100644
--- a/src/extras/geometries/qtorusmesh.cpp
+++ b/src/extras/geometries/qtorusmesh.cpp
@@ -83,6 +83,7 @@ namespace  Qt3DExtras {
 
 /*!
  * \class Qt3DExtras::QTorusMesh
+   \ingroup qt3d-extras-geometries
  * \inheaderfile Qt3DExtras/QTorusMesh
  * \inmodule Qt3DExtras
  *