From 739bf854bd07fb02c4452b19f0e8066b79497770 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Sat, 29 Mar 2025 07:34:57 +1000 Subject: [PATCH] Change doxygen "3d" group to "qgis_3d" Doxygen chokes on the initial digit in "3d", resulting in corrupted documentation for classes in the 3d group --- doc/modules.dox | 2 +- src/3d/chunks/qgschunkboundsentity_p.h | 2 +- src/3d/chunks/qgschunkedentity.h | 2 +- src/3d/chunks/qgschunklist_p.h | 4 ++-- src/3d/chunks/qgschunkloader.h | 8 ++++---- src/3d/chunks/qgschunknode.h | 2 +- src/3d/chunks/qgschunkqueuejob.h | 4 ++-- src/3d/framegraph/qgs3daxisrenderview.h | 2 +- src/3d/framegraph/qgsabstractrenderview.h | 2 +- src/3d/framegraph/qgsambientocclusionblurentity.h | 2 +- src/3d/framegraph/qgsambientocclusionrenderentity.h | 2 +- src/3d/framegraph/qgsforwardrenderview.h | 2 +- src/3d/framegraph/qgsframegraph.h | 2 +- src/3d/framegraph/qgsframegraphutils.h | 2 +- src/3d/framegraph/qgspostprocessingentity.h | 2 +- src/3d/framegraph/qgspreviewquad.h | 4 ++-- src/3d/framegraph/qgsrenderpassquad.h | 2 +- src/3d/framegraph/qgsshadowrenderview.h | 2 +- src/3d/lights/qgsdirectionallightsettings.h | 2 +- src/3d/lights/qgslightsource.h | 2 +- src/3d/lights/qgspointlightsettings.h | 2 +- src/3d/materials/qgsabstractmaterialsettings.h | 6 +++--- src/3d/materials/qgsgoochmaterialsettings.h | 2 +- src/3d/materials/qgsmaterial.h | 2 +- src/3d/materials/qgsmetalroughmaterial.h | 2 +- src/3d/materials/qgsmetalroughmaterialsettings.h | 2 +- src/3d/materials/qgsnullmaterialsettings.h | 2 +- src/3d/materials/qgsphongmaterialsettings.h | 2 +- src/3d/materials/qgsphongtexturedmaterial.h | 2 +- src/3d/materials/qgsphongtexturedmaterialsettings.h | 2 +- src/3d/materials/qgssimplelinematerialsettings.h | 2 +- src/3d/materials/qgstexturematerial.h | 2 +- src/3d/mesh/qgsmesh3dmaterial_p.h | 2 +- src/3d/mesh/qgsmeshterraingenerator.h | 2 +- src/3d/qgs3danimationsettings.h | 2 +- src/3d/qgs3daxis.h | 2 +- src/3d/qgs3daxissettings.h | 2 +- src/3d/qgs3dexportobject.h | 2 +- src/3d/qgs3dmapcanvas.h | 2 +- src/3d/qgs3dmapexportsettings.h | 2 +- src/3d/qgs3dmapscene.h | 2 +- src/3d/qgs3dmapsceneentity.h | 2 +- src/3d/qgs3dmapsettings.h | 2 +- src/3d/qgs3dmaptool.h | 2 +- src/3d/qgs3drendercontext.h | 2 +- src/3d/qgs3dsceneexporter.h | 2 +- src/3d/qgs3dtypes.h | 2 +- src/3d/qgs3dutils.h | 2 +- src/3d/qgs3dwiredmesh_p.h | 2 +- src/3d/qgsaabb.h | 2 +- src/3d/qgsabstract3dengine.h | 2 +- src/3d/qgsabstractvectorlayer3drenderer.h | 4 ++-- src/3d/qgsambientocclusionsettings.h | 2 +- src/3d/qgscameracontroller.h | 2 +- src/3d/qgscamerapose.h | 2 +- src/3d/qgsfeature3dhandler_p.h | 2 +- src/3d/qgsgltf3dutils.h | 2 +- src/3d/qgsimagetexture.h | 2 +- src/3d/qgslayoutitem3dmap.h | 2 +- src/3d/qgsoffscreen3dengine.h | 2 +- src/3d/qgspointcloudlayerchunkloader_p.h | 6 +++--- src/3d/qgsrubberband3d.h | 2 +- src/3d/qgsrulebased3drenderer.h | 6 +++--- src/3d/qgsrulebasedchunkloader_p.h | 6 +++--- src/3d/qgsshadowsettings.h | 2 +- src/3d/qgsskyboxentity.h | 6 +++--- src/3d/qgsskyboxsettings.h | 2 +- src/3d/qgstessellatedpolygongeometry.h | 2 +- src/3d/qgstiledscenechunkloader_p.h | 6 +++--- src/3d/qgstiledscenelayer3drenderer.h | 4 ++-- src/3d/qgstilingscheme.h | 2 +- src/3d/qgsvectorlayerchunkloader_p.h | 6 +++--- src/3d/qgsvirtualpointcloudentity_p.h | 2 +- src/3d/qgswindow3dengine.h | 2 +- src/3d/symbols/qgsbillboardgeometry.h | 2 +- src/3d/symbols/qgsline3dsymbol.h | 2 +- src/3d/symbols/qgslinematerial_p.h | 2 +- src/3d/symbols/qgslinevertexdata_p.h | 2 +- src/3d/symbols/qgsmesh3dsymbol.h | 2 +- src/3d/symbols/qgspoint3dbillboardmaterial.h | 2 +- src/3d/symbols/qgspoint3dsymbol.h | 2 +- src/3d/symbols/qgspointcloud3dsymbol.h | 10 +++++----- src/3d/symbols/qgspolygon3dsymbol.h | 2 +- src/3d/terrain/qgsabstractterrainsettings.h | 2 +- src/3d/terrain/qgsdemterraingenerator.h | 2 +- src/3d/terrain/qgsdemterrainsettings.h | 2 +- src/3d/terrain/qgsdemterraintilegeometry_p.h | 2 +- src/3d/terrain/qgsdemterraintileloader_p.h | 4 ++-- src/3d/terrain/qgsflatterraingenerator.h | 2 +- src/3d/terrain/qgsflatterrainsettings.h | 2 +- src/3d/terrain/qgsmeshterrainsettings.h | 2 +- src/3d/terrain/qgsonlinedemterrainsettings.h | 2 +- src/3d/terrain/qgsonlineterraingenerator.h | 2 +- src/3d/terrain/qgsquantizedmeshterraingenerator.h | 2 +- src/3d/terrain/qgsquantizedmeshterrainsettings.h | 2 +- src/3d/terrain/qgsterraindownloader.h | 2 +- src/3d/terrain/qgsterrainentity.h | 2 +- src/3d/terrain/qgsterraingenerator.h | 2 +- src/3d/terrain/qgsterraintexturegenerator_p.h | 2 +- src/3d/terrain/qgsterraintextureimage_p.h | 2 +- src/3d/terrain/qgsterraintileentity_p.h | 2 +- src/3d/terrain/qgsterraintileloader.h | 2 +- src/core/3d/qgsabstract3dsymbol.h | 2 +- tests/code_layout/test_doxygen_layout.sh | 7 ++++++- 104 files changed, 136 insertions(+), 131 deletions(-) diff --git a/doc/modules.dox b/doc/modules.dox index 4f33cf944ee..824d802ef24 100644 --- a/doc/modules.dox +++ b/doc/modules.dox @@ -25,7 +25,7 @@ components to QGIS. */ -/** @defgroup 3d 3D library +/** @defgroup qgis_3d 3D library The 3D library is build on top of the CORE library and Qt 3D framework. It adds support for display of GIS data in 3D scenes. diff --git a/src/3d/chunks/qgschunkboundsentity_p.h b/src/3d/chunks/qgschunkboundsentity_p.h index c7450a6cf15..c88c6e67386 100644 --- a/src/3d/chunks/qgschunkboundsentity_p.h +++ b/src/3d/chunks/qgschunkboundsentity_p.h @@ -38,7 +38,7 @@ class Qgs3DWiredMesh; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Draws bounds of axis aligned bounding boxes * \note Not available in Python bindings */ diff --git a/src/3d/chunks/qgschunkedentity.h b/src/3d/chunks/qgschunkedentity.h index 2271479a110..588927ffe69 100644 --- a/src/3d/chunks/qgschunkedentity.h +++ b/src/3d/chunks/qgschunkedentity.h @@ -56,7 +56,7 @@ namespace QgsRayCastingUtils /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Implementation of entity that handles chunks of data organized in quadtree with loading data when necessary * based on data error and unloading of data when data are not necessary anymore */ diff --git a/src/3d/chunks/qgschunklist_p.h b/src/3d/chunks/qgschunklist_p.h index 44f1817a075..48d26062e3a 100644 --- a/src/3d/chunks/qgschunklist_p.h +++ b/src/3d/chunks/qgschunklist_p.h @@ -32,7 +32,7 @@ class QgsChunkNode; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Element of a double-linked list * * \note Not available in Python bindings @@ -53,7 +53,7 @@ struct QgsChunkListEntry /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Double linked list of chunks. * * The list does not own entries. diff --git a/src/3d/chunks/qgschunkloader.h b/src/3d/chunks/qgschunkloader.h index 21b858decc6..7c9d47aae98 100644 --- a/src/3d/chunks/qgschunkloader.h +++ b/src/3d/chunks/qgschunkloader.h @@ -34,7 +34,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for jobs that load chunks * * \note Not available in Python bindings @@ -57,7 +57,7 @@ class QgsChunkLoader : public QgsChunkQueueJob /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Factory for chunk loaders for a particular type of entity */ class QgsChunkLoaderFactory : public QObject @@ -117,7 +117,7 @@ class QgsChunkLoaderFactory : public QObject /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for factories where the hierarchy is a quadtree where all leaves * are in the same depth. * @@ -145,7 +145,7 @@ class _3D_EXPORT QgsQuadtreeChunkLoaderFactory : public QgsChunkLoaderFactory }; /** - * \ingroup 3d + * \ingroup qgis_3d * Factory that uses a chunk loader factory for in-place updates * of loaded nodes. Use it with QgsChunkedEntity::updateNodes() * to rebuild entity of an existing node. diff --git a/src/3d/chunks/qgschunknode.h b/src/3d/chunks/qgschunknode.h index c6d1d7f8718..65a9f6abe95 100644 --- a/src/3d/chunks/qgschunknode.h +++ b/src/3d/chunks/qgschunknode.h @@ -105,7 +105,7 @@ struct QgsChunkNodeId }; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Data structure for keeping track of chunks of data for 3D entities that use "out of core" rendering, * i.e. not all of the data are available in the memory all the time. * diff --git a/src/3d/chunks/qgschunkqueuejob.h b/src/3d/chunks/qgschunkqueuejob.h index f86af4d1faf..80a54338837 100644 --- a/src/3d/chunks/qgschunkqueuejob.h +++ b/src/3d/chunks/qgschunkqueuejob.h @@ -39,7 +39,7 @@ namespace Qt3DCore #include /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for chunk queue jobs. * * Job implementations start their work when they are created @@ -85,7 +85,7 @@ class QgsChunkQueueJob : public QObject }; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for factories of chunk queue jobs. * * Derived classes need to implement createJob() method that will create a specific job for given chunk node. diff --git a/src/3d/framegraph/qgs3daxisrenderview.h b/src/3d/framegraph/qgs3daxisrenderview.h index aa46823bd85..74cc37fd8d1 100644 --- a/src/3d/framegraph/qgs3daxisrenderview.h +++ b/src/3d/framegraph/qgs3daxisrenderview.h @@ -51,7 +51,7 @@ class Qgs3DAxis; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3d axis render view class * * \note Not available in Python bindings diff --git a/src/3d/framegraph/qgsabstractrenderview.h b/src/3d/framegraph/qgsabstractrenderview.h index dabf350b64b..d1b28098668 100644 --- a/src/3d/framegraph/qgsabstractrenderview.h +++ b/src/3d/framegraph/qgsabstractrenderview.h @@ -30,7 +30,7 @@ namespace Qt3DRender } // namespace Qt3DRender /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for 3D render view * * An instance of QgsAbstractRenderView is a branch (ie. a render pass, ie. a render view) of the framegraph. diff --git a/src/3d/framegraph/qgsambientocclusionblurentity.h b/src/3d/framegraph/qgsambientocclusionblurentity.h index a7d3c908afc..dd892e1ac8a 100644 --- a/src/3d/framegraph/qgsambientocclusionblurentity.h +++ b/src/3d/framegraph/qgsambientocclusionblurentity.h @@ -21,7 +21,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief An entity that is responsible for blurring the ambient occlusion factor texture. * * \note Not available in Python bindings diff --git a/src/3d/framegraph/qgsambientocclusionrenderentity.h b/src/3d/framegraph/qgsambientocclusionrenderentity.h index c4dcf87ba4f..ace7a690275 100644 --- a/src/3d/framegraph/qgsambientocclusionrenderentity.h +++ b/src/3d/framegraph/qgsambientocclusionrenderentity.h @@ -21,7 +21,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief An entity that is responsible for producing an ambient occlusion factor map. * * \note Not available in Python bindings diff --git a/src/3d/framegraph/qgsforwardrenderview.h b/src/3d/framegraph/qgsforwardrenderview.h index ff29fd509d1..e6972b254fe 100644 --- a/src/3d/framegraph/qgsforwardrenderview.h +++ b/src/3d/framegraph/qgsforwardrenderview.h @@ -38,7 +38,7 @@ namespace Qt3DRender #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Container class that holds different objects related to forward rendering * \note Not available in Python bindings * diff --git a/src/3d/framegraph/qgsframegraph.h b/src/3d/framegraph/qgsframegraph.h index 7a45bf438e9..d152ec71630 100644 --- a/src/3d/framegraph/qgsframegraph.h +++ b/src/3d/framegraph/qgsframegraph.h @@ -54,7 +54,7 @@ class QgsShadowSettings; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Container class that holds different objects related to frame graph of 3D scenes * * A frame graph captures configuration of rendering passes when 3D scene gets rendered. diff --git a/src/3d/framegraph/qgsframegraphutils.h b/src/3d/framegraph/qgsframegraphutils.h index 97a95965f48..797d240e7be 100644 --- a/src/3d/framegraph/qgsframegraphutils.h +++ b/src/3d/framegraph/qgsframegraphutils.h @@ -40,7 +40,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Util class to dump Qt3D framegraph or scenegraph. * \since QGIS 3.40 */ diff --git a/src/3d/framegraph/qgspostprocessingentity.h b/src/3d/framegraph/qgspostprocessingentity.h index b7df65d50b4..ee97e0c17ee 100644 --- a/src/3d/framegraph/qgspostprocessingentity.h +++ b/src/3d/framegraph/qgspostprocessingentity.h @@ -25,7 +25,7 @@ class QgsDirectionalLightSettings; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief An entity that is responsible for applying post processing effect. * * \note Not available in Python bindings diff --git a/src/3d/framegraph/qgspreviewquad.h b/src/3d/framegraph/qgspreviewquad.h index 233d37cf459..47591837c49 100644 --- a/src/3d/framegraph/qgspreviewquad.h +++ b/src/3d/framegraph/qgspreviewquad.h @@ -24,7 +24,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Material component for QgsPreviewQuad object * * \note Not available in Python bindings @@ -49,7 +49,7 @@ class QgsPreviewQuadMaterial : public Qt3DRender::QMaterial }; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Rectangular quad entity used for debugging depth maps * * \note Not available in Python bindings diff --git a/src/3d/framegraph/qgsrenderpassquad.h b/src/3d/framegraph/qgsrenderpassquad.h index e0bca9fadf2..2071e6a86d1 100644 --- a/src/3d/framegraph/qgsrenderpassquad.h +++ b/src/3d/framegraph/qgsrenderpassquad.h @@ -28,7 +28,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief An entity that is responsible for rendering a screen quad for a specific rendering pass. * * \note Not available in Python bindings diff --git a/src/3d/framegraph/qgsshadowrenderview.h b/src/3d/framegraph/qgsshadowrenderview.h index 588acd52e77..244386c6cda 100644 --- a/src/3d/framegraph/qgsshadowrenderview.h +++ b/src/3d/framegraph/qgsshadowrenderview.h @@ -57,7 +57,7 @@ class QgsLightSource; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Container class that holds different objects related to shadow rendering * * \note Not available in Python bindings diff --git a/src/3d/lights/qgsdirectionallightsettings.h b/src/3d/lights/qgsdirectionallightsettings.h index 81284d8cdf2..e0bc3b8a15f 100644 --- a/src/3d/lights/qgsdirectionallightsettings.h +++ b/src/3d/lights/qgsdirectionallightsettings.h @@ -25,7 +25,7 @@ class QDomDocument; class QDomElement; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Definition of a directional light in a 3D map scene * * \since QGIS 3.16 diff --git a/src/3d/lights/qgslightsource.h b/src/3d/lights/qgslightsource.h index 84397eaa94f..1b77d51db2a 100644 --- a/src/3d/lights/qgslightsource.h +++ b/src/3d/lights/qgslightsource.h @@ -38,7 +38,7 @@ namespace Qt3DCore #endif /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for light sources in 3d scenes. * * \since QGIS 3.26 diff --git a/src/3d/lights/qgspointlightsettings.h b/src/3d/lights/qgspointlightsettings.h index 08f0e0907ab..c6bd8a8425e 100644 --- a/src/3d/lights/qgspointlightsettings.h +++ b/src/3d/lights/qgspointlightsettings.h @@ -26,7 +26,7 @@ class QDomDocument; class QDomElement; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Definition of a point light in a 3D map scene * * Total light at the distance D from a point light with intensity I diff --git a/src/3d/materials/qgsabstractmaterialsettings.h b/src/3d/materials/qgsabstractmaterialsettings.h index 50de9ab1628..74026bcdec5 100644 --- a/src/3d/materials/qgsabstractmaterialsettings.h +++ b/src/3d/materials/qgsabstractmaterialsettings.h @@ -44,7 +44,7 @@ namespace Qt3DCore /** * \brief Material rendering techniques - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.16 */ enum class QgsMaterialSettingsRenderingTechnique SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsAbstractMaterialSettings, RenderingTechnique ) : int @@ -60,7 +60,7 @@ enum class QgsMaterialSettingsRenderingTechnique SIP_MONKEYPATCH_SCOPEENUM_UNNES /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Context settings for a material. * * \warning This is not considered stable API, and may change in future QGIS releases. It is @@ -107,7 +107,7 @@ class _3D_EXPORT QgsMaterialContext /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Abstract base class for material settings. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/materials/qgsgoochmaterialsettings.h b/src/3d/materials/qgsgoochmaterialsettings.h index 2b65dba7857..ad140534a48 100644 --- a/src/3d/materials/qgsgoochmaterialsettings.h +++ b/src/3d/materials/qgsgoochmaterialsettings.h @@ -25,7 +25,7 @@ class QDomElement; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Basic shading material used for rendering based on the Phong shading model * with three color components: ambient, diffuse and specular. * diff --git a/src/3d/materials/qgsmaterial.h b/src/3d/materials/qgsmaterial.h index b77b634e5f7..b2d4ae56b29 100644 --- a/src/3d/materials/qgsmaterial.h +++ b/src/3d/materials/qgsmaterial.h @@ -30,7 +30,7 @@ namespace Qt3DRender } /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for all materials used within QGIS 3D views. * It provides common functionality (such as clipping) that all materials should support (where applicable). * \since QGIS 3.40 diff --git a/src/3d/materials/qgsmetalroughmaterial.h b/src/3d/materials/qgsmetalroughmaterial.h index adadc4ba8bf..dfa8de82ad9 100644 --- a/src/3d/materials/qgsmetalroughmaterial.h +++ b/src/3d/materials/qgsmetalroughmaterial.h @@ -41,7 +41,7 @@ namespace Qt3DRender ///@cond PRIVATE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief A PBR metal rough material. * \since QGIS 3.36 */ diff --git a/src/3d/materials/qgsmetalroughmaterialsettings.h b/src/3d/materials/qgsmetalroughmaterialsettings.h index d9602c1a484..4238cf241f2 100644 --- a/src/3d/materials/qgsmetalroughmaterialsettings.h +++ b/src/3d/materials/qgsmetalroughmaterialsettings.h @@ -24,7 +24,7 @@ class QDomElement; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief A PBR metal rough shading material used for rendering. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/materials/qgsnullmaterialsettings.h b/src/3d/materials/qgsnullmaterialsettings.h index 32bea1414ca..0a292476975 100644 --- a/src/3d/materials/qgsnullmaterialsettings.h +++ b/src/3d/materials/qgsnullmaterialsettings.h @@ -25,7 +25,7 @@ class QDomElement; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Null shading material used for rendering models and scenes with native textures. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/materials/qgsphongmaterialsettings.h b/src/3d/materials/qgsphongmaterialsettings.h index 1a0a1a3e2a9..dbc394965a2 100644 --- a/src/3d/materials/qgsphongmaterialsettings.h +++ b/src/3d/materials/qgsphongmaterialsettings.h @@ -25,7 +25,7 @@ class QDomElement; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Basic shading material used for rendering based on the Phong shading model * with three color components: ambient, diffuse and specular. * diff --git a/src/3d/materials/qgsphongtexturedmaterial.h b/src/3d/materials/qgsphongtexturedmaterial.h index b857eb53af9..799ae6a9342 100644 --- a/src/3d/materials/qgsphongtexturedmaterial.h +++ b/src/3d/materials/qgsphongtexturedmaterial.h @@ -34,7 +34,7 @@ namespace Qt3DRender ///@cond PRIVATE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief A diffuseSpecular material adapted from Qt's qdiffusespecularmaterial.h * \since QGIS 3.40 */ diff --git a/src/3d/materials/qgsphongtexturedmaterialsettings.h b/src/3d/materials/qgsphongtexturedmaterialsettings.h index 735b9ab9e5d..3a21c587cc9 100644 --- a/src/3d/materials/qgsphongtexturedmaterialsettings.h +++ b/src/3d/materials/qgsphongtexturedmaterialsettings.h @@ -25,7 +25,7 @@ class QDomElement; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief A phong shading model with diffuse texture map. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/materials/qgssimplelinematerialsettings.h b/src/3d/materials/qgssimplelinematerialsettings.h index 755f16f97cc..968f7d64ee4 100644 --- a/src/3d/materials/qgssimplelinematerialsettings.h +++ b/src/3d/materials/qgssimplelinematerialsettings.h @@ -26,7 +26,7 @@ class QDomElement; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Basic shading material used for rendering simple lines as solid line components. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/materials/qgstexturematerial.h b/src/3d/materials/qgstexturematerial.h index 5bd146ddd57..efd3251c7b2 100644 --- a/src/3d/materials/qgstexturematerial.h +++ b/src/3d/materials/qgstexturematerial.h @@ -39,7 +39,7 @@ namespace Qt3DRender ///@cond PRIVATE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief A unlit texture material * \since QGIS 3.40 */ diff --git a/src/3d/mesh/qgsmesh3dmaterial_p.h b/src/3d/mesh/qgsmesh3dmaterial_p.h index bc6c6a5f1fa..9ffdac9fcf6 100644 --- a/src/3d/mesh/qgsmesh3dmaterial_p.h +++ b/src/3d/mesh/qgsmesh3dmaterial_p.h @@ -44,7 +44,7 @@ class QgsMeshLayer; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Implementation of material used to render the mesh layer * \since QGIS 3.12 */ diff --git a/src/3d/mesh/qgsmeshterraingenerator.h b/src/3d/mesh/qgsmeshterraingenerator.h index b949422037d..c5af6e54571 100644 --- a/src/3d/mesh/qgsmeshterraingenerator.h +++ b/src/3d/mesh/qgsmeshterraingenerator.h @@ -26,7 +26,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Implementation of terrain generator that uses the Z values of a mesh layer to build a terrain * \since QGIS 3.12 */ diff --git a/src/3d/qgs3danimationsettings.h b/src/3d/qgs3danimationsettings.h index c93e4c2820e..33a25017914 100644 --- a/src/3d/qgs3danimationsettings.h +++ b/src/3d/qgs3danimationsettings.h @@ -29,7 +29,7 @@ class QgsReadWriteContext; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Class that holds information about animation in 3D view. The animation is defined * as a series of keyframes * \note Not available in Python bindings diff --git a/src/3d/qgs3daxis.h b/src/3d/qgs3daxis.h index ac1c822b6c9..730ba36ec4e 100644 --- a/src/3d/qgs3daxis.h +++ b/src/3d/qgs3daxis.h @@ -40,7 +40,7 @@ class Qgs3DMapScene; class Qgs3DAxisRenderView; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Display 3D ortho axis in the main 3D view. * * Axis are displayed in a dedicated viewport which can be placed all around the main viewport. diff --git a/src/3d/qgs3daxissettings.h b/src/3d/qgs3daxissettings.h index e6084861fd1..9393a0084cf 100644 --- a/src/3d/qgs3daxissettings.h +++ b/src/3d/qgs3daxissettings.h @@ -29,7 +29,7 @@ class QDomElement; /** * \brief Contains the configuration of a 3d axis. * - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.26 */ class _3D_EXPORT Qgs3DAxisSettings diff --git a/src/3d/qgs3dexportobject.h b/src/3d/qgs3dexportobject.h index 64f1779c698..49cf46a0686 100644 --- a/src/3d/qgs3dexportobject.h +++ b/src/3d/qgs3dexportobject.h @@ -34,7 +34,7 @@ class QgsAbstractMaterialSettings; * * \note Not available in Python bindings * - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.16 */ class _3D_EXPORT Qgs3DExportObject diff --git a/src/3d/qgs3dmapcanvas.h b/src/3d/qgs3dmapcanvas.h index 45483104723..63d352b499a 100644 --- a/src/3d/qgs3dmapcanvas.h +++ b/src/3d/qgs3dmapcanvas.h @@ -70,7 +70,7 @@ class QgsRubberBand3D; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Qgs3DMapCanvas is a convenience wrapper to simplify the creation of a 3D window ready to be used with QGIS. * * \note This is a port of qtwindow3d which does not set the default surface when initialized. diff --git a/src/3d/qgs3dmapexportsettings.h b/src/3d/qgs3dmapexportsettings.h index 7642d53abfc..fb9d299aeb5 100644 --- a/src/3d/qgs3dmapexportsettings.h +++ b/src/3d/qgs3dmapexportsettings.h @@ -24,7 +24,7 @@ /** * \brief Manages the various settings the user can choose from when exporting a 3D scene - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.16 */ class _3D_EXPORT Qgs3DMapExportSettings diff --git a/src/3d/qgs3dmapscene.h b/src/3d/qgs3dmapscene.h index 604c87bcb6f..e19ea970e00 100644 --- a/src/3d/qgs3dmapscene.h +++ b/src/3d/qgs3dmapscene.h @@ -61,7 +61,7 @@ class Qgs3DMapSceneEntity; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Entity that encapsulates our 3D scene - contains all other entities (such as terrain) as children. */ #ifndef SIP_RUN diff --git a/src/3d/qgs3dmapsceneentity.h b/src/3d/qgs3dmapsceneentity.h index 9e10f1f2317..fab76a5ea30 100644 --- a/src/3d/qgs3dmapsceneentity.h +++ b/src/3d/qgs3dmapsceneentity.h @@ -40,7 +40,7 @@ class Qgs3DMapSettings; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Abstract entity that all entities rendered in a Qgs3DMapScene inherit * \since QGIS 3.32 */ diff --git a/src/3d/qgs3dmapsettings.h b/src/3d/qgs3dmapsettings.h index da0e3c71420..f925255564e 100644 --- a/src/3d/qgs3dmapsettings.h +++ b/src/3d/qgs3dmapsettings.h @@ -45,7 +45,7 @@ class QgsProject; class QDomElement; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Definition of the world. * * \warning Qgs3DMapSettings are a QObject subclass, and accordingly are not diff --git a/src/3d/qgs3dmaptool.h b/src/3d/qgs3dmaptool.h index b15c51ff04b..0d03911af9c 100644 --- a/src/3d/qgs3dmaptool.h +++ b/src/3d/qgs3dmaptool.h @@ -29,7 +29,7 @@ class QWheelEvent; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for map tools operating on 3D map canvas. * \note Not available in Python bindings * \since QGIS 3.36 (since QGIS 3.4 in QGIS_APP library) diff --git a/src/3d/qgs3drendercontext.h b/src/3d/qgs3drendercontext.h index 6940f74ec12..b3667ae353a 100644 --- a/src/3d/qgs3drendercontext.h +++ b/src/3d/qgs3drendercontext.h @@ -33,7 +33,7 @@ class Qgs3DMapSettings; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Rendering context for preparation of 3D entities. * * Contains a snapshot of properties from Qgs3DMapSettings, in a thread-safe, cheap-to-copy structure. diff --git a/src/3d/qgs3dsceneexporter.h b/src/3d/qgs3dsceneexporter.h index f286d868cde..6baf5d41b42 100644 --- a/src/3d/qgs3dsceneexporter.h +++ b/src/3d/qgs3dsceneexporter.h @@ -51,7 +51,7 @@ class TestQgs3DRendering; * * \note Not available in Python bindings * - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.16 */ class _3D_EXPORT Qgs3DSceneExporter : public Qt3DCore::QEntity diff --git a/src/3d/qgs3dtypes.h b/src/3d/qgs3dtypes.h index abadfeccb8d..f5a1dce4a5d 100644 --- a/src/3d/qgs3dtypes.h +++ b/src/3d/qgs3dtypes.h @@ -19,7 +19,7 @@ #include "qgis_3d.h" /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Defines enumerations and other auxiliary types for QGIS 3D * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/qgs3dutils.h b/src/3d/qgs3dutils.h index ffc51a5b020..6fbf58fbfcf 100644 --- a/src/3d/qgs3dutils.h +++ b/src/3d/qgs3dutils.h @@ -51,7 +51,7 @@ class QSurface; class Qgs3DRenderContext; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Miscellaneous utility functions used from 3D code. * \note Not available in Python bindings */ diff --git a/src/3d/qgs3dwiredmesh_p.h b/src/3d/qgs3dwiredmesh_p.h index 442a15a9b13..8a24e4ad08d 100644 --- a/src/3d/qgs3dwiredmesh_p.h +++ b/src/3d/qgs3dwiredmesh_p.h @@ -41,7 +41,7 @@ class QgsAABB; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Geometry renderer for lines, draws a wired mesh * * \since QGIS 3.26 diff --git a/src/3d/qgsaabb.h b/src/3d/qgsaabb.h index d7bf72b4cd4..33671be73e1 100644 --- a/src/3d/qgsaabb.h +++ b/src/3d/qgsaabb.h @@ -27,7 +27,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Axis-aligned bounding box - in world coords. * \note Not available in Python bindings */ diff --git a/src/3d/qgsabstract3dengine.h b/src/3d/qgsabstract3dengine.h index 55eec97055e..e0750c39be2 100644 --- a/src/3d/qgsabstract3dengine.h +++ b/src/3d/qgsabstract3dengine.h @@ -42,7 +42,7 @@ namespace Qt3DRender class QgsFrameGraph; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for 3D engine implementation. A 3D engine is responsible for setting up * rendering with Qt3D. This means mainly: * diff --git a/src/3d/qgsabstractvectorlayer3drenderer.h b/src/3d/qgsabstractvectorlayer3drenderer.h index ae97007cd8e..04e52867413 100644 --- a/src/3d/qgsabstractvectorlayer3drenderer.h +++ b/src/3d/qgsabstractvectorlayer3drenderer.h @@ -25,7 +25,7 @@ class QgsVectorLayer; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief This class defines configuration of how a vector layer gets tiled for 3D rendering. * * Zoom levels count tells how deep will be the quadtree and thus how many tiles will @@ -68,7 +68,7 @@ class _3D_EXPORT QgsVectorLayer3DTilingSettings /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for 3D renderers that are based on vector layers. * * \since QGIS 3.12 diff --git a/src/3d/qgsambientocclusionsettings.h b/src/3d/qgsambientocclusionsettings.h index 8a6f7faf024..33acb2914a3 100644 --- a/src/3d/qgsambientocclusionsettings.h +++ b/src/3d/qgsambientocclusionsettings.h @@ -28,7 +28,7 @@ class QDomElement; /** * \brief class containing the configuration of ambient occlusion rendering - * \ingroup 3d + * \ingroup qgis_3d * \note Not available in Python bindings * \since QGIS 3.28 */ diff --git a/src/3d/qgscameracontroller.h b/src/3d/qgscameracontroller.h index 9116e2d42d7..25b80da0956 100644 --- a/src/3d/qgscameracontroller.h +++ b/src/3d/qgscameracontroller.h @@ -50,7 +50,7 @@ class QgsWindow3DEngine; class Qgs3DMapScene; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Object that controls camera movement based on user input */ #ifndef SIP_RUN diff --git a/src/3d/qgscamerapose.h b/src/3d/qgscamerapose.h index 250e3e13ef1..a9f1a219a00 100644 --- a/src/3d/qgscamerapose.h +++ b/src/3d/qgscamerapose.h @@ -31,7 +31,7 @@ class QDomDocument; class QDomElement; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Class that encapsulates camera pose in a 3D scene. * * The pose is defined with the following parameters: diff --git a/src/3d/qgsfeature3dhandler_p.h b/src/3d/qgsfeature3dhandler_p.h index a1f89d6a4d1..37b133d05a3 100644 --- a/src/3d/qgsfeature3dhandler_p.h +++ b/src/3d/qgsfeature3dhandler_p.h @@ -37,7 +37,7 @@ class QgsFeature; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Interface to be implemented by 3D symbol implementations in order to generate 3D entities. */ class QgsFeature3DHandler diff --git a/src/3d/qgsgltf3dutils.h b/src/3d/qgsgltf3dutils.h index fe326139829..eb97d9ab8aa 100644 --- a/src/3d/qgsgltf3dutils.h +++ b/src/3d/qgsgltf3dutils.h @@ -45,7 +45,7 @@ namespace Qt3DCore } /** - * \ingroup 3d + * \ingroup qgis_3d * * Utility functions for dealing with GLTF models in 3D map views. * diff --git a/src/3d/qgsimagetexture.h b/src/3d/qgsimagetexture.h index 42d99740c8c..1ba36ad9fe7 100644 --- a/src/3d/qgsimagetexture.h +++ b/src/3d/qgsimagetexture.h @@ -30,7 +30,7 @@ * * \note Not available in Python bindings * - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.16 */ class _3D_EXPORT QgsImageTexture : public Qt3DRender::QPaintedTextureImage diff --git a/src/3d/qgslayoutitem3dmap.h b/src/3d/qgslayoutitem3dmap.h index 913422b80e6..c7179b9fff3 100644 --- a/src/3d/qgslayoutitem3dmap.h +++ b/src/3d/qgslayoutitem3dmap.h @@ -35,7 +35,7 @@ class Qgs3DMapSettings; class QgsOffscreen3DEngine; /** - * \ingroup 3d + * \ingroup qgis_3d * * \brief Implements support of 3D map views in print layouts * diff --git a/src/3d/qgsoffscreen3dengine.h b/src/3d/qgsoffscreen3dengine.h index 1ce4a2418bc..76c615a5bcb 100644 --- a/src/3d/qgsoffscreen3dengine.h +++ b/src/3d/qgsoffscreen3dengine.h @@ -50,7 +50,7 @@ namespace Qt3DLogic #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Off-screen 3D engine implementation. It is useful for recording rendered 3D scenes of arbitrary size. * * \note While the on-screen 3D engine also allows capturing of images, its limitation is that diff --git a/src/3d/qgspointcloudlayerchunkloader_p.h b/src/3d/qgspointcloudlayerchunkloader_p.h index cca72a51593..fa8095c17bc 100644 --- a/src/3d/qgspointcloudlayerchunkloader_p.h +++ b/src/3d/qgspointcloudlayerchunkloader_p.h @@ -48,7 +48,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief This loader factory is responsible for creation of loaders for individual tiles * of QgsQgsPointCloudLayerChunkedEntity whenever a new tile is requested by the entity. * @@ -83,7 +83,7 @@ class QgsPointCloudLayerChunkLoaderFactory : public QgsChunkLoaderFactory /** - * \ingroup 3d + * \ingroup qgis_3d * \brief This loader class is responsible for async loading of data for a single tile * of QgsPointCloudLayerChunkedEntity and creation of final 3D entity from the data * previously prepared in a worker thread. @@ -114,7 +114,7 @@ class QgsPointCloudLayerChunkLoader : public QgsChunkLoader /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D entity used for rendering of point cloud layers with a single 3D symbol for all points. * * It is implemented using tiling approach with QgsChunkedEntity. Internally it uses diff --git a/src/3d/qgsrubberband3d.h b/src/3d/qgsrubberband3d.h index 8f279ac43a2..c22c8f0d6bf 100644 --- a/src/3d/qgsrubberband3d.h +++ b/src/3d/qgsrubberband3d.h @@ -69,7 +69,7 @@ namespace Qt3DRender } // namespace Qt3DRender /** - * \ingroup 3d + * \ingroup qgis_3d * Rubber band implementation for use in 3D map views. * * Coordinates are expected to be passed in map CRS and the 3D entity generated by this diff --git a/src/3d/qgsrulebased3drenderer.h b/src/3d/qgsrulebased3drenderer.h index 77038991363..8e9cfa2734f 100644 --- a/src/3d/qgsrulebased3drenderer.h +++ b/src/3d/qgsrulebased3drenderer.h @@ -29,7 +29,7 @@ class QgsFeature3DHandler; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Metadata for rule-based 3D renderer to allow creation of its instances from XML * * \warning This is not considered stable API, and may change in future QGIS releases. It is @@ -48,7 +48,7 @@ class _3D_EXPORT QgsRuleBased3DRendererMetadata : public Qgs3DRendererAbstractMe /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Rule-based 3D renderer. * * Similar to rule-based 2D renderer and rule-based labeling, it allows specification of rules for 3D symbols. @@ -66,7 +66,7 @@ class _3D_EXPORT QgsRuleBased3DRenderer : public QgsAbstractVectorLayer3DRendere typedef QHash RuleToHandlerMap; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief A child rule for a QgsRuleBased3DRenderer * \since QGIS 3.6 */ diff --git a/src/3d/qgsrulebasedchunkloader_p.h b/src/3d/qgsrulebasedchunkloader_p.h index 0c7d7942cb2..87586b6e6c8 100644 --- a/src/3d/qgsrulebasedchunkloader_p.h +++ b/src/3d/qgsrulebasedchunkloader_p.h @@ -47,7 +47,7 @@ namespace Qt3DCore } /** - * \ingroup 3d + * \ingroup qgis_3d * \brief This loader factory is responsible for creation of loaders for individual tiles * of QgsRuleBasedChunkedEntity whenever a new tile is requested by the entity. * @@ -73,7 +73,7 @@ class QgsRuleBasedChunkLoaderFactory : public QgsQuadtreeChunkLoaderFactory /** - * \ingroup 3d + * \ingroup qgis_3d * \brief This loader class is responsible for async loading of data for a single tile * of QgsRuleBasedChunkedEntity and creation of final 3D entity from the data * previously prepared in a worker thread. @@ -104,7 +104,7 @@ class QgsRuleBasedChunkLoader : public QgsChunkLoader /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D entity used for rendering of vector layers using a hierarchy of rules (just like * in case of 2D rule-based rendering or labeling). * diff --git a/src/3d/qgsshadowsettings.h b/src/3d/qgsshadowsettings.h index 9ad1d607dee..7827c3b5e17 100644 --- a/src/3d/qgsshadowsettings.h +++ b/src/3d/qgsshadowsettings.h @@ -28,7 +28,7 @@ class QDomElement; /** * \brief class containing the configuration of shadows rendering - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.16 */ class _3D_EXPORT QgsShadowSettings diff --git a/src/3d/qgsskyboxentity.h b/src/3d/qgsskyboxentity.h index a5b7c6ffa31..f468908fd68 100644 --- a/src/3d/qgsskyboxentity.h +++ b/src/3d/qgsskyboxentity.h @@ -38,7 +38,7 @@ class QgsImageTexture; * \brief Base class for all skybox types. * * It holds the common member data between different skybox entity types - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.16 */ class _3D_EXPORT QgsSkyboxEntity : public Qt3DCore::QEntity @@ -73,7 +73,7 @@ class _3D_EXPORT QgsSkyboxEntity : public Qt3DCore::QEntity /** * \brief A skybox constructed from a panoramic image. * - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.16 */ class _3D_EXPORT QgsPanoramicSkyboxEntity : public QgsSkyboxEntity @@ -101,7 +101,7 @@ class _3D_EXPORT QgsPanoramicSkyboxEntity : public QgsSkyboxEntity /** * \brief A skybox constructed from a 6 cube faces. * - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.16 */ class _3D_EXPORT QgsCubeFacesSkyboxEntity : public QgsSkyboxEntity diff --git a/src/3d/qgsskyboxsettings.h b/src/3d/qgsskyboxsettings.h index e15d15285bd..4ba26c4f587 100644 --- a/src/3d/qgsskyboxsettings.h +++ b/src/3d/qgsskyboxsettings.h @@ -30,7 +30,7 @@ class QDomElement; /** * \brief Contains the configuration of a skybox entity. * - * \ingroup 3d + * \ingroup qgis_3d * \since QGIS 3.16 */ class _3D_EXPORT QgsSkyboxSettings diff --git a/src/3d/qgstessellatedpolygongeometry.h b/src/3d/qgstessellatedpolygongeometry.h index 130b9130661..bdf95e89cfe 100644 --- a/src/3d/qgstessellatedpolygongeometry.h +++ b/src/3d/qgstessellatedpolygongeometry.h @@ -48,7 +48,7 @@ namespace Qt3DCore #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Class derived from Qt3DRender::QGeometry that represents polygons tessellated into 3D geometry. * * Takes a list of polygons as input, internally it does tessellation and writes output to the internal diff --git a/src/3d/qgstiledscenechunkloader_p.h b/src/3d/qgstiledscenechunkloader_p.h index 95e8c86fc0f..5ebdb0bb2f5 100644 --- a/src/3d/qgstiledscenechunkloader_p.h +++ b/src/3d/qgstiledscenechunkloader_p.h @@ -44,7 +44,7 @@ class QgsTiledSceneChunkLoaderFactory; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief This loader class is responsible for async loading of data for a single tile * of tiled scene chunk entity and creation of final 3D entity from the data * previously prepared in a worker thread. @@ -70,7 +70,7 @@ class QgsTiledSceneChunkLoader : public QgsChunkLoader /** - * \ingroup 3d + * \ingroup qgis_3d * \brief This loader factory is responsible for creation of loaders for individual tiles * of tiled scene chunk entity whenever a new tile is requested by the entity. * @@ -107,7 +107,7 @@ class QgsTiledSceneChunkLoaderFactory : public QgsChunkLoaderFactory /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D entity used for rendering of tiled scene layers. * * It is implemented using tiling approach with QgsChunkedEntity. Internally it uses diff --git a/src/3d/qgstiledscenelayer3drenderer.h b/src/3d/qgstiledscenelayer3drenderer.h index 866fcc7646f..7aa45c09a3a 100644 --- a/src/3d/qgstiledscenelayer3drenderer.h +++ b/src/3d/qgstiledscenelayer3drenderer.h @@ -27,7 +27,7 @@ class QgsTiledSceneLayer; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Metadata for tiled scene layer 3D renderer to allow creation of its instances from XML * * \since QGIS 3.34 @@ -43,7 +43,7 @@ class _3D_EXPORT QgsTiledSceneLayer3DRendererMetadata : public Qgs3DRendererAbst /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D renderer that renders content of a tiled scene layer * * \since QGIS 3.34 diff --git a/src/3d/qgstilingscheme.h b/src/3d/qgstilingscheme.h index 61f61075eb1..fe7d83b134c 100644 --- a/src/3d/qgstilingscheme.h +++ b/src/3d/qgstilingscheme.h @@ -27,7 +27,7 @@ struct QgsChunkNodeId; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief The class encapsulates tiling scheme (just like with WMTS / TMS / XYZ layers). * * The origin (tile [0,0]) is in bottom-left corner. diff --git a/src/3d/qgsvectorlayerchunkloader_p.h b/src/3d/qgsvectorlayerchunkloader_p.h index 33b8d15cf4a..84514927706 100644 --- a/src/3d/qgsvectorlayerchunkloader_p.h +++ b/src/3d/qgsvectorlayerchunkloader_p.h @@ -48,7 +48,7 @@ namespace Qt3DCore /** - * \ingroup 3d + * \ingroup qgis_3d * \brief This loader factory is responsible for creation of loaders for individual tiles * of QgsVectorLayerChunkedEntity whenever a new tile is requested by the entity. * @@ -73,7 +73,7 @@ class QgsVectorLayerChunkLoaderFactory : public QgsQuadtreeChunkLoaderFactory /** - * \ingroup 3d + * \ingroup qgis_3d * \brief This loader class is responsible for async loading of data for a single tile * of QgsVectorLayerChunkedEntity and creation of final 3D entity from the data * previously prepared in a worker thread. @@ -104,7 +104,7 @@ class QgsVectorLayerChunkLoader : public QgsChunkLoader /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D entity used for rendering of vector layers with a single 3D symbol for all features. * * It is implemented using tiling approach with QgsChunkedEntity. Internally it uses diff --git a/src/3d/qgsvirtualpointcloudentity_p.h b/src/3d/qgsvirtualpointcloudentity_p.h index 4b03cb32007..d95087922ca 100644 --- a/src/3d/qgsvirtualpointcloudentity_p.h +++ b/src/3d/qgsvirtualpointcloudentity_p.h @@ -43,7 +43,7 @@ class Qgs3DMapSettings; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Implementation of entity that handles virtual point cloud sub indexes * * This entity is parent to a QgsChunkBoundsEntity that renders all sub indexes' bounding boxes, as well as all individual diff --git a/src/3d/qgswindow3dengine.h b/src/3d/qgswindow3dengine.h index 02df2667e64..7936a753984 100644 --- a/src/3d/qgswindow3dengine.h +++ b/src/3d/qgswindow3dengine.h @@ -34,7 +34,7 @@ class QWindow; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief On-screen 3D engine: it creates OpenGL window (QWindow) and displays rendered 3D scene there. * The window can be embedded into a QWidget-based application with QWidget::createWindowContainer(). * diff --git a/src/3d/symbols/qgsbillboardgeometry.h b/src/3d/symbols/qgsbillboardgeometry.h index 6d91f998d37..285eaf82a65 100644 --- a/src/3d/symbols/qgsbillboardgeometry.h +++ b/src/3d/symbols/qgsbillboardgeometry.h @@ -30,7 +30,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Geometry of the billboard rendering for points in 3D map view. * * \note Not available in Python bindings diff --git a/src/3d/symbols/qgsline3dsymbol.h b/src/3d/symbols/qgsline3dsymbol.h index ae644df2106..426963a962d 100644 --- a/src/3d/symbols/qgsline3dsymbol.h +++ b/src/3d/symbols/qgsline3dsymbol.h @@ -24,7 +24,7 @@ class QgsAbstractMaterialSettings; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D symbol that draws linestring geometries as planar polygons (created from lines using a buffer with given thickness). * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/symbols/qgslinematerial_p.h b/src/3d/symbols/qgslinematerial_p.h index a16e3823d8f..498f2686694 100644 --- a/src/3d/symbols/qgslinematerial_p.h +++ b/src/3d/symbols/qgslinematerial_p.h @@ -34,7 +34,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Implementation of material that renders 3D linestrings. * * Supports: diff --git a/src/3d/symbols/qgslinevertexdata_p.h b/src/3d/symbols/qgslinevertexdata_p.h index 76f4305e8d5..fcb5da2d457 100644 --- a/src/3d/symbols/qgslinevertexdata_p.h +++ b/src/3d/symbols/qgslinevertexdata_p.h @@ -55,7 +55,7 @@ class QgsLineString; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Helper class to store vertex buffer and index buffer data that will be used to render * lines (either using "line strip" or "line strip with adjacency" primitive. * diff --git a/src/3d/symbols/qgsmesh3dsymbol.h b/src/3d/symbols/qgsmesh3dsymbol.h index 7f89164a67e..fc3a53490cd 100644 --- a/src/3d/symbols/qgsmesh3dsymbol.h +++ b/src/3d/symbols/qgsmesh3dsymbol.h @@ -27,7 +27,7 @@ class QgsAbstractMaterialSettings; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D symbol that draws mesh geometry as planar triangles. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/symbols/qgspoint3dbillboardmaterial.h b/src/3d/symbols/qgspoint3dbillboardmaterial.h index 61b7d35c0d7..ba197bdf65a 100644 --- a/src/3d/symbols/qgspoint3dbillboardmaterial.h +++ b/src/3d/symbols/qgspoint3dbillboardmaterial.h @@ -27,7 +27,7 @@ class QgsMarkerSymbol; class Qgs3DRenderContext; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Material of the billboard rendering for points in 3D map view. * * \note Not available in Python bindings diff --git a/src/3d/symbols/qgspoint3dsymbol.h b/src/3d/symbols/qgspoint3dsymbol.h index 6d14fff3867..67a0d3b6d94 100644 --- a/src/3d/symbols/qgspoint3dsymbol.h +++ b/src/3d/symbols/qgspoint3dsymbol.h @@ -28,7 +28,7 @@ class QgsAbstractMaterialSettings; class QgsMarkerSymbol; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D symbol that draws point geometries as 3D objects using one of the predefined shapes. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/symbols/qgspointcloud3dsymbol.h b/src/3d/symbols/qgspointcloud3dsymbol.h index a8a38c7e1f7..f7d5d19c573 100644 --- a/src/3d/symbols/qgspointcloud3dsymbol.h +++ b/src/3d/symbols/qgspointcloud3dsymbol.h @@ -27,7 +27,7 @@ #include "qgspointcloudclassifiedrenderer.h" /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D symbol that draws point cloud geometries as 3D objects. * * \warning This is not considered stable API, and may change in future QGIS releases. It is @@ -186,7 +186,7 @@ class _3D_EXPORT QgsPointCloud3DSymbol : public QgsAbstract3DSymbol SIP_ABSTRACT }; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D symbol that draws point cloud geometries as 3D objects.using one color * * \warning This is not considered stable API, and may change in future QGIS releases. It is @@ -226,7 +226,7 @@ class _3D_EXPORT QgsSingleColorPointCloud3DSymbol : public QgsPointCloud3DSymbol }; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D symbol that draws point cloud geometries as 3D objects.using color ramp shader * * \warning This is not considered stable API, and may change in future QGIS releases. It is @@ -299,7 +299,7 @@ class _3D_EXPORT QgsColorRampPointCloud3DSymbol : public QgsPointCloud3DSymbol }; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D symbol that draws point cloud geometries as 3D objects using RGB colors in the dataset * * \warning This is not considered stable API, and may change in future QGIS releases. It is @@ -456,7 +456,7 @@ class _3D_EXPORT QgsRgbPointCloud3DSymbol : public QgsPointCloud3DSymbol }; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D symbol that draws point cloud geometries as 3D objects using classification of the dataset * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/symbols/qgspolygon3dsymbol.h b/src/3d/symbols/qgspolygon3dsymbol.h index 047d912f878..b6eff9c4759 100644 --- a/src/3d/symbols/qgspolygon3dsymbol.h +++ b/src/3d/symbols/qgspolygon3dsymbol.h @@ -26,7 +26,7 @@ class QgsAbstractMaterialSettings; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief 3D symbol that draws polygon geometries as planar polygons, optionally extruded (with added walls). * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/terrain/qgsabstractterrainsettings.h b/src/3d/terrain/qgsabstractterrainsettings.h index db1b75d8b0e..912dcb8c08b 100644 --- a/src/3d/terrain/qgsabstractterrainsettings.h +++ b/src/3d/terrain/qgsabstractterrainsettings.h @@ -28,7 +28,7 @@ class QgsTerrainGenerator; class Qgs3DRenderContext; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for all terrain settings classes. * * QgsAbstractTerrainSettings subclasses are responsible for storing the configuration diff --git a/src/3d/terrain/qgsdemterraingenerator.h b/src/3d/terrain/qgsdemterraingenerator.h index 6a76ee68099..8d355fd172f 100644 --- a/src/3d/terrain/qgsdemterraingenerator.h +++ b/src/3d/terrain/qgsdemterraingenerator.h @@ -28,7 +28,7 @@ class QgsDemHeightMapGenerator; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Implementation of terrain generator that uses a raster layer with DEM to build terrain. * * \note Not available in Python bindings diff --git a/src/3d/terrain/qgsdemterrainsettings.h b/src/3d/terrain/qgsdemterrainsettings.h index d8485a48533..a482949e144 100644 --- a/src/3d/terrain/qgsdemterrainsettings.h +++ b/src/3d/terrain/qgsdemterrainsettings.h @@ -24,7 +24,7 @@ class QgsRasterLayer; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Terrain settings for a terrain generator that uses a raster DEM layer to build terrain. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/terrain/qgsdemterraintilegeometry_p.h b/src/3d/terrain/qgsdemterraintilegeometry_p.h index a793f9653f1..d2ace632432 100644 --- a/src/3d/terrain/qgsdemterraintilegeometry_p.h +++ b/src/3d/terrain/qgsdemterraintilegeometry_p.h @@ -59,7 +59,7 @@ namespace QgsRayCastingUtils } /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Stores attributes and vertex/index buffers for one terrain tile based on DEM. */ #if QT_VERSION < QT_VERSION_CHECK( 6, 0, 0 ) diff --git a/src/3d/terrain/qgsdemterraintileloader_p.h b/src/3d/terrain/qgsdemterraintileloader_p.h index 02884d87632..dedcebf7768 100644 --- a/src/3d/terrain/qgsdemterraintileloader_p.h +++ b/src/3d/terrain/qgsdemterraintileloader_p.h @@ -46,7 +46,7 @@ class QgsCoordinateTransformContext; class QgsTerrainGenerator; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Chunk loader for DEM terrain tiles. */ class QgsDemTerrainTileLoader : public QgsTerrainTileLoader @@ -72,7 +72,7 @@ class QgsDemTerrainTileLoader : public QgsTerrainTileLoader class QgsTerrainDownloader; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Utility class to asynchronously create heightmaps from DEM raster for given tiles of terrain. */ class QgsDemHeightMapGenerator : public QObject diff --git a/src/3d/terrain/qgsflatterraingenerator.h b/src/3d/terrain/qgsflatterraingenerator.h index 282d29a948a..fbfc7cfa6e5 100644 --- a/src/3d/terrain/qgsflatterraingenerator.h +++ b/src/3d/terrain/qgsflatterraingenerator.h @@ -44,7 +44,7 @@ class FlatTerrainChunkLoader : public QgsTerrainTileLoader ///@endcond /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Terrain generator that creates a simple square flat area. * */ diff --git a/src/3d/terrain/qgsflatterrainsettings.h b/src/3d/terrain/qgsflatterrainsettings.h index 2bfe208c5cb..59a863057f1 100644 --- a/src/3d/terrain/qgsflatterrainsettings.h +++ b/src/3d/terrain/qgsflatterrainsettings.h @@ -26,7 +26,7 @@ class QgsReadWriteContext; class QgsProject; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Terrain settings for a simple flat area terrain. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/terrain/qgsmeshterrainsettings.h b/src/3d/terrain/qgsmeshterrainsettings.h index c7e1f109895..f136e3d24aa 100644 --- a/src/3d/terrain/qgsmeshterrainsettings.h +++ b/src/3d/terrain/qgsmeshterrainsettings.h @@ -28,7 +28,7 @@ class QgsMeshLayer; class QgsMesh3DSymbol; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Terrain settings for a terrain generator that uses uses the Z values of a mesh layer to build a terrain. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/terrain/qgsonlinedemterrainsettings.h b/src/3d/terrain/qgsonlinedemterrainsettings.h index c4ee114f33c..d59fab79fce 100644 --- a/src/3d/terrain/qgsonlinedemterrainsettings.h +++ b/src/3d/terrain/qgsonlinedemterrainsettings.h @@ -22,7 +22,7 @@ #include "qgsrectangle.h" /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Terrain settings for a terrain generator that uses an online DEM to build terrain. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/terrain/qgsonlineterraingenerator.h b/src/3d/terrain/qgsonlineterraingenerator.h index d6e08d12066..88099dc7240 100644 --- a/src/3d/terrain/qgsonlineterraingenerator.h +++ b/src/3d/terrain/qgsonlineterraingenerator.h @@ -27,7 +27,7 @@ class QgsDemHeightMapGenerator; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Implementation of terrain generator that uses online resources to download heightmaps. * * \note Not available in Python bindings diff --git a/src/3d/terrain/qgsquantizedmeshterraingenerator.h b/src/3d/terrain/qgsquantizedmeshterraingenerator.h index 938e0dfc254..bc96c470f61 100644 --- a/src/3d/terrain/qgsquantizedmeshterraingenerator.h +++ b/src/3d/terrain/qgsquantizedmeshterraingenerator.h @@ -29,7 +29,7 @@ #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Terrain generator using a Quantized Mesh tile layer * \since QGIS 3.40 */ diff --git a/src/3d/terrain/qgsquantizedmeshterrainsettings.h b/src/3d/terrain/qgsquantizedmeshterrainsettings.h index cadc24d2a59..c7b5a83f9a1 100644 --- a/src/3d/terrain/qgsquantizedmeshterrainsettings.h +++ b/src/3d/terrain/qgsquantizedmeshterrainsettings.h @@ -27,7 +27,7 @@ class QgsProject; class QgsTiledSceneLayer; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Terrain settings for a terrain generator that uses uses a quantized mesh tile layer to build a terrain. * * \warning This is not considered stable API, and may change in future QGIS releases. It is diff --git a/src/3d/terrain/qgsterraindownloader.h b/src/3d/terrain/qgsterraindownloader.h index de600123e73..b696e73cc24 100644 --- a/src/3d/terrain/qgsterraindownloader.h +++ b/src/3d/terrain/qgsterraindownloader.h @@ -32,7 +32,7 @@ class QgsCoordinateTransformContext; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Takes care of downloading terrain data from a publicly available data source. * * Currently using terrain tiles in Terrarium format hosted on AWS. More info: diff --git a/src/3d/terrain/qgsterrainentity.h b/src/3d/terrain/qgsterrainentity.h index cfdc7b3652b..f22135a54ec 100644 --- a/src/3d/terrain/qgsterrainentity.h +++ b/src/3d/terrain/qgsterrainentity.h @@ -48,7 +48,7 @@ class QgsTerrainGenerator; class TerrainMapUpdateJobFactory; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Controller for terrain - decides on what terrain tiles to show based on camera position * and creates them using map's terrain tile generator. */ diff --git a/src/3d/terrain/qgsterraingenerator.h b/src/3d/terrain/qgsterraingenerator.h index 21e657da470..4907645ec41 100644 --- a/src/3d/terrain/qgsterraingenerator.h +++ b/src/3d/terrain/qgsterraingenerator.h @@ -35,7 +35,7 @@ class QgsProject; #define SIP_NO_FILE /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for generators of terrain. * * All terrain generators are tile based diff --git a/src/3d/terrain/qgsterraintexturegenerator_p.h b/src/3d/terrain/qgsterraintexturegenerator_p.h index 3f97c8be118..b3f978002e3 100644 --- a/src/3d/terrain/qgsterraintexturegenerator_p.h +++ b/src/3d/terrain/qgsterraintexturegenerator_p.h @@ -43,7 +43,7 @@ class QgsRasterLayer; class Qgs3DMapSettings; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Class responsible for rendering map images in background for the purposes of their use * as textures for terrain's tiles. * diff --git a/src/3d/terrain/qgsterraintextureimage_p.h b/src/3d/terrain/qgsterraintextureimage_p.h index b373264bbc7..8df1c69505a 100644 --- a/src/3d/terrain/qgsterraintextureimage_p.h +++ b/src/3d/terrain/qgsterraintextureimage_p.h @@ -36,7 +36,7 @@ class QgsTerrainTextureGenerator; /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Class that stores an image with a rendered map. The image is used as a texture for one map tile. * * The texture is provided to Qt 3D through the implementation of dataGenerator() method. diff --git a/src/3d/terrain/qgsterraintileentity_p.h b/src/3d/terrain/qgsterraintileentity_p.h index 7915e3d0631..773a9d2bf8d 100644 --- a/src/3d/terrain/qgsterraintileentity_p.h +++ b/src/3d/terrain/qgsterraintileentity_p.h @@ -34,7 +34,7 @@ class QgsTerrainTextureImage; #include "qgschunknode.h" /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for 3D entities representing one tile of terrain. * It contains pointer to tile's texture image. * diff --git a/src/3d/terrain/qgsterraintileloader.h b/src/3d/terrain/qgsterraintileloader.h index 120d1f50da9..7905e42362a 100644 --- a/src/3d/terrain/qgsterraintileloader.h +++ b/src/3d/terrain/qgsterraintileloader.h @@ -45,7 +45,7 @@ namespace Qt3DRender /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Base class for chunk loaders for terrain tiles. * * Adds functionality for asynchronous rendering of terrain tile map texture and access to the terrain entity. diff --git a/src/core/3d/qgsabstract3dsymbol.h b/src/core/3d/qgsabstract3dsymbol.h index 16ef3fa6ea1..005eb430d36 100644 --- a/src/core/3d/qgsabstract3dsymbol.h +++ b/src/core/3d/qgsabstract3dsymbol.h @@ -31,7 +31,7 @@ namespace Qt3DCore SIP_SKIP { class QEntity; } /** - * \ingroup 3d + * \ingroup qgis_3d * \brief Abstract base class for 3D symbols that are used by VectorLayer3DRenderer objects. * * 3D symbol objects define appearance of GIS data. diff --git a/tests/code_layout/test_doxygen_layout.sh b/tests/code_layout/test_doxygen_layout.sh index 60c00ce1b75..5b99830c214 100755 --- a/tests/code_layout/test_doxygen_layout.sh +++ b/tests/code_layout/test_doxygen_layout.sh @@ -21,7 +21,12 @@ if [[ -n $output ]]; then exit 1 fi - +# check that \return(s) is placed before \note and \since +output=$(unbuffer ag --noaffinity --file-search-regex '\.h$' '\\ingroup 3d' ${PATHS} | tee /dev/stderr) +if [[ -n $output ]]; then + echo -e "\n\x1B[31m*** Docstring computation: Use \\\ingroup qgis_3d not \\\ingroup 3d\x1B[0m" + exit 1 +fi # code snippets command output=$(unbuffer ag --noaffinity --file-search-regex '\.h$' --multiline '~~~\{\.\w+\}' ${PATHS} | tee /dev/stderr)