Doc: Specify #include path for each \class

QDoc tries to guess the correct #include statement, displayed in
the requisites table in the class reference. However, this often
produces incorrect information for a module as complex as Qt3D.

To fix this, manually specify the include path with the \inheaderfile
command.

Change-Id: I42929b92600d07d759f4f76e9051ff656785c652
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

15 files changed, 16 insertions, 0 deletions

diff --git a/src/render/framegraph/qrendercapture.cpp b/src/render/framegraph/qrendercapture.cpp
index c4a42ff8a..62164b3ce 100644
--- a/src/render/framegraph/qrendercapture.cpp
+++ b/src/render/framegraph/qrendercapture.cpp
@@ -45,6 +45,7 @@ namespace Qt3DRender {
 
 /*!
  * \class Qt3DRender::QRenderCapture
+ * \inheaderfile Qt3DRender/QRenderCapture
  * \inmodule Qt3DRender
  *
  * \brief Frame graph node for render capture
@@ -68,6 +69,7 @@ namespace Qt3DRender {
 
 /*!
  * \class Qt3DRender::QRenderCaptureReply
+ * \inheaderfile Qt3DRender/QRenderCaptureReply
  * \inmodule Qt3DRender
  *
  * \brief Receives the result of render capture request.
diff --git a/src/render/framegraph/qrenderstateset.cpp b/src/render/framegraph/qrenderstateset.cpp
index 845fb5d91..35ac7fd04 100644
--- a/src/render/framegraph/qrenderstateset.cpp
+++ b/src/render/framegraph/qrenderstateset.cpp
@@ -58,6 +58,7 @@ QRenderStateSetPrivate::QRenderStateSetPrivate()
 
 /*!
  * \class Qt3DRender::QRenderStateSet
+ * \inheaderfile Qt3DRender/QRenderStateSet
  * \inmodule Qt3DRender
  *
  * \brief The QRenderStateSet \l {QFrameGraphNode}{FrameGraph} node offers a way of
diff --git a/src/render/frontend/qcamera.cpp b/src/render/frontend/qcamera.cpp
index 7a1f133a8..b9e180b97 100644
--- a/src/render/frontend/qcamera.cpp
+++ b/src/render/frontend/qcamera.cpp
@@ -62,6 +62,7 @@ QCameraPrivate::QCameraPrivate()
 
 /*!
  * \class Qt3DRender::QCamera
+ * \inheaderfile Qt3DRender/QCamera
  * \brief The QCamera class defines a view point through which the scene will be
  * rendered.
  * \inmodule Qt3DRender
diff --git a/src/render/frontend/qcameralens.cpp b/src/render/frontend/qcameralens.cpp
index 4725251b5..269bc8d16 100644
--- a/src/render/frontend/qcameralens.cpp
+++ b/src/render/frontend/qcameralens.cpp
@@ -46,6 +46,7 @@ namespace Qt3DRender {
 
 /*!
  * \class Qt3DRender::QCameraLens
+ * \inheaderfile Qt3DRender/QCameraLens
  * \inmodule Qt3DRender
  *
  * \brief Qt3DRender::QCameraLens specifies the projection matrix that will be used to
diff --git a/src/render/frontend/qrenderaspect.cpp b/src/render/frontend/qrenderaspect.cpp
index df1e42e75..d0d08edaa 100644
--- a/src/render/frontend/qrenderaspect.cpp
+++ b/src/render/frontend/qrenderaspect.cpp
@@ -141,6 +141,7 @@ namespace Qt3DRender {
 
 /*!
  * \class Qt3DRender::QRenderAspect
+ * \inheaderfile Qt3DRender/QRenderAspect
  * \brief The QRenderAspect class
  * \since 5.7
  * \inmodule Qt3DRender
diff --git a/src/render/geometry/qattribute.cpp b/src/render/geometry/qattribute.cpp
index 12ceda18f..8723f5177 100644
--- a/src/render/geometry/qattribute.cpp
+++ b/src/render/geometry/qattribute.cpp
@@ -75,6 +75,7 @@ QAttributePrivate::QAttributePrivate()
 
 /*!
  * \class Qt3DRender::QAttribute
+ * \inheaderfile Qt3DRender/QAttribute
  * \inmodule Qt3DRender
  *
  * \inherits Qt3DCore::QNode
diff --git a/src/render/geometry/qbuffer.cpp b/src/render/geometry/qbuffer.cpp
index 061a351bf..02417f978 100644
--- a/src/render/geometry/qbuffer.cpp
+++ b/src/render/geometry/qbuffer.cpp
@@ -89,6 +89,7 @@ QBufferPrivate::QBufferPrivate()
 
 /*!
  * \class Qt3DRender::QBuffer
+ * \inheaderfile Qt3DRender/QBuffer
  * \inmodule Qt3DRender
  *
  * \inherits Qt3DCore::QNode
diff --git a/src/render/geometry/qgeometry.cpp b/src/render/geometry/qgeometry.cpp
index bdbaf5ab7..3f3065533 100644
--- a/src/render/geometry/qgeometry.cpp
+++ b/src/render/geometry/qgeometry.cpp
@@ -80,6 +80,7 @@ QGeometryPrivate::~QGeometryPrivate()
 
 /*!
  * \class Qt3DRender::QGeometry
+ * \inheaderfile Qt3DRender/QGeometry
  * \inmodule Qt3DRender
  *
  * \inherits Qt3DCore::QNode
diff --git a/src/render/geometry/qgeometryrenderer.cpp b/src/render/geometry/qgeometryrenderer.cpp
index ddc1b1b23..970f555d3 100644
--- a/src/render/geometry/qgeometryrenderer.cpp
+++ b/src/render/geometry/qgeometryrenderer.cpp
@@ -138,6 +138,7 @@ QGeometryRendererPrivate::~QGeometryRendererPrivate()
 
 /*!
  * \class Qt3DRender::QGeometryRenderer
+ * \inheaderfile Qt3DRender/QGeometryRenderer
  * \inmodule Qt3DRender
  *
  * \inherits Qt3DCore::QComponent
diff --git a/src/render/geometry/qmesh.cpp b/src/render/geometry/qmesh.cpp
index 30e8a9460..6e98d0e9a 100644
--- a/src/render/geometry/qmesh.cpp
+++ b/src/render/geometry/qmesh.cpp
@@ -78,6 +78,7 @@ QMeshPrivate::QMeshPrivate()
 
 /*!
  * \class Qt3DRender::QMesh
+ * \inheaderfile Qt3DRender/QMesh
  * \inmodule Qt3DRender
  *
  * \inherits Qt3DRender::QGeometryRenderer
diff --git a/src/render/materialsystem/qparameter.cpp b/src/render/materialsystem/qparameter.cpp
index 10af1d24c..8f83fd02e 100644
--- a/src/render/materialsystem/qparameter.cpp
+++ b/src/render/materialsystem/qparameter.cpp
@@ -53,6 +53,7 @@
 
 /*!
  * \class Qt3DRender::QParameter
+ * \inheaderfile Qt3DRender/QParameter
  * \inmodule Qt3DRender
  *
  * \brief Provides storage for a name and value pair.
diff --git a/src/render/materialsystem/qshaderdata.cpp b/src/render/materialsystem/qshaderdata.cpp
index 066a6c55f..a636bc1a8 100644
--- a/src/render/materialsystem/qshaderdata.cpp
+++ b/src/render/materialsystem/qshaderdata.cpp
@@ -62,6 +62,7 @@ QShaderDataPrivate::QShaderDataPrivate(PropertyReaderInterfacePtr reader)
 
 /*!
  * \class Qt3DRender::QShaderData
+ * \inheaderfile Qt3DRender/QShaderData
  * \inmodule Qt3DRender
  *
  * \brief Provides a way of specifying values of a Uniform Block or a shader
diff --git a/src/render/renderstates/qblendequation.cpp b/src/render/renderstates/qblendequation.cpp
index e48e83883..220116626 100644
--- a/src/render/renderstates/qblendequation.cpp
+++ b/src/render/renderstates/qblendequation.cpp
@@ -40,6 +40,7 @@
 
 /*!
  * \class Qt3DRender::QBlendEquation
+ * \inheaderfile Qt3DRender/QBlendEquation
  * \brief The QBlendEquation class specifies the equation used for both the RGB
  *  blend equation and the Alpha blend equation
  * \inmodule Qt3DRender
diff --git a/src/render/renderstates/qrenderstatecreatedchange.cpp b/src/render/renderstates/qrenderstatecreatedchange.cpp
index a3466ca66..5e0713552 100644
--- a/src/render/renderstates/qrenderstatecreatedchange.cpp
+++ b/src/render/renderstates/qrenderstatecreatedchange.cpp
@@ -43,6 +43,7 @@ namespace Qt3DRender {
 
 /*!
  * \class Qt3DRender::QRenderStateCreatedChange
+ * \inheaderfile Qt3DRender/QRenderStateCreatedChange
  * \brief The QRenderStateCreatedChange class
  * \since 5.7
  * \inmodule Qt3DRender
diff --git a/src/render/texture/qtexturedata.cpp b/src/render/texture/qtexturedata.cpp
index 061c93198..b7bb75242 100644
--- a/src/render/texture/qtexturedata.cpp
+++ b/src/render/texture/qtexturedata.cpp
@@ -46,6 +46,7 @@ namespace Qt3DRender {
 
 /*!
  * \class Qt3DRender::QTextureData
+ * \inheaderfile Qt3DRender/QTextureData
  * \brief The QTextureData class stores texture information such as
  * the target, height, width, depth, layers, wrap, and if mipmaps are enabled.
  * \since 5.7