diff options
author | Topi Reinio <topi.reinio@qt.io> | 2016-12-07 14:53:23 +0100 |
---|---|---|
committer | Sean Harmer <sean.harmer@kdab.com> | 2016-12-07 14:07:55 +0000 |
commit | f8ba0ee64abe614780324711c8b0b7274d38eb0a (patch) | |
tree | 87782731bd295677624bd9d4f12adb13dd66872f /src/extras | |
parent | 8e998d710844fe0fe1ce7e1c22e56f065d0f8b4d (diff) |
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>
Diffstat (limited to 'src/extras')
-rw-r--r-- | src/extras/defaults/qskyboxentity.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qconegeometry.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qconemesh.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qcuboidgeometry.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qcuboidmesh.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qcylindergeometry.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qcylindermesh.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qplanegeometry.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qplanemesh.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qspheregeometry.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qspheremesh.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qtorusgeometry.cpp | 1 | ||||
-rw-r--r-- | src/extras/geometries/qtorusmesh.cpp | 1 |
13 files changed, 13 insertions, 0 deletions
diff --git a/src/extras/defaults/qskyboxentity.cpp b/src/extras/defaults/qskyboxentity.cpp index 85f01340d..e81c6ad91 100644 --- a/src/extras/defaults/qskyboxentity.cpp +++ b/src/extras/defaults/qskyboxentity.cpp @@ -188,6 +188,7 @@ void QSkyboxEntityPrivate::reloadTexture() /*! * \class Qt3DExtras::QSkyboxEntity + * \inheaderfile Qt3DExtras/QSkyboxEntity * \inmodule Qt3DExtras * * \brief Qt3DExtras::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can diff --git a/src/extras/geometries/qconegeometry.cpp b/src/extras/geometries/qconegeometry.cpp index 8159564ae..a86d10f6b 100644 --- a/src/extras/geometries/qconegeometry.cpp +++ b/src/extras/geometries/qconegeometry.cpp @@ -39,6 +39,7 @@ /*! * \class Qt3DExtras::QConeGeometry + * \inheaderfile Qt3DExtras/QConeGeometry * \inmodule Qt3DExtras * \brief The QConeGeometry class allows creation of a cone in 3D space. * \since 5.7 diff --git a/src/extras/geometries/qconemesh.cpp b/src/extras/geometries/qconemesh.cpp index 385c469e0..8baa19217 100644 --- a/src/extras/geometries/qconemesh.cpp +++ b/src/extras/geometries/qconemesh.cpp @@ -104,6 +104,7 @@ namespace Qt3DExtras { /*! * \class Qt3DExtras::QConeMesh + * \inheaderfile Qt3DExtras/QConeMesh * \inmodule Qt3DExtras * * \inherits Qt3DRender::QGeometryRenderer diff --git a/src/extras/geometries/qcuboidgeometry.cpp b/src/extras/geometries/qcuboidgeometry.cpp index 0f7b5220f..28743858a 100644 --- a/src/extras/geometries/qcuboidgeometry.cpp +++ b/src/extras/geometries/qcuboidgeometry.cpp @@ -645,6 +645,7 @@ void QCuboidGeometryPrivate::init() /*! * \class Qt3DExtras::QCuboidGeometry + * \inheaderfile Qt3DExtras/QCuboidGeometry * \inmodule Qt3DExtras * \brief The QCuboidGeometry class allows creation of a cuboid in 3D space. * \since 5.7 diff --git a/src/extras/geometries/qcuboidmesh.cpp b/src/extras/geometries/qcuboidmesh.cpp index 7df77ec63..88c735746 100644 --- a/src/extras/geometries/qcuboidmesh.cpp +++ b/src/extras/geometries/qcuboidmesh.cpp @@ -95,6 +95,7 @@ namespace Qt3DExtras { /*! * \class Qt3DExtras::QCuboidMesh + * \inheaderfile Qt3DExtras/QCuboidMesh * \inmodule Qt3DExtras * * \inherits Qt3DRender::QGeometryRenderer diff --git a/src/extras/geometries/qcylindergeometry.cpp b/src/extras/geometries/qcylindergeometry.cpp index f37fd0ddf..29f7ea7e0 100644 --- a/src/extras/geometries/qcylindergeometry.cpp +++ b/src/extras/geometries/qcylindergeometry.cpp @@ -406,6 +406,7 @@ void QCylinderGeometryPrivate::init() /*! * \class Qt3DExtras::QCylinderGeometry + * \inheaderfile Qt3DExtras/QCylinderGeometry * \inmodule Qt3DExtras * \brief The QCylinderGeometry class allows creation of a cylinder in 3D space. * \since 5.7 diff --git a/src/extras/geometries/qcylindermesh.cpp b/src/extras/geometries/qcylindermesh.cpp index 875d8ed9a..9b0ded28b 100644 --- a/src/extras/geometries/qcylindermesh.cpp +++ b/src/extras/geometries/qcylindermesh.cpp @@ -89,6 +89,7 @@ namespace Qt3DExtras { /*! * \class Qt3DExtras::QCylinderMesh + * \inheaderfile Qt3DExtras/QCylinderMesh * \inmodule Qt3DExtras * * \inherits Qt3DRender::QGeometryRenderer diff --git a/src/extras/geometries/qplanegeometry.cpp b/src/extras/geometries/qplanegeometry.cpp index 74c90cf1b..16b401d3d 100644 --- a/src/extras/geometries/qplanegeometry.cpp +++ b/src/extras/geometries/qplanegeometry.cpp @@ -266,6 +266,7 @@ public: /*! * \class Qt3DExtras::QPlaneGeometry + * \inheaderfile Qt3DExtras/QPlaneGeometry * \inmodule Qt3DExtras * \brief The QPlaneGeometry class allows creation of a plane in 3D space. * \since 5.7 diff --git a/src/extras/geometries/qplanemesh.cpp b/src/extras/geometries/qplanemesh.cpp index f14d7cb97..120aed6df 100644 --- a/src/extras/geometries/qplanemesh.cpp +++ b/src/extras/geometries/qplanemesh.cpp @@ -73,6 +73,7 @@ namespace Qt3DExtras { /*! * \class Qt3DExtras::QPlaneMesh + * \inheaderfile Qt3DExtras/QPlaneMesh * \inmodule Qt3DExtras * * \inherits Qt3DRender::QGeometryRenderer diff --git a/src/extras/geometries/qspheregeometry.cpp b/src/extras/geometries/qspheregeometry.cpp index 277d4fcb9..a79eb8074 100644 --- a/src/extras/geometries/qspheregeometry.cpp +++ b/src/extras/geometries/qspheregeometry.cpp @@ -380,6 +380,7 @@ void QSphereGeometryPrivate::init() /*! * \class Qt3DExtras::QSphereGeometry + * \inheaderfile Qt3DExtras/QSphereGeometry * \inmodule Qt3DExtras * \brief The QSphereGeometry class allows creation of a sphere in 3D space. * \since 5.7 diff --git a/src/extras/geometries/qspheremesh.cpp b/src/extras/geometries/qspheremesh.cpp index 90cf5a872..988a95990 100644 --- a/src/extras/geometries/qspheremesh.cpp +++ b/src/extras/geometries/qspheremesh.cpp @@ -79,6 +79,7 @@ namespace Qt3DExtras { /*! * \class Qt3DExtras::QSphereMesh + * \inheaderfile Qt3DExtras/QSphereMesh * \inmodule Qt3DExtras * * \inherits Qt3DRender::QGeometryRenderer diff --git a/src/extras/geometries/qtorusgeometry.cpp b/src/extras/geometries/qtorusgeometry.cpp index 843979b6d..08afce1b0 100644 --- a/src/extras/geometries/qtorusgeometry.cpp +++ b/src/extras/geometries/qtorusgeometry.cpp @@ -360,6 +360,7 @@ void QTorusGeometryPrivate::init() /*! * \class Qt3DExtras::QTorusGeometry + * \inheaderfile Qt3DExtras/QTorusGeometry * \inmodule Qt3DExtras * \brief The QTorusGeometry class allows creation of a torus in 3D space. * \since 5.7 diff --git a/src/extras/geometries/qtorusmesh.cpp b/src/extras/geometries/qtorusmesh.cpp index a77631b73..96fce9ec0 100644 --- a/src/extras/geometries/qtorusmesh.cpp +++ b/src/extras/geometries/qtorusmesh.cpp @@ -82,6 +82,7 @@ namespace Qt3DExtras { /*! * \class Qt3DExtras::QTorusMesh + * \inheaderfile Qt3DExtras/QTorusMesh * \inmodule Qt3DExtras * * \inherits Qt3DRender::QGeometryRenderer |