Add 3d doxygen group + more doxymentation

qgis · Sep 25, 2017 · 1eeb2ee · 1eeb2ee
1 parent 2a8ddcc
commit 1eeb2ee
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 4 deletions.
diff --git a/doc/modules.dox b/doc/modules.dox
@@ -25,6 +25,12 @@ components to QGIS.
 
 */
 
+/** @defgroup 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.
+
+*/
+
 /** @defgroup plugins plugin classes
 
 Contains classes related to implementation of QGIS plugins.

diff --git a/src/3d/chunks/chunkedentity.h b/src/3d/chunks/chunkedentity.h
@@ -39,7 +39,7 @@ class ChunkedEntity : public Qt3DCore::QEntity
     ChunkedEntity( const AABB &rootBbox, float rootError, float tau, int maxLevel, ChunkLoaderFactory *loaderFactory, Qt3DCore::QNode *parent = nullptr );
     ~ChunkedEntity();
 
-    //!< Called when e.g. camera changes and entity may need updated
+    //! Called when e.g. camera changes and entity may need updated
     void update( const SceneState &state );
 
     bool needsUpdate; //!< A chunk has been loaded recently - let's display it!

diff --git a/src/3d/chunks/chunklist.h b/src/3d/chunks/chunklist.h
@@ -3,7 +3,10 @@
 
 class ChunkNode;
 
-//! Element of a double-linked list
+/** \ingroup 3d
+ * Element of a double-linked list
+ * \since QGIS 3.0
+ */
 class ChunkListEntry
 {
   public:

diff --git a/src/3d/chunks/chunkloader.h b/src/3d/chunks/chunkloader.h
@@ -65,7 +65,10 @@ class ChunkQueueJobFactory
 };
 
 
-//! Base class for jobs that load chunks
+/** \ingroup 3d
+ * Base class for jobs that load chunks
+ * \since QGIS 3.0
+ */
 class ChunkLoader : public ChunkQueueJob
 {
     Q_OBJECT
@@ -85,7 +88,10 @@ class ChunkLoader : public ChunkQueueJob
 };
 
 
-//! Factory for chunk loaders for a particular type of entity
+/** \ingroup 3d
+ * Factory for chunk loaders for a particular type of entity
+ * \since QGIS 3.0
+ */
 class ChunkLoaderFactory
 {
   public: