Skip to content

Commit 0a056f8

Browse files
committed
Add doxygen test to force use of \ingroup for classes
Using the group tag helps keep the API docs organized
1 parent a240cd8 commit 0a056f8

File tree

470 files changed

+1464
-513
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

470 files changed

+1464
-513
lines changed

doc/modules.dox

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,10 @@ The SERVER library is built on top of the CORE library and adds map server
2828
components to QGIS.
2929

3030
*/
31+
32+
/** @defgroup plugins plugin classes
33+
34+
Contains classes related to implementation of QGIS plugins.
35+
36+
*/
37+

src/analysis/interpolation/Bezier3D.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
#include "MathUtils.h"
2323
#include "qgslogger.h"
2424

25-
/** Class Bezier3D represents a bezier curve, represented by control points. Parameter t is running from 0 to 1. The class is capable to calculate the curve point and the first two derivatives belonging to t.*/
25+
/** \ingroup analysis
26+
* Class Bezier3D represents a bezier curve, represented by control points. Parameter t is running from 0 to 1. The class is capable to calculate the curve point and the first two derivatives belonging to t.*/
2627
class ANALYSIS_EXPORT Bezier3D: public ParametricLine
2728
{
2829
protected:

src/analysis/interpolation/CloughTocherInterpolator.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
#include "MathUtils.h"
2525
#include "Bezier3D.h"
2626

27-
/** This is an implementation of a Clough-Tocher interpolator based on a triangular tessellation. The derivatives orthogonal to the boundary curves are interpolated linearly along a triangle edge.*/
27+
/** \ingroup analysis
28+
* This is an implementation of a Clough-Tocher interpolator based on a triangular tessellation. The derivatives orthogonal to the boundary curves are interpolated linearly along a triangle edge.*/
2829
class ANALYSIS_EXPORT CloughTocherInterpolator : public TriangleInterpolator
2930
{
3031
protected:

src/analysis/interpolation/DualEdgeTriangulation.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
#include <QProgressDialog>
3535
#include <QCursor>
3636

37-
/** DualEdgeTriangulation is an implementation of a triangulation class based on the dual edge data structure*/
37+
/** \ingroup analysis
38+
* DualEdgeTriangulation is an implementation of a triangulation class based on the dual edge data structure*/
3839
class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
3940
{
4041
public:

src/analysis/interpolation/HalfEdge.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
#ifndef HALFEDGE_H
1818
#define HALFEDGE_H
1919

20+
/** \ingroup analysis
21+
* \class HalfEdge
22+
*/
2023
class ANALYSIS_EXPORT HalfEdge
2124
{
2225
protected:

src/analysis/interpolation/LinTriangleInterpolator.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
#include "TriangleInterpolator.h"
2121
#include "DualEdgeTriangulation.h"
2222

23-
/** LinTriangleInterpolator is a class which interpolates linearly on a triangulation*/
23+
/** \ingroup analysis
24+
* LinTriangleInterpolator is a class which interpolates linearly on a triangulation*/
2425
class ANALYSIS_EXPORT LinTriangleInterpolator : public TriangleInterpolator
2526
{
2627
public:

src/analysis/interpolation/Line3D.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
#include "Point3D.h"
2121
#include "Node.h"
2222

23-
/** This class represents a line. It is implemented as a single directed linked list of nodes (with related Point3D objects). Attention: the points inserted in a line are not deleted from Line3D*/
23+
/** \ingroup analysis
24+
* This class represents a line. It is implemented as a single directed linked list of nodes (with related Point3D objects). Attention: the points inserted in a line are not deleted from Line3D*/
2425
class ANALYSIS_EXPORT Line3D
2526
{
2627
private:

src/analysis/interpolation/Node.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919

2020
#include "Point3D.h"
2121

22-
/** Node is a class used by Line3D. It represents a node in the single directed linked list. Associated Point3D objects are deleted when the node is deleted.*/
22+
/** \ingroup analysis
23+
* Node is a class used by Line3D. It represents a node in the single directed linked list. Associated Point3D objects are deleted when the node is deleted.*/
2324
class ANALYSIS_EXPORT Node
2425
{
2526
protected:

src/analysis/interpolation/NormVecDecorator.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323
#include "qgslogger.h"
2424
class QProgressDialog;
2525

26-
/** Decorator class which adds the functionality of estimating normals at the data points*/
26+
/** \ingroup analysis
27+
* Decorator class which adds the functionality of estimating normals at the data points*/
2728
class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator
2829
{
2930
public:

src/analysis/interpolation/ParametricLine.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@
2121
#include "Vector3D.h"
2222
#include <QVector>
2323

24+
/** \ingroup analysis
25+
* ParametricLine is an Interface for parametric lines. It is possible, that a parametric line is composed of several parametric
26+
* lines (see the composite pattern in Gamma et al. 'Design Patterns'). Do not build instances of it since it is an abstract class.*/
2427
class ANALYSIS_EXPORT ParametricLine
25-
/** ParametricLine is an Interface for parametric lines. It is possible, that a parametric line is composed of several parametric lines (see the composite pattern in Gamma et al. 'Design Patterns'). Do not build instances of it since it is an abstract class.*/
2628
{
2729
protected:
2830
/** Degree of the parametric Line*/

0 commit comments

Comments
 (0)