Skip to content

Commit 1367fd0

Browse files
committed
Prepare commit converts single line doxygen block format
Flips single line doxygen comments to use the proper single line format: /*!< comment */ to //!< Comment and /** comment */ to //! Comment
1 parent 3ef8e6a commit 1367fd0

File tree

557 files changed

+4682
-4674
lines changed

Some content is hidden

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

557 files changed

+4682
-4674
lines changed

scripts/unify_includes.pl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@
2828
# Also fix doxygen comments
2929
s#^(\s*)/\*[*!]\s*([^\s*].*)\s*$#$1/** \u$2\n#;
3030

31+
# Convert single line doxygent blocks:
32+
# /*!< comment */ to //!< comment
33+
# /** comment */ to //! comment
34+
s#\/\*[!\*](?!\*)(<*)\h*(.*?)\h*\*\/\h*$#//!$1 $2#;
35+
36+
# Uppercase initial character in //!< comment
37+
s#\/\/!<\s*(.)(.*)#//!< \u$1$2#;
38+
3139
if( /^\s*#include/ ) {
3240
push @inc, $_ unless exists $inc{$_};
3341
$inc{$_}=1;

src/analysis/interpolation/Bezier3D.h

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,38 +27,38 @@ class ANALYSIS_EXPORT Bezier3D: public ParametricLine
2727
protected:
2828

2929
public:
30-
/** Default constructor*/
30+
//! Default constructor
3131
Bezier3D();
32-
/** Constructor, par is a pointer to the parent, controlpoly a controlpolygon*/
32+
//! Constructor, par is a pointer to the parent, controlpoly a controlpolygon
3333
Bezier3D( ParametricLine* par, QVector<Point3D*>* controlpoly );
34-
/** Destructor*/
34+
//! Destructor
3535
virtual ~Bezier3D();
36-
/** Do not use this method, since a Bezier curve does not consist of other curves*/
36+
//! Do not use this method, since a Bezier curve does not consist of other curves
3737
virtual void add( ParametricLine *pl ) override;
38-
/** Calculates the first derivative and assigns it to v*/
38+
//! Calculates the first derivative and assigns it to v
3939
virtual void calcFirstDer( float t, Vector3D* v ) override;
40-
/** Calculates the second derivative and assigns it to v*/
40+
//! Calculates the second derivative and assigns it to v
4141
virtual void calcSecDer( float t, Vector3D* v ) override;
4242
//virtual Point3D calcPoint(float t);
43-
/** Calculates the point on the curve and assigns it to p*/
43+
//! Calculates the point on the curve and assigns it to p
4444
virtual void calcPoint( float t, Point3D* p ) override;
45-
/** Changes the order of control points*/
45+
//! Changes the order of control points
4646
virtual void changeDirection() override;
4747
//virtual void draw(QPainter* p);
4848
//virtual bool intersects(ParametricLine* pal);
49-
/** Do not use this method, since a Bezier curve does not consist of other curves*/
49+
//! Do not use this method, since a Bezier curve does not consist of other curves
5050
virtual void remove( int i ) override;
51-
/** Returns a control point*/
51+
//! Returns a control point
5252
virtual const Point3D* getControlPoint( int number ) const override;
53-
/** Returns a pointer to the control polygon*/
53+
//! Returns a pointer to the control polygon
5454
virtual const QVector<Point3D*>* getControlPoly() const override;
55-
/** Returns the degree of the curve*/
55+
//! Returns the degree of the curve
5656
virtual int getDegree() const override;
57-
/** Returns the parent*/
57+
//! Returns the parent
5858
virtual ParametricLine* getParent() const override;
59-
/** Sets the parent*/
59+
//! Sets the parent
6060
virtual void setParent( ParametricLine* par ) override;
61-
/** Sets the control polygon*/
61+
//! Sets the control polygon
6262
virtual void setControlPoly( QVector<Point3D*>* cp ) override;
6363

6464
};

src/analysis/interpolation/CloughTocherInterpolator.h

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ class NormVecDecorator;
2727
class ANALYSIS_EXPORT CloughTocherInterpolator : public TriangleInterpolator
2828
{
2929
protected:
30-
/** Association with a triangulation object*/
30+
//! Association with a triangulation object
3131
NormVecDecorator* mTIN;
32-
/** Tolerance of the barycentric coordinates at the borders of the triangles (to prevent errors because of very small negativ baricentric coordinates)*/
32+
//! Tolerance of the barycentric coordinates at the borders of the triangles (to prevent errors because of very small negativ baricentric coordinates)
3333
double mEdgeTolerance;
34-
/** First point of the triangle in x-,y-,z-coordinates*/
34+
//! First point of the triangle in x-,y-,z-coordinates
3535
Point3D point1;
36-
/** Second point of the triangle in x-,y-,z-coordinates*/
36+
//! Second point of the triangle in x-,y-,z-coordinates
3737
Point3D point2;
38-
/** Third point of the triangle in x-,y-,z-coordinates*/
38+
//! Third point of the triangle in x-,y-,z-coordinates
3939
Point3D point3;
4040
Point3D cp1;
4141
Point3D cp2;
@@ -53,39 +53,39 @@ class ANALYSIS_EXPORT CloughTocherInterpolator : public TriangleInterpolator
5353
Point3D cp14;
5454
Point3D cp15;
5555
Point3D cp16;
56-
/** Derivative in x-direction at point1*/
56+
//! Derivative in x-direction at point1
5757
double der1X;
58-
/** Derivative in y-direction at point1*/
58+
//! Derivative in y-direction at point1
5959
double der1Y;
60-
/** Derivative in x-direction at point2*/
60+
//! Derivative in x-direction at point2
6161
double der2X;
62-
/** Derivative in y-direction at point2*/
62+
//! Derivative in y-direction at point2
6363
double der2Y;
64-
/** Derivative in x-direction at point3*/
64+
//! Derivative in x-direction at point3
6565
double der3X;
66-
/** Derivative in y-direction at point3*/
66+
//! Derivative in y-direction at point3
6767
double der3Y;
68-
/** Stores point1 of the last run*/
68+
//! Stores point1 of the last run
6969
Point3D lpoint1;
70-
/** Stores point2 of the last run*/
70+
//! Stores point2 of the last run
7171
Point3D lpoint2;
72-
/** Stores point3 of the last run*/
72+
//! Stores point3 of the last run
7373
Point3D lpoint3;
74-
/** Finds out, in which triangle the point with the coordinates x and y is*/
74+
//! Finds out, in which triangle the point with the coordinates x and y is
7575
void init( double x, double y );
76-
/** Calculates the Bernsteinpolynomials to calculate the Beziertriangle. 'n' is three in the cubical case, 'i', 'j', 'k' are the indices of the controllpoint and 'u', 'v', 'w' are the barycentric coordinates of the point*/
76+
//! Calculates the Bernsteinpolynomials to calculate the Beziertriangle. 'n' is three in the cubical case, 'i', 'j', 'k' are the indices of the controllpoint and 'u', 'v', 'w' are the barycentric coordinates of the point
7777
double calcBernsteinPoly( int n, int i, int j, int k, double u, double v, double w );
7878

7979
public:
80-
/** Standard constructor*/
80+
//! Standard constructor
8181
CloughTocherInterpolator();
82-
/** Constructor with a pointer to the triangulation as argument*/
82+
//! Constructor with a pointer to the triangulation as argument
8383
CloughTocherInterpolator( NormVecDecorator* tin );
84-
/** Destructor*/
84+
//! Destructor
8585
virtual ~CloughTocherInterpolator();
86-
/** Calculates the normal vector and assigns it to vec (not implemented at the moment)*/
86+
//! Calculates the normal vector and assigns it to vec (not implemented at the moment)
8787
virtual bool calcNormVec( double x, double y, Vector3D* result ) override;
88-
/** Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point*/
88+
//! Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point
8989
virtual bool calcPoint( double x, double y, Point3D* result ) override;
9090
virtual void setTriangulation( NormVecDecorator* tin );
9191
};

0 commit comments

Comments
 (0)