Skip to content

Commit 1eeb2ee

Browse files
committedSep 25, 2017
Add 3d doxygen group + more doxymentation
1 parent 2a8ddcc commit 1eeb2ee

File tree

4 files changed

+19
-4
lines changed

4 files changed

+19
-4
lines changed
 

‎doc/modules.dox

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ components to QGIS.
2525

2626
*/
2727

28+
/** @defgroup 3d 3D library
29+
30+
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.
31+
32+
*/
33+
2834
/** @defgroup plugins plugin classes
2935

3036
Contains classes related to implementation of QGIS plugins.

‎src/3d/chunks/chunkedentity.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class ChunkedEntity : public Qt3DCore::QEntity
3939
ChunkedEntity( const AABB &rootBbox, float rootError, float tau, int maxLevel, ChunkLoaderFactory *loaderFactory, Qt3DCore::QNode *parent = nullptr );
4040
~ChunkedEntity();
4141

42-
//!< Called when e.g. camera changes and entity may need updated
42+
//! Called when e.g. camera changes and entity may need updated
4343
void update( const SceneState &state );
4444

4545
bool needsUpdate; //!< A chunk has been loaded recently - let's display it!

‎src/3d/chunks/chunklist.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33

44
class ChunkNode;
55

6-
//! Element of a double-linked list
6+
/** \ingroup 3d
7+
* Element of a double-linked list
8+
* \since QGIS 3.0
9+
*/
710
class ChunkListEntry
811
{
912
public:

‎src/3d/chunks/chunkloader.h

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,10 @@ class ChunkQueueJobFactory
6565
};
6666

6767

68-
//! Base class for jobs that load chunks
68+
/** \ingroup 3d
69+
* Base class for jobs that load chunks
70+
* \since QGIS 3.0
71+
*/
6972
class ChunkLoader : public ChunkQueueJob
7073
{
7174
Q_OBJECT
@@ -85,7 +88,10 @@ class ChunkLoader : public ChunkQueueJob
8588
};
8689

8790

88-
//! Factory for chunk loaders for a particular type of entity
91+
/** \ingroup 3d
92+
* Factory for chunk loaders for a particular type of entity
93+
* \since QGIS 3.0
94+
*/
8995
class ChunkLoaderFactory
9096
{
9197
public:

0 commit comments

Comments
 (0)
Please sign in to comment.