diff --git a/scripts/unify_includes.pl b/scripts/unify_includes.pl index c1509aadb19..cc220b865ec 100755 --- a/scripts/unify_includes.pl +++ b/scripts/unify_includes.pl @@ -28,6 +28,14 @@ END { die "header files not empty" if @inc; } # Also fix doxygen comments s#^(\s*)/\*[*!]\s*([^\s*].*)\s*$#$1/** \u$2\n#; +# Convert single line doxygent blocks: +# /*!< comment */ to //!< comment +# /** comment */ to //! comment +s#\/\*[!\*](?!\*)(<*)\h*(.*?)\h*\*\/\h*$#//!$1 $2#; + +# Uppercase initial character in //!< comment +s#\/\/!<\s*(.)(.*)#//!< \u$1$2#; + if( /^\s*#include/ ) { push @inc, $_ unless exists $inc{$_}; $inc{$_}=1; diff --git a/src/analysis/interpolation/Bezier3D.h b/src/analysis/interpolation/Bezier3D.h index d9a4796ace7..bc471924f61 100644 --- a/src/analysis/interpolation/Bezier3D.h +++ b/src/analysis/interpolation/Bezier3D.h @@ -27,38 +27,38 @@ class ANALYSIS_EXPORT Bezier3D: public ParametricLine protected: public: - /** Default constructor*/ + //! Default constructor Bezier3D(); - /** Constructor, par is a pointer to the parent, controlpoly a controlpolygon*/ + //! Constructor, par is a pointer to the parent, controlpoly a controlpolygon Bezier3D( ParametricLine* par, QVector* controlpoly ); - /** Destructor*/ + //! Destructor virtual ~Bezier3D(); - /** Do not use this method, since a Bezier curve does not consist of other curves*/ + //! Do not use this method, since a Bezier curve does not consist of other curves virtual void add( ParametricLine *pl ) override; - /** Calculates the first derivative and assigns it to v*/ + //! Calculates the first derivative and assigns it to v virtual void calcFirstDer( float t, Vector3D* v ) override; - /** Calculates the second derivative and assigns it to v*/ + //! Calculates the second derivative and assigns it to v virtual void calcSecDer( float t, Vector3D* v ) override; //virtual Point3D calcPoint(float t); - /** Calculates the point on the curve and assigns it to p*/ + //! Calculates the point on the curve and assigns it to p virtual void calcPoint( float t, Point3D* p ) override; - /** Changes the order of control points*/ + //! Changes the order of control points virtual void changeDirection() override; //virtual void draw(QPainter* p); //virtual bool intersects(ParametricLine* pal); - /** Do not use this method, since a Bezier curve does not consist of other curves*/ + //! Do not use this method, since a Bezier curve does not consist of other curves virtual void remove( int i ) override; - /** Returns a control point*/ + //! Returns a control point virtual const Point3D* getControlPoint( int number ) const override; - /** Returns a pointer to the control polygon*/ + //! Returns a pointer to the control polygon virtual const QVector* getControlPoly() const override; - /** Returns the degree of the curve*/ + //! Returns the degree of the curve virtual int getDegree() const override; - /** Returns the parent*/ + //! Returns the parent virtual ParametricLine* getParent() const override; - /** Sets the parent*/ + //! Sets the parent virtual void setParent( ParametricLine* par ) override; - /** Sets the control polygon*/ + //! Sets the control polygon virtual void setControlPoly( QVector* cp ) override; }; diff --git a/src/analysis/interpolation/CloughTocherInterpolator.h b/src/analysis/interpolation/CloughTocherInterpolator.h index b6884ee99fe..7458c962c3e 100644 --- a/src/analysis/interpolation/CloughTocherInterpolator.h +++ b/src/analysis/interpolation/CloughTocherInterpolator.h @@ -27,15 +27,15 @@ class NormVecDecorator; class ANALYSIS_EXPORT CloughTocherInterpolator : public TriangleInterpolator { protected: - /** Association with a triangulation object*/ + //! Association with a triangulation object NormVecDecorator* mTIN; - /** Tolerance of the barycentric coordinates at the borders of the triangles (to prevent errors because of very small negativ baricentric coordinates)*/ + //! Tolerance of the barycentric coordinates at the borders of the triangles (to prevent errors because of very small negativ baricentric coordinates) double mEdgeTolerance; - /** First point of the triangle in x-,y-,z-coordinates*/ + //! First point of the triangle in x-,y-,z-coordinates Point3D point1; - /** Second point of the triangle in x-,y-,z-coordinates*/ + //! Second point of the triangle in x-,y-,z-coordinates Point3D point2; - /** Third point of the triangle in x-,y-,z-coordinates*/ + //! Third point of the triangle in x-,y-,z-coordinates Point3D point3; Point3D cp1; Point3D cp2; @@ -53,39 +53,39 @@ class ANALYSIS_EXPORT CloughTocherInterpolator : public TriangleInterpolator Point3D cp14; Point3D cp15; Point3D cp16; - /** Derivative in x-direction at point1*/ + //! Derivative in x-direction at point1 double der1X; - /** Derivative in y-direction at point1*/ + //! Derivative in y-direction at point1 double der1Y; - /** Derivative in x-direction at point2*/ + //! Derivative in x-direction at point2 double der2X; - /** Derivative in y-direction at point2*/ + //! Derivative in y-direction at point2 double der2Y; - /** Derivative in x-direction at point3*/ + //! Derivative in x-direction at point3 double der3X; - /** Derivative in y-direction at point3*/ + //! Derivative in y-direction at point3 double der3Y; - /** Stores point1 of the last run*/ + //! Stores point1 of the last run Point3D lpoint1; - /** Stores point2 of the last run*/ + //! Stores point2 of the last run Point3D lpoint2; - /** Stores point3 of the last run*/ + //! Stores point3 of the last run Point3D lpoint3; - /** Finds out, in which triangle the point with the coordinates x and y is*/ + //! Finds out, in which triangle the point with the coordinates x and y is void init( double x, double y ); - /** 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*/ + //! 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 double calcBernsteinPoly( int n, int i, int j, int k, double u, double v, double w ); public: - /** Standard constructor*/ + //! Standard constructor CloughTocherInterpolator(); - /** Constructor with a pointer to the triangulation as argument*/ + //! Constructor with a pointer to the triangulation as argument CloughTocherInterpolator( NormVecDecorator* tin ); - /** Destructor*/ + //! Destructor virtual ~CloughTocherInterpolator(); - /** Calculates the normal vector and assigns it to vec (not implemented at the moment)*/ + //! Calculates the normal vector and assigns it to vec (not implemented at the moment) virtual bool calcNormVec( double x, double y, Vector3D* result ) override; - /** Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point*/ + //! Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point virtual bool calcPoint( double x, double y, Point3D* result ) override; virtual void setTriangulation( NormVecDecorator* tin ); }; diff --git a/src/analysis/interpolation/DualEdgeTriangulation.h b/src/analysis/interpolation/DualEdgeTriangulation.h index c485726b34d..6c9e6cfda43 100644 --- a/src/analysis/interpolation/DualEdgeTriangulation.h +++ b/src/analysis/interpolation/DualEdgeTriangulation.h @@ -41,137 +41,137 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation DualEdgeTriangulation( int nop, Triangulation* decorator ); virtual ~DualEdgeTriangulation(); void setDecorator( Triangulation* d ) {mDecorator = d;} - /** Adds a line (e.g. a break-, structure- or an isoline) to the triangulation. The class takes ownership of the line object and its points*/ + //! Adds a line (e.g. a break-, structure- or an isoline) to the triangulation. The class takes ownership of the line object and its points void addLine( Line3D* line, bool breakline ) override; - /** Adds a point to the triangulation and returns the number of this point in case of success or -100 in case of failure*/ + //! Adds a point to the triangulation and returns the number of this point in case of success or -100 in case of failure int addPoint( Point3D* p ) override; - /** Performs a consistency check, remove this later*/ + //! Performs a consistency check, remove this later virtual void performConsistencyTest() override; - /** Calculates the normal at a point on the surface*/ + //! Calculates the normal at a point on the surface virtual bool calcNormal( double x, double y, Vector3D* result ) override; - /** Calculates x-, y and z-value of the point on the surface*/ + //! Calculates x-, y and z-value of the point on the surface virtual bool calcPoint( double x, double y, Point3D* result ) override; - /** Draws the points, edges and the forced lines*/ + //! Draws the points, edges and the forced lines //virtual void draw(QPainter* p, double xlowleft, double ylowleft, double xupright, double yupright, double width, double height) const; - /** Returns a pointer to the point with number i*/ + //! Returns a pointer to the point with number i virtual Point3D* getPoint( unsigned int i ) const override; - /** Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge)*/ + //! Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge) int getOppositePoint( int p1, int p2 ) override; - /** Finds out, in which triangle the point with coordinates x and y is and assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3'*/ + //! Finds out, in which triangle the point with coordinates x and y is and assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3' //! @note not available in python bindings virtual bool getTriangle( double x, double y, Point3D* p1, int* n1, Point3D* p2, int* n2, Point3D* p3, int* n3 ) override; - /** Finds out, in which triangle the point with coordinates x and y is and assigns addresses to the points at the vertices to 'p1', 'p2' and 'p3*/ + //! Finds out, in which triangle the point with coordinates x and y is and assigns addresses to the points at the vertices to 'p1', 'p2' and 'p3 virtual bool getTriangle( double x, double y, Point3D* p1, Point3D* p2, Point3D* p3 ) override; - /** Returns a pointer to a value list with the information of the triangles surrounding (counterclockwise) a point. Four integer values describe a triangle, the first three are the number of the half edges of the triangle and the fourth is -10, if the third (and most counterclockwise) edge is a breakline, and -20 otherwise. The value list has to be deleted by the code which called the method*/ + //! Returns a pointer to a value list with the information of the triangles surrounding (counterclockwise) a point. Four integer values describe a triangle, the first three are the number of the half edges of the triangle and the fourth is -10, if the third (and most counterclockwise) edge is a breakline, and -20 otherwise. The value list has to be deleted by the code which called the method QList* getSurroundingTriangles( int pointno ) override; - /** Returns the largest x-coordinate value of the bounding box*/ + //! Returns the largest x-coordinate value of the bounding box virtual double getXMax() const override { return xMax; } - /** Returns the smallest x-coordinate value of the bounding box*/ + //! Returns the smallest x-coordinate value of the bounding box virtual double getXMin() const override { return xMin; } - /** Returns the largest y-coordinate value of the bounding box*/ + //! Returns the largest y-coordinate value of the bounding box virtual double getYMax() const override { return yMax; } - /** Returns the smallest x-coordinate value of the bounding box*/ + //! Returns the smallest x-coordinate value of the bounding box virtual double getYMin() const override { return yMin; } - /** Returns the number of points*/ + //! Returns the number of points virtual int getNumberOfPoints() const override; - /** Sets the behaviour of the triangulation in case of crossing forced lines*/ + //! Sets the behaviour of the triangulation in case of crossing forced lines virtual void setForcedCrossBehaviour( Triangulation::forcedCrossBehaviour b ) override; - /** Sets the color of the normal edges*/ + //! Sets the color of the normal edges virtual void setEdgeColor( int r, int g, int b ) override; - /** Sets the color of the forced edges*/ + //! Sets the color of the forced edges virtual void setForcedEdgeColor( int r, int g, int b ) override; - /** Sets the color of the breaklines*/ + //! Sets the color of the breaklines virtual void setBreakEdgeColor( int r, int g, int b ) override; - /** Sets an interpolator object*/ + //! Sets an interpolator object void setTriangleInterpolator( TriangleInterpolator* interpolator ) override; - /** Eliminates the horizontal triangles by swapping or by insertion of new points*/ + //! Eliminates the horizontal triangles by swapping or by insertion of new points void eliminateHorizontalTriangles() override; - /** Adds points to make the triangles better shaped (algorithm of ruppert)*/ + //! Adds points to make the triangles better shaped (algorithm of ruppert) virtual void ruppertRefinement() override; - /** Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise*/ + //! Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise bool pointInside( double x, double y ) override; - /** Reads the dual edge structure of a taff file*/ + //! Reads the dual edge structure of a taff file //bool readFromTAFF(QString fileName); - /** Saves the dual edge structure to a taff file*/ + //! Saves the dual edge structure to a taff file //bool saveToTAFF(QString fileName) const; - /** Swaps the edge which is closest to the point with x and y coordinates (if this is possible)*/ + //! Swaps the edge which is closest to the point with x and y coordinates (if this is possible) virtual bool swapEdge( double x, double y ) override; - /** Returns a value list with the numbers of the four points, which would be affected by an edge swap. This function is e.g. needed by NormVecDecorator to know the points, for which the normals have to be recalculated. The returned ValueList has to be deleted by the code which calls the method*/ + //! Returns a value list with the numbers of the four points, which would be affected by an edge swap. This function is e.g. needed by NormVecDecorator to know the points, for which the normals have to be recalculated. The returned ValueList has to be deleted by the code which calls the method virtual QList* getPointsAroundEdge( double x, double y ) override; /** Saves the triangulation as a (line) shapefile @return true in case of success*/ virtual bool saveAsShapefile( const QString& fileName ) const override; protected: - /** X-coordinate of the upper right corner of the bounding box*/ + //! X-coordinate of the upper right corner of the bounding box double xMax; - /** X-coordinate of the lower left corner of the bounding box*/ + //! X-coordinate of the lower left corner of the bounding box double xMin; - /** Y-coordinate of the upper right corner of the bounding box*/ + //! Y-coordinate of the upper right corner of the bounding box double yMax; - /** Y-coordinate of the lower left corner of the bounding box*/ + //! Y-coordinate of the lower left corner of the bounding box double yMin; - /** Default value for the number of storable points at the beginning*/ + //! Default value for the number of storable points at the beginning const static unsigned int mDefaultStorageForPoints = 100000; - /** Stores pointers to all points in the triangulations (including the points contained in the lines)*/ + //! Stores pointers to all points in the triangulations (including the points contained in the lines) QVector mPointVector; - /** Default value for the number of storable HalfEdges at the beginning*/ + //! Default value for the number of storable HalfEdges at the beginning const static unsigned int mDefaultStorageForHalfEdges = 300006; - /** Stores pointers to the HalfEdges*/ + //! Stores pointers to the HalfEdges QVector mHalfEdge; - /** Association to an interpolator object*/ + //! Association to an interpolator object TriangleInterpolator* mTriangleInterpolator; - /** Member to store the behaviour in case of crossing forced segments*/ + //! Member to store the behaviour in case of crossing forced segments Triangulation::forcedCrossBehaviour mForcedCrossBehaviour; - /** Color to paint the normal edges*/ + //! Color to paint the normal edges QColor mEdgeColor; - /** Color to paint the forced edges*/ + //! Color to paint the forced edges QColor mForcedEdgeColor; - /** Color to paint the breaklines*/ + //! Color to paint the breaklines QColor mBreakEdgeColor; - /** Pointer to the decorator using this triangulation. It it is used directly, mDecorator equals this*/ + //! Pointer to the decorator using this triangulation. It it is used directly, mDecorator equals this Triangulation* mDecorator; - /** Inserts an edge and makes sure, everything is ok with the storage of the edge. The number of the HalfEdge is returned*/ + //! Inserts an edge and makes sure, everything is ok with the storage of the edge. The number of the HalfEdge is returned unsigned int insertEdge( int dual, int next, int point, bool mbreak, bool forced ); - /** Inserts a forced segment between the points with the numbers p1 and p2 into the triangulation and returns the number of a HalfEdge belonging to this forced edge or -100 in case of failure*/ + //! Inserts a forced segment between the points with the numbers p1 and p2 into the triangulation and returns the number of a HalfEdge belonging to this forced edge or -100 in case of failure int insertForcedSegment( int p1, int p2, bool breakline ); - /** Threshold for the leftOfTest to handle numerical instabilities*/ + //! Threshold for the leftOfTest to handle numerical instabilities //const static double leftOfTresh=0.00001; - /** Security to prevent endless loops in 'baseEdgeOfTriangle'. It there are more iteration then this number, the point will not be inserted*/ + //! Security to prevent endless loops in 'baseEdgeOfTriangle'. It there are more iteration then this number, the point will not be inserted const static int nBaseOfRuns = 300000; - /** Returns the number of an edge which points to the point with number 'point' or -1 if there is an error*/ + //! Returns the number of an edge which points to the point with number 'point' or -1 if there is an error int baseEdgeOfPoint( int point ); - /** Returns the number of a HalfEdge from a triangle in which 'point' is in. If the number -10 is returned, this means, that 'point' is outside the convex hull. If -5 is returned, then numerical problems with the leftOfTest occurred (and the value of the possible edge is stored in the variable 'mUnstableEdge'. -20 means, that the inserted point is exactly on an edge (the number is stored in the variable 'mEdgeWithPoint'). -25 means, that the point is already in the triangulation (the number of the point is stored in the member 'mTwiceInsPoint'. If -100 is returned, this means that something else went wrong*/ + //! Returns the number of a HalfEdge from a triangle in which 'point' is in. If the number -10 is returned, this means, that 'point' is outside the convex hull. If -5 is returned, then numerical problems with the leftOfTest occurred (and the value of the possible edge is stored in the variable 'mUnstableEdge'. -20 means, that the inserted point is exactly on an edge (the number is stored in the variable 'mEdgeWithPoint'). -25 means, that the point is already in the triangulation (the number of the point is stored in the member 'mTwiceInsPoint'. If -100 is returned, this means that something else went wrong int baseEdgeOfTriangle( Point3D* point ); - /** Checks, if 'edge' has to be swapped because of the empty circle criterion. If so, doSwap(...) is called.*/ + //! Checks, if 'edge' has to be swapped because of the empty circle criterion. If so, doSwap(...) is called. bool checkSwap( unsigned int edge, unsigned int recursiveDeep ); - /** Swaps 'edge' and test recursively for other swaps (delaunay criterion)*/ + //! Swaps 'edge' and test recursively for other swaps (delaunay criterion) void doSwap( unsigned int edge, unsigned int recursiveDeep ); - /** Swaps 'edge' and does no recursiv testing*/ + //! Swaps 'edge' and does no recursiv testing void doOnlySwap( unsigned int edge ); - /** Number of an edge which does not point to the virtual point. It continuously updated for a fast search*/ + //! Number of an edge which does not point to the virtual point. It continuously updated for a fast search unsigned int mEdgeInside; - /** Number of an edge on the outside of the convex hull. It is updated in method 'baseEdgeOfTriangle' to enable insertion of points outside the convex hull*/ + //! Number of an edge on the outside of the convex hull. It is updated in method 'baseEdgeOfTriangle' to enable insertion of points outside the convex hull unsigned int mEdgeOutside; - /** If an inserted point is exactly on an existing edge, 'baseEdgeOfTriangle' returns -20 and sets the variable 'mEdgeWithPoint'*/ + //! If an inserted point is exactly on an existing edge, 'baseEdgeOfTriangle' returns -20 and sets the variable 'mEdgeWithPoint' unsigned int mEdgeWithPoint; - /** If an instability occurs in 'baseEdgeOfTriangle', mUnstableEdge is set to the value of the current edge*/ + //! If an instability occurs in 'baseEdgeOfTriangle', mUnstableEdge is set to the value of the current edge unsigned int mUnstableEdge; - /** If a point has been inserted twice, its number is stored in this member*/ + //! If a point has been inserted twice, its number is stored in this member int mTwiceInsPoint; - /** Returns true, if it is possible to swap an edge, otherwise false(concave quad or edge on (or outside) the convex hull)*/ + //! Returns true, if it is possible to swap an edge, otherwise false(concave quad or edge on (or outside) the convex hull) bool swapPossible( unsigned int edge ); - /** Divides a polygon in a triangle and two polygons and calls itself recursively for these two polygons. 'poly' is a pointer to a list with the numbers of the edges of the polygon, 'free' is a pointer to a list of free halfedges, and 'mainedge' is the number of the edge, towards which the new triangle is inserted. Mainedge has to be the same as poly->begin(), otherwise the recursion does not work*/ + //! Divides a polygon in a triangle and two polygons and calls itself recursively for these two polygons. 'poly' is a pointer to a list with the numbers of the edges of the polygon, 'free' is a pointer to a list of free halfedges, and 'mainedge' is the number of the edge, towards which the new triangle is inserted. Mainedge has to be the same as poly->begin(), otherwise the recursion does not work void triangulatePolygon( QList* poly, QList* free, int mainedge ); - /** Tests, if the bounding box of the halfedge with index i intersects the specified bounding box. The main purpose for this method is the drawing of the triangulation*/ + //! Tests, if the bounding box of the halfedge with index i intersects the specified bounding box. The main purpose for this method is the drawing of the triangulation bool halfEdgeBBoxTest( int edge, double xlowleft, double ylowleft, double xupright, double yupright ) const; - /** Calculates the minimum angle, which would be present, if the specified halfedge would be swapped*/ + //! Calculates the minimum angle, which would be present, if the specified halfedge would be swapped double swapMinAngle( int edge ) const; - /** Inserts a new point on the halfedge with number 'edge'. The position can have a value from 0 to 1 (e.g. 0.5 would be in the middle). The return value is the number of the new inserted point. tin is the triangulation, which should be used to calculate the elevation of the inserted point*/ + //! Inserts a new point on the halfedge with number 'edge'. The position can have a value from 0 to 1 (e.g. 0.5 would be in the middle). The return value is the number of the new inserted point. tin is the triangulation, which should be used to calculate the elevation of the inserted point int splitHalfEdge( int edge, float position ); - /** Returns true, if a half edge is on the convex hull and false otherwise*/ + //! Returns true, if a half edge is on the convex hull and false otherwise bool edgeOnConvexHull( int edge ); - /** Function needed for the ruppert algorithm. Tests, if point is in the circle through both endpoints of edge and the endpoint of edge->dual->next->point. If so, the function calls itself recursively for edge->next and edge->next->next. Stops, if it finds a forced edge or a convex hull edge*/ + //! Function needed for the ruppert algorithm. Tests, if point is in the circle through both endpoints of edge and the endpoint of edge->dual->next->point. If so, the function calls itself recursively for edge->next and edge->next->next. Stops, if it finds a forced edge or a convex hull edge void evaluateInfluenceRegion( Point3D* point, int edge, QSet &set ); }; diff --git a/src/analysis/interpolation/HalfEdge.h b/src/analysis/interpolation/HalfEdge.h index 1d4f10967f4..17d26874778 100644 --- a/src/analysis/interpolation/HalfEdge.h +++ b/src/analysis/interpolation/HalfEdge.h @@ -23,41 +23,41 @@ class ANALYSIS_EXPORT HalfEdge { protected: - /** Number of the dual HalfEdge*/ + //! Number of the dual HalfEdge int mDual; - /** Number of the next HalfEdge*/ + //! Number of the next HalfEdge int mNext; - /** Number of the point at which this HalfEdge points*/ + //! Number of the point at which this HalfEdge points int mPoint; - /** True, if the HalfEdge belongs to a break line, false otherwise*/ + //! True, if the HalfEdge belongs to a break line, false otherwise bool mBreak; - /** True, if the HalfEdge belongs to a constrained edge, false otherwise*/ + //! True, if the HalfEdge belongs to a constrained edge, false otherwise bool mForced; public: - /** Default constructor. Values for mDual, mNext, mPoint are set to -10 which means that they are undefined*/ + //! Default constructor. Values for mDual, mNext, mPoint are set to -10 which means that they are undefined HalfEdge(); HalfEdge( int dual, int next, int point, bool mbreak, bool forced ); ~HalfEdge(); - /** Returns the number of the dual HalfEdge*/ + //! Returns the number of the dual HalfEdge int getDual() const; - /** Returns the number of the next HalfEdge*/ + //! Returns the number of the next HalfEdge int getNext() const; - /** Returns the number of the point at which this HalfEdge points*/ + //! Returns the number of the point at which this HalfEdge points int getPoint() const; - /** Returns, whether the HalfEdge belongs to a break line or not*/ + //! Returns, whether the HalfEdge belongs to a break line or not bool getBreak() const; - /** Returns, whether the HalfEdge belongs to a constrained edge or not*/ + //! Returns, whether the HalfEdge belongs to a constrained edge or not bool getForced() const; - /** Sets the number of the dual HalfEdge*/ + //! Sets the number of the dual HalfEdge void setDual( int d ); - /** Sets the number of the next HalfEdge*/ + //! Sets the number of the next HalfEdge void setNext( int n ); - /** Sets the number of point at which this HalfEdge points*/ + //! Sets the number of point at which this HalfEdge points void setPoint( int p ); - /** Sets the break flag*/ + //! Sets the break flag void setBreak( bool b ); - /** Sets the forced flag*/ + //! Sets the forced flag void setForced( bool f ); }; diff --git a/src/analysis/interpolation/LinTriangleInterpolator.h b/src/analysis/interpolation/LinTriangleInterpolator.h index 3aededa2f5e..75de7762533 100644 --- a/src/analysis/interpolation/LinTriangleInterpolator.h +++ b/src/analysis/interpolation/LinTriangleInterpolator.h @@ -25,27 +25,27 @@ class ANALYSIS_EXPORT LinTriangleInterpolator : public TriangleInterpolator { public: - /** Default constructor*/ + //! Default constructor LinTriangleInterpolator(); - /** Constructor with reference to a DualEdgeTriangulation object*/ + //! Constructor with reference to a DualEdgeTriangulation object LinTriangleInterpolator( DualEdgeTriangulation* tin ); - /** Destructor*/ + //! Destructor virtual ~LinTriangleInterpolator(); - /** Calculates the normal vector and assigns it to vec*/ + //! Calculates the normal vector and assigns it to vec virtual bool calcNormVec( double x, double y, Vector3D* result ) override; - /** Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point*/ + //! Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point virtual bool calcPoint( double x, double y, Point3D* result ) override; - /** Returns a pointer to the current Triangulation object*/ + //! Returns a pointer to the current Triangulation object virtual DualEdgeTriangulation* getTriangulation() const; - /** Sets a Triangulation*/ + //! Sets a Triangulation virtual void setTriangulation( DualEdgeTriangulation* tin ); protected: DualEdgeTriangulation* mTIN; - /** Calculates the first derivative with respect to x for a linear surface and assigns it to vec*/ + //! Calculates the first derivative with respect to x for a linear surface and assigns it to vec virtual bool calcFirstDerX( double x, double y, Vector3D* result ); - /** Calculates the first derivative with respect to y for a linear surface and assigns it to vec*/ + //! Calculates the first derivative with respect to y for a linear surface and assigns it to vec virtual bool calcFirstDerY( double x, double y, Vector3D* result ); }; diff --git a/src/analysis/interpolation/Line3D.h b/src/analysis/interpolation/Line3D.h index 51f496235d8..f0635f86c38 100644 --- a/src/analysis/interpolation/Line3D.h +++ b/src/analysis/interpolation/Line3D.h @@ -24,9 +24,9 @@ class ANALYSIS_EXPORT Line3D { private: - /** Copy constructor, declared private to not use it*/ + //! Copy constructor, declared private to not use it Line3D( const Line3D& ); - /** Assignment operator, declared private to not use it*/ + //! Assignment operator, declared private to not use it Line3D& operator=( const Line3D& ); protected: Node* head; @@ -38,21 +38,21 @@ class ANALYSIS_EXPORT Line3D public: Line3D(); ~Line3D(); - /** Returns true, if the Line contains no Point3D, otherwise false*/ + //! Returns true, if the Line contains no Point3D, otherwise false bool empty() const; - /** Inserts a node behind the current position and sets the current position to this new node*/ + //! Inserts a node behind the current position and sets the current position to this new node void insertPoint( Point3D* p ); - /** Removes the point behind the current position*/ + //! Removes the point behind the current position void removePoint(); - /** Gets the point at the current position*/ + //! Gets the point at the current position Point3D* getPoint() const; - /** Returns the current position*/ + //! Returns the current position unsigned int getCurrent() const; - /** Returns the size of the line (the numbero of inserted Nodes without 'head' and 'z'*/ + //! Returns the size of the line (the numbero of inserted Nodes without 'head' and 'z' unsigned int getSize() const; - /** Sets the current Node to head*/ + //! Sets the current Node to head void goToBegin(); - /** Goes to the next Node*/ + //! Goes to the next Node void goToNext(); }; diff --git a/src/analysis/interpolation/MathUtils.h b/src/analysis/interpolation/MathUtils.h index e1936b8d802..8cab13a703a 100644 --- a/src/analysis/interpolation/MathUtils.h +++ b/src/analysis/interpolation/MathUtils.h @@ -24,60 +24,60 @@ class Vector3D; namespace MathUtils { - /** Calculates the barycentric coordinates of a point (x,y) with respect to p1, p2, p3 and stores the three barycentric coordinates in 'result'. Thus the u-coordinate is stored in result::x, the v-coordinate in result::y and the w-coordinate in result::z. Attention: p1, p2 and p3 have to be ordered counterclockwise*/ + //! Calculates the barycentric coordinates of a point (x,y) with respect to p1, p2, p3 and stores the three barycentric coordinates in 'result'. Thus the u-coordinate is stored in result::x, the v-coordinate in result::y and the w-coordinate in result::z. Attention: p1, p2 and p3 have to be ordered counterclockwise bool ANALYSIS_EXPORT calcBarycentricCoordinates( double x, double y, Point3D* p1, Point3D* p2, Point3D* p3, Point3D* result ); bool ANALYSIS_EXPORT BarycentricToXY( double u, double v, double w, Point3D* p1, Point3D* p2, Point3D* p3, Point3D* result ); - /** Calculates the value of a Bernstein polynomial*/ + //! Calculates the value of a Bernstein polynomial double ANALYSIS_EXPORT calcBernsteinPoly( int n, int i, double t ); - /** Calculates the first derivative of a Bernstein polynomial with respect to the parameter t*/ + //! Calculates the first derivative of a Bernstein polynomial with respect to the parameter t double ANALYSIS_EXPORT cFDerBernsteinPoly( int n, int i, double t ); - /** Calculates the value of a cubic Hermite polynomial*/ + //! Calculates the value of a cubic Hermite polynomial double ANALYSIS_EXPORT calcCubicHermitePoly( int n, int i, double t ); - /** Calculates the first derivative of a cubic Hermite polynomial with respect to the parameter t*/ + //! Calculates the first derivative of a cubic Hermite polynomial with respect to the parameter t double ANALYSIS_EXPORT cFDerCubicHermitePoly( int n, int i, double t ); - /** Calculates the center of the circle passing through p1, p2 and p3. Returns true in case of success and false otherwise (e.g. all three points on a line)*/ + //! Calculates the center of the circle passing through p1, p2 and p3. Returns true in case of success and false otherwise (e.g. all three points on a line) bool ANALYSIS_EXPORT circumcenter( Point3D* p1, Point3D* p2, Point3D* p3, Point3D* result ); - /** Calculates the (2 dimensional) distance from 'thepoint' to the line defined by p1 and p2*/ + //! Calculates the (2 dimensional) distance from 'thepoint' to the line defined by p1 and p2 double ANALYSIS_EXPORT distPointFromLine( Point3D* thepoint, Point3D* p1, Point3D* p2 ); - /** Faculty function*/ + //! Faculty function int ANALYSIS_EXPORT faculty( int n ); - /** Tests, whether 'testp' is inside the circle through 'p1', 'p2' and 'p3'*/ + //! Tests, whether 'testp' is inside the circle through 'p1', 'p2' and 'p3' bool ANALYSIS_EXPORT inCircle( Point3D* testp, Point3D* p1, Point3D* p2, Point3D* p3 ); - /** Tests, whether 'point' is inside the diametral circle through 'p1' and 'p2'*/ + //! Tests, whether 'point' is inside the diametral circle through 'p1' and 'p2' bool ANALYSIS_EXPORT inDiametral( Point3D* p1, Point3D* p2, Point3D* point ); - /** Returns whether 'thepoint' is left or right of the line from 'p1' to 'p2'. Negativ values mean left and positiv values right. There may be numerical instabilities, so a threshold may be useful*/ + //! Returns whether 'thepoint' is left or right of the line from 'p1' to 'p2'. Negativ values mean left and positiv values right. There may be numerical instabilities, so a threshold may be useful double ANALYSIS_EXPORT leftOf( Point3D* thepoint, Point3D* p1, Point3D* p2 ); - /** Returns true, if line1 (p1 to p2) and line2 (p3 to p4) intersect. If the lines have an endpoint in common, false is returned*/ + //! Returns true, if line1 (p1 to p2) and line2 (p3 to p4) intersect. If the lines have an endpoint in common, false is returned bool ANALYSIS_EXPORT lineIntersection( Point3D* p1, Point3D* p2, Point3D* p3, Point3D* p4 ); - /** Returns true, if line1 (p1 to p2) and line2 (p3 to p4) intersect. If the lines have an endpoint in common, false is returned. The intersecting point is stored in 'intersection_point.*/ + //! Returns true, if line1 (p1 to p2) and line2 (p3 to p4) intersect. If the lines have an endpoint in common, false is returned. The intersecting point is stored in 'intersection_point. bool ANALYSIS_EXPORT lineIntersection( Point3D* p1, Point3D* p2, Point3D* p3, Point3D* p4, Point3D* intersection_point ); - /** Lower function*/ + //! Lower function int ANALYSIS_EXPORT lower( int n, int i ); - /** Returns the maximum of two doubles or the first argument if both are equal*/ + //! Returns the maximum of two doubles or the first argument if both are equal double ANALYSIS_EXPORT max( double x, double y ); - /** Returns the minimum of two doubles or the first argument if both are equal*/ + //! Returns the minimum of two doubles or the first argument if both are equal double ANALYSIS_EXPORT min( double x, double y ); - /** Power function for integer coefficients*/ + //! Power function for integer coefficients double ANALYSIS_EXPORT power( double a, int b );//calculates a power b - /** Returns the area of a triangle. If the points are ordered counterclockwise, the value will be positiv. If they are ordered clockwise, the value will be negativ*/ + //! Returns the area of a triangle. If the points are ordered counterclockwise, the value will be positiv. If they are ordered clockwise, the value will be negativ double ANALYSIS_EXPORT triArea( Point3D* pa, Point3D* pb, Point3D* pc ); - /** Calculates the z-component of a vector with coordinates 'x' and 'y'which is in the same tangent plane as the tangent vectors 'v1' and 'v2'. The result is assigned to 'result' */ + //! Calculates the z-component of a vector with coordinates 'x' and 'y'which is in the same tangent plane as the tangent vectors 'v1' and 'v2'. The result is assigned to 'result' bool ANALYSIS_EXPORT derVec( const Vector3D* v1, const Vector3D* v2, Vector3D* result, double x, double y ); - /** Calculates the intersection of the two vectors vec1 and vec2, which start at first(vec1) and second(vec2) end. The return value is t2(multiplication of v2 with t2 and adding to 'second' results the intersection point)*/ + //! Calculates the intersection of the two vectors vec1 and vec2, which start at first(vec1) and second(vec2) end. The return value is t2(multiplication of v2 with t2 and adding to 'second' results the intersection point) double ANALYSIS_EXPORT crossVec( Point3D* first, Vector3D* vec1, Point3D* second, Vector3D* vec2 ); - /** Assigns the vector 'result', which is normal to the vector 'v1', on the left side of v1 and has length 'length'. This method works only with two dimensions.*/ + //! Assigns the vector 'result', which is normal to the vector 'v1', on the left side of v1 and has length 'length'. This method works only with two dimensions. bool ANALYSIS_EXPORT normalLeft( Vector3D* v1, Vector3D* result, double length ); - /** Assigns the vector 'result', which is normal to the vector 'v1', on the right side of v1 and has length 'length'. The calculation is only in two dimensions*/ + //! Assigns the vector 'result', which is normal to the vector 'v1', on the right side of v1 and has length 'length'. The calculation is only in two dimensions bool ANALYSIS_EXPORT normalRight( Vector3D* v1, Vector3D* result, double length ); - /** Calculates the normal vector of the plane through the points p1, p2 and p3 and assigns the result to vec. If the points are ordered counterclockwise, the normal will have a positive z-coordinate;*/ + //! Calculates the normal vector of the plane through the points p1, p2 and p3 and assigns the result to vec. If the points are ordered counterclockwise, the normal will have a positive z-coordinate; void ANALYSIS_EXPORT normalFromPoints( Point3D* p1, Point3D* p2, Point3D* p3, Vector3D* vec ); - /** Returns true, if the point with coordinates x and y is inside (or at the edge) of the triangle p1,p2,p3 and false, if it is outside. p1, p2 and p3 have to be ordered counterclockwise*/ + //! Returns true, if the point with coordinates x and y is inside (or at the edge) of the triangle p1,p2,p3 and false, if it is outside. p1, p2 and p3 have to be ordered counterclockwise bool ANALYSIS_EXPORT pointInsideTriangle( double x, double y, Point3D* p1, Point3D* p2, Point3D* p3 ); - /** Calculates a Vector orthogonal to 'tangent' with length 1 and closest possible to result. Returns true in case of success and false otherwise*/ + //! Calculates a Vector orthogonal to 'tangent' with length 1 and closest possible to result. Returns true in case of success and false otherwise bool ANALYSIS_EXPORT normalMinDistance( Vector3D* tangent, Vector3D* target, Vector3D* result ); - /** Tests, if 'test' is in the same plane as 'p1', 'p2' and 'p3' and returns the z-difference from the plane to 'test*/ + //! Tests, if 'test' is in the same plane as 'p1', 'p2' and 'p3' and returns the z-difference from the plane to 'test double ANALYSIS_EXPORT planeTest( Point3D* test, Point3D* pt1, Point3D* pt2, Point3D* pt3 ); - /** Calculates the angle between two segments (in 2 dimension, z-values are ignored)*/ + //! Calculates the angle between two segments (in 2 dimension, z-values are ignored) double ANALYSIS_EXPORT angle( Point3D* p1, Point3D* p2, Point3D* p3, Point3D* p4 ); } diff --git a/src/analysis/interpolation/Node.h b/src/analysis/interpolation/Node.h index df9d034a20d..0e941ebec9c 100644 --- a/src/analysis/interpolation/Node.h +++ b/src/analysis/interpolation/Node.h @@ -24,22 +24,22 @@ class ANALYSIS_EXPORT Node { protected: - /** Pointer to the Point3D object associated with the node*/ + //! Pointer to the Point3D object associated with the node Point3D* mPoint; - /** Pointer to the next Node in the linked list*/ + //! Pointer to the next Node in the linked list Node* mNext; public: Node(); Node( const Node& n ); ~Node(); Node& operator=( const Node& n ); - /** Returns a pointer to the next element in the linked list*/ + //! Returns a pointer to the next element in the linked list Node* getNext() const; - /** Returns a pointer to the Point3D object associated with the node*/ + //! Returns a pointer to the Point3D object associated with the node Point3D* getPoint() const; - /** Sets the pointer to the next node*/ + //! Sets the pointer to the next node void setNext( Node* n ); - /** Sets a new pointer to an associated Point3D object*/ + //! Sets a new pointer to an associated Point3D object void setPoint( Point3D* p ); }; diff --git a/src/analysis/interpolation/NormVecDecorator.h b/src/analysis/interpolation/NormVecDecorator.h index efee2bb4ddd..a0588101b97 100644 --- a/src/analysis/interpolation/NormVecDecorator.h +++ b/src/analysis/interpolation/NormVecDecorator.h @@ -29,54 +29,54 @@ class QProgressDialog; class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator { public: - /** Enumeration for the state of a point. NORMAL means, that the point is not on a breakline, BREAKLINE means that the point is on a breakline (but not an endpoint of it) and ENDPOINT means, that it is an endpoint of a breakline*/ + //! Enumeration for the state of a point. NORMAL means, that the point is not on a breakline, BREAKLINE means that the point is on a breakline (but not an endpoint of it) and ENDPOINT means, that it is an endpoint of a breakline enum pointState {NORMAL, BREAKLINE, ENDPOINT}; NormVecDecorator(); NormVecDecorator( Triangulation* tin ); virtual ~NormVecDecorator(); - /** Adds a point to the triangulation*/ + //! Adds a point to the triangulation int addPoint( Point3D* p ) override; - /** Calculates the normal at a point on the surface and assigns it to 'result'. Returns true in case of success and false in case of failure*/ + //! Calculates the normal at a point on the surface and assigns it to 'result'. Returns true in case of success and false in case of failure bool calcNormal( double x, double y, Vector3D* result ) override; - /** Calculates the normal of a triangle-point for the point with coordinates x and y. This is needed, if a point is on a break line and there is no unique normal stored in 'mNormVec'. Returns false, it something went wrong and true otherwise*/ + //! Calculates the normal of a triangle-point for the point with coordinates x and y. This is needed, if a point is on a break line and there is no unique normal stored in 'mNormVec'. Returns false, it something went wrong and true otherwise bool calcNormalForPoint( double x, double y, int point, Vector3D* result ); - /** Calculates x-, y and z-value of the point on the surface and assigns it to 'result'. Returns true in case of success and flase in case of failure*/ + //! Calculates x-, y and z-value of the point on the surface and assigns it to 'result'. Returns true in case of success and flase in case of failure bool calcPoint( double x, double y, Point3D* result ) override; - /** Eliminates the horizontal triangles by swapping or by insertion of new points. If alreadyestimated is true, a re-estimation of the normals will be done*/ + //! Eliminates the horizontal triangles by swapping or by insertion of new points. If alreadyestimated is true, a re-estimation of the normals will be done virtual void eliminateHorizontalTriangles() override; - /** Estimates the first derivative a point. Return true in case of succes and false otherwise*/ + //! Estimates the first derivative a point. Return true in case of succes and false otherwise bool estimateFirstDerivative( int pointno ); - /** This method adds the functionality of estimating normals at the data points. Return true in the case of success and false otherwise*/ + //! This method adds the functionality of estimating normals at the data points. Return true in the case of success and false otherwise bool estimateFirstDerivatives( QProgressDialog* d = nullptr ); - /** Returns a pointer to the normal vector for the point with the number n*/ + //! Returns a pointer to the normal vector for the point with the number n Vector3D* getNormal( int n ) const; - /** Finds out, in which triangle a point with coordinates x and y is and assigns the triangle points to p1, p2, p3 and the estimated normals to v1, v2, v3. The vectors are normaly taken from 'mNormVec', exept if p1, p2 or p3 is a point on a breakline. In this case, the normal is calculated on-the-fly. Returns false, if something went wrong and true otherwise*/ + //! Finds out, in which triangle a point with coordinates x and y is and assigns the triangle points to p1, p2, p3 and the estimated normals to v1, v2, v3. The vectors are normaly taken from 'mNormVec', exept if p1, p2 or p3 is a point on a breakline. In this case, the normal is calculated on-the-fly. Returns false, if something went wrong and true otherwise bool getTriangle( double x, double y, Point3D* p1, Vector3D* v1, Point3D* p2, Vector3D* v2, Point3D* p3, Vector3D* v3 ); /** This function behaves similar to the one above. Additionally, the numbers of the points are returned (ptn1, ptn2, ptn3) as well as the pointStates of the triangle points (state1, state2, state3) * @note not available in Python bindings */ bool getTriangle( double x, double y, Point3D* p1, int* ptn1, Vector3D* v1, pointState* state1, Point3D* p2, int* ptn2, Vector3D* v2, pointState* state2, Point3D* p3, int* ptn3, Vector3D* v3, pointState* state3 ); - /** Returns the state of the point with the number 'pointno'*/ + //! Returns the state of the point with the number 'pointno' pointState getState( int pointno ) const; - /** Sets an interpolator*/ + //! Sets an interpolator void setTriangleInterpolator( TriangleInterpolator* inter ) override; - /** Swaps the edge which is closest to the point with x and y coordinates (if this is possible) and forces recalculation of the concerned normals (if alreadyestimated is true)*/ + //! Swaps the edge which is closest to the point with x and y coordinates (if this is possible) and forces recalculation of the concerned normals (if alreadyestimated is true) virtual bool swapEdge( double x, double y ) override; /** Saves the triangulation as a (line) shapefile @return true in case of success*/ virtual bool saveAsShapefile( const QString& fileName ) const override; protected: - /** Is true, if the normals already have been estimated*/ + //! Is true, if the normals already have been estimated bool alreadyestimated; const static unsigned int mDefaultStorageForNormals = 100000; - /** Association with an interpolator object*/ + //! Association with an interpolator object TriangleInterpolator* mInterpolator; - /** Vector that stores the normals for the points. If 'estimateFirstDerivatives()' was called and there is a null pointer, this means, that the triangle point is on a breakline*/ + //! Vector that stores the normals for the points. If 'estimateFirstDerivatives()' was called and there is a null pointer, this means, that the triangle point is on a breakline QVector* mNormVec; - /** Vector who stores, it a point is not on a breakline, if it is a normal point of the breakline or if it is an endpoint of a breakline*/ + //! Vector who stores, it a point is not on a breakline, if it is a normal point of the breakline or if it is an endpoint of a breakline QVector* mPointState; - /** Sets the state (BREAKLINE, NORMAL, ENDPOINT) of a point*/ + //! Sets the state (BREAKLINE, NORMAL, ENDPOINT) of a point void setState( int pointno, pointState s ); }; diff --git a/src/analysis/interpolation/ParametricLine.h b/src/analysis/interpolation/ParametricLine.h index 44650d4bcad..7005eff00b3 100644 --- a/src/analysis/interpolation/ParametricLine.h +++ b/src/analysis/interpolation/ParametricLine.h @@ -28,19 +28,19 @@ class Vector3D; class ANALYSIS_EXPORT ParametricLine { protected: - /** Degree of the parametric Line*/ + //! Degree of the parametric Line int mDegree; - /** Pointer to the parent object. If there isn't one, mParent is 0*/ + //! Pointer to the parent object. If there isn't one, mParent is 0 ParametricLine* mParent; - /** MControlPoly stores the points of the control polygon*/ + //! MControlPoly stores the points of the control polygon QVector* mControlPoly; public: - /** Default constructor*/ + //! Default constructor ParametricLine(); /** Constructor, par is a pointer to the parent object, controlpoly the controlpolygon */ ParametricLine( ParametricLine* par, QVector* controlpoly ); - /** Destructor*/ + //! Destructor virtual ~ParametricLine(); virtual void add( ParametricLine* pl ) = 0; virtual void calcFirstDer( float t, Vector3D* v ) = 0; diff --git a/src/analysis/interpolation/Point3D.h b/src/analysis/interpolation/Point3D.h index 97abdc42f36..013d4832d8f 100644 --- a/src/analysis/interpolation/Point3D.h +++ b/src/analysis/interpolation/Point3D.h @@ -24,34 +24,34 @@ class ANALYSIS_EXPORT Point3D { protected: - /** X-coordinate*/ + //! X-coordinate double mX; - /** Y-coordinate*/ + //! Y-coordinate double mY; - /** Z-coordinate*/ + //! Z-coordinate double mZ; public: Point3D(); - /** Constructor with the x-, y- and z-coordinate as arguments*/ + //! Constructor with the x-, y- and z-coordinate as arguments Point3D( double x, double y, double z ); Point3D( const Point3D& p ); ~Point3D(); Point3D& operator=( const Point3D& p ); bool operator==( const Point3D& p ) const; bool operator!=( const Point3D& p ) const; - /** Calculates the three-dimensional distance to another point*/ + //! Calculates the three-dimensional distance to another point double dist3D( Point3D* p ) const; - /** Returns the x-coordinate of the point*/ + //! Returns the x-coordinate of the point double getX() const; - /** Returns the y-coordinate of the point*/ + //! Returns the y-coordinate of the point double getY() const; - /** Returns the z-coordinate of the point*/ + //! Returns the z-coordinate of the point double getZ() const; - /** Sets the x-coordinate of the point*/ + //! Sets the x-coordinate of the point void setX( double x ); - /** Sets the y-coordinate of the point*/ + //! Sets the y-coordinate of the point void setY( double y ); - /** Sets the z-coordinate of the point*/ + //! Sets the z-coordinate of the point void setZ( double z ); }; diff --git a/src/analysis/interpolation/TriDecorator.h b/src/analysis/interpolation/TriDecorator.h index 6c5121294af..2c65eff9925 100644 --- a/src/analysis/interpolation/TriDecorator.h +++ b/src/analysis/interpolation/TriDecorator.h @@ -29,9 +29,9 @@ class ANALYSIS_EXPORT TriDecorator : public Triangulation virtual ~TriDecorator(); virtual void addLine( Line3D* line, bool breakline ) override; virtual int addPoint( Point3D* p ) override; - /** Adds an association to a triangulation*/ + //! Adds an association to a triangulation virtual void addTriangulation( Triangulation* t ); - /** Performs a consistency check, remove this later*/ + //! Performs a consistency check, remove this later virtual void performConsistencyTest() override; virtual bool calcNormal( double x, double y, Vector3D* result ) override; virtual bool calcPoint( double x, double y, Point3D* result ) override; @@ -56,7 +56,7 @@ class ANALYSIS_EXPORT TriDecorator : public Triangulation virtual bool swapEdge( double x, double y ) override; virtual QList* getPointsAroundEdge( double x, double y ) override; protected: - /** Association with a Triangulation object*/ + //! Association with a Triangulation object Triangulation* mTIN; }; diff --git a/src/analysis/interpolation/TriangleInterpolator.h b/src/analysis/interpolation/TriangleInterpolator.h index 4a638e99e29..4155ca29a00 100644 --- a/src/analysis/interpolation/TriangleInterpolator.h +++ b/src/analysis/interpolation/TriangleInterpolator.h @@ -26,9 +26,9 @@ class ANALYSIS_EXPORT TriangleInterpolator { public: virtual ~TriangleInterpolator() {} - /** Calculates the normal vector and assigns it to vec*/ + //! Calculates the normal vector and assigns it to vec virtual bool calcNormVec( double x, double y, Vector3D* result ) = 0; - /** Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point*/ + //! Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point virtual bool calcPoint( double x, double y, Point3D* result ) = 0; }; diff --git a/src/analysis/interpolation/Triangulation.h b/src/analysis/interpolation/Triangulation.h index b11191efd8a..d6edfb19a68 100644 --- a/src/analysis/interpolation/Triangulation.h +++ b/src/analysis/interpolation/Triangulation.h @@ -31,8 +31,8 @@ class ANALYSIS_EXPORT Triangulation //! Enumeration describing the behaviour, if two forced lines cross. enum forcedCrossBehaviour { - SnappingType_VERTICE, //!< the second inserted forced line is snapped to the closest vertice of the first inserted forced line. - DELETE_FIRST, //!< the status of the first inserted forced line is reset to that of a normal edge (so that the second inserted forced line remain and the first not) + SnappingType_VERTICE, //!< The second inserted forced line is snapped to the closest vertice of the first inserted forced line. + DELETE_FIRST, //!< The status of the first inserted forced line is reset to that of a normal edge (so that the second inserted forced line remain and the first not) INSERT_VERTICE }; virtual ~Triangulation(); @@ -55,7 +55,7 @@ class ANALYSIS_EXPORT Triangulation */ virtual bool calcNormal( double x, double y, Vector3D* result ) = 0; - /** Performs a consistency check, remove this later*/ + //! Performs a consistency check, remove this later virtual void performConsistencyTest() = 0; /** @@ -64,7 +64,7 @@ class ANALYSIS_EXPORT Triangulation */ virtual bool calcPoint( double x, double y, Point3D* result ) = 0; - /** Returns a pointer to the point with number i. Any virtual points must have the number -1*/ + //! Returns a pointer to the point with number i. Any virtual points must have the number -1 virtual Point3D* getPoint( unsigned int i ) const = 0; /** Finds out in which triangle the point with coordinates x and y is and @@ -72,25 +72,25 @@ class ANALYSIS_EXPORT Triangulation */ virtual bool getTriangle( double x, double y, Point3D* p1, int* n1, Point3D* p2, int* n2, Point3D* p3, int* n3 ) = 0; - /** Finds out, in which triangle the point with coordinates x and y is and assigns the points at the vertices to 'p1', 'p2' and 'p3*/ + //! Finds out, in which triangle the point with coordinates x and y is and assigns the points at the vertices to 'p1', 'p2' and 'p3 virtual bool getTriangle( double x, double y, Point3D* p1, Point3D* p2, Point3D* p3 ) = 0; - /** Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge)*/ + //! Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge) virtual int getOppositePoint( int p1, int p2 ) = 0; - /** Returns the largest x-coordinate value of the bounding box*/ + //! Returns the largest x-coordinate value of the bounding box virtual double getXMax() const = 0; - /** Returns the smallest x-coordinate value of the bounding box*/ + //! Returns the smallest x-coordinate value of the bounding box virtual double getXMin() const = 0; - /** Returns the largest y-coordinate value of the bounding box*/ + //! Returns the largest y-coordinate value of the bounding box virtual double getYMax() const = 0; - /** Returns the smallest x-coordinate value of the bounding box*/ + //! Returns the smallest x-coordinate value of the bounding box virtual double getYMin() const = 0; - /** Returns the number of points*/ + //! Returns the number of points virtual int getNumberOfPoints() const = 0; /** @@ -109,40 +109,40 @@ class ANALYSIS_EXPORT Triangulation */ virtual QList* getPointsAroundEdge( double x, double y ) = 0; - /** Draws the points, edges and the forced lines*/ + //! Draws the points, edges and the forced lines //virtual void draw(QPainter* p, double xlowleft, double ylowleft, double xupright, double yupright, double width, double height) const=0; - /** Sets the behaviour of the triangulation in case of crossing forced lines*/ + //! Sets the behaviour of the triangulation in case of crossing forced lines virtual void setForcedCrossBehaviour( Triangulation::forcedCrossBehaviour b ) = 0; - /** Sets the color of the normal edges*/ + //! Sets the color of the normal edges virtual void setEdgeColor( int r, int g, int b ) = 0; - /** Sets the color of the forced edges*/ + //! Sets the color of the forced edges virtual void setForcedEdgeColor( int r, int g, int b ) = 0; - /** Sets the color of the breaklines*/ + //! Sets the color of the breaklines virtual void setBreakEdgeColor( int r, int g, int b ) = 0; - /** Sets an interpolator object*/ + //! Sets an interpolator object virtual void setTriangleInterpolator( TriangleInterpolator* interpolator ) = 0; - /** Eliminates the horizontal triangles by swapping*/ + //! Eliminates the horizontal triangles by swapping virtual void eliminateHorizontalTriangles() = 0; - /** Adds points to make the triangles better shaped (algorithm of ruppert)*/ + //! Adds points to make the triangles better shaped (algorithm of ruppert) virtual void ruppertRefinement() = 0; - /** Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise*/ + //! Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise virtual bool pointInside( double x, double y ) = 0; - /** Reads the content of a taff-file*/ + //! Reads the content of a taff-file //virtual bool readFromTAFF(QString fileName)=0; - /** Saves the content to a taff file*/ + //! Saves the content to a taff file //virtual bool saveToTAFF(QString fileName) const=0; - /** Swaps the edge which is closest to the point with x and y coordinates (if this is possible)*/ + //! Swaps the edge which is closest to the point with x and y coordinates (if this is possible) virtual bool swapEdge( double x, double y ) = 0; /** diff --git a/src/analysis/interpolation/Vector3D.h b/src/analysis/interpolation/Vector3D.h index 7f3d32b8396..f4ae8441614 100644 --- a/src/analysis/interpolation/Vector3D.h +++ b/src/analysis/interpolation/Vector3D.h @@ -28,40 +28,40 @@ class ANALYSIS_EXPORT Vector3D { protected: - /** X-component of the vector*/ + //! X-component of the vector double mX; - /** Y-component of the vector*/ + //! Y-component of the vector double mY; - /** Z-component of the vector*/ + //! Z-component of the vector double mZ; public: - /** Constructor taking the three components as arguments*/ + //! Constructor taking the three components as arguments Vector3D( double x, double y, double z ); - /** Default constructor*/ + //! Default constructor Vector3D(); - /** Copy constructor*/ + //! Copy constructor Vector3D( const Vector3D& v ); - /** Destructor*/ + //! Destructor ~Vector3D(); Vector3D& operator=( const Vector3D& v ); bool operator==( const Vector3D& v ) const; bool operator!=( const Vector3D& v ) const; - /** Returns the x-component of the vector*/ + //! Returns the x-component of the vector double getX() const; - /** Returns the y-component of the vector*/ + //! Returns the y-component of the vector double getY() const; - /** Returns the z-component of the vector*/ + //! Returns the z-component of the vector double getZ() const; - /** Returns the length of the vector*/ + //! Returns the length of the vector double getLength() const; - /** Sets the x-component of the vector*/ + //! Sets the x-component of the vector void setX( double x ); - /** Sets the y-component of the vector*/ + //! Sets the y-component of the vector void setY( double y ); - /** Sets the z-component of the vector*/ + //! Sets the z-component of the vector void setZ( double z ); - /** Standardises the vector*/ + //! Standardises the vector void standardise(); }; diff --git a/src/analysis/interpolation/qgsinterpolator.h b/src/analysis/interpolation/qgsinterpolator.h index 336295d0bc6..4d3d9ab912a 100644 --- a/src/analysis/interpolation/qgsinterpolator.h +++ b/src/analysis/interpolation/qgsinterpolator.h @@ -37,7 +37,7 @@ can be an attribute or the z-coordinates in case of 25D types*/ class ANALYSIS_EXPORT QgsInterpolator { public: - /** Describes the type of input data*/ + //! Describes the type of input data enum InputType { POINTS, @@ -45,7 +45,7 @@ class ANALYSIS_EXPORT QgsInterpolator BREAK_LINES }; - /** A layer together with the information about interpolation attribute / z-coordinate interpolation and the type (point, structure line, breakline)*/ + //! A layer together with the information about interpolation attribute / z-coordinate interpolation and the type (point, structure line, breakline) struct LayerData { QgsVectorLayer* vectorLayer; @@ -76,7 +76,7 @@ class ANALYSIS_EXPORT QgsInterpolator QVector mCachedBaseData; - /** Flag that tells if the cache already has been filled*/ + //! Flag that tells if the cache already has been filled bool mDataIsCached; //Information about the input vector layers and the attributes (or z-values) that are used for interpolation diff --git a/src/analysis/interpolation/qgstininterpolator.h b/src/analysis/interpolation/qgstininterpolator.h index be19e73aa34..0ba1a13dd9c 100644 --- a/src/analysis/interpolation/qgstininterpolator.h +++ b/src/analysis/interpolation/qgstininterpolator.h @@ -54,14 +54,14 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator TriangleInterpolator* mTriangleInterpolator; bool mIsInitialized; bool mShowProgressDialog; - /** If true: export triangulation to shapefile after initialization*/ + //! If true: export triangulation to shapefile after initialization bool mExportTriangulationToFile; - /** File path to export the triangulation*/ + //! File path to export the triangulation QString mTriangulationFilePath; - /** Type of interpolation*/ + //! Type of interpolation TIN_INTERPOLATION mInterpolation; - /** Create dual edge triangulation*/ + //! Create dual edge triangulation void initialize(); /** Inserts the vertices of a feature into the triangulation @param f the feature diff --git a/src/analysis/openstreetmap/qgsosmdownload.h b/src/analysis/openstreetmap/qgsosmdownload.h index d45984f030c..4b9dea23c2b 100644 --- a/src/analysis/openstreetmap/qgsosmdownload.h +++ b/src/analysis/openstreetmap/qgsosmdownload.h @@ -82,8 +82,8 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject bool isFinished() const; signals: - void finished(); //!< emitted when the network reply has finished (with success or with an error) - void downloadProgress( qint64, qint64 ); //!< normally the total length is not known (until we reach end) + void finished(); //!< Emitted when the network reply has finished (with success or with an error) + void downloadProgress( qint64, qint64 ); //!< Normally the total length is not known (until we reach end) private slots: void onReadyRead(); diff --git a/src/analysis/raster/qgsderivativefilter.h b/src/analysis/raster/qgsderivativefilter.h index ad3e15d2839..796b089fb9a 100644 --- a/src/analysis/raster/qgsderivativefilter.h +++ b/src/analysis/raster/qgsderivativefilter.h @@ -33,9 +33,9 @@ class ANALYSIS_EXPORT QgsDerivativeFilter : public QgsNineCellFilter float* x13, float* x23, float* x33 ) override = 0; protected: - /** Calculates the first order derivative in x-direction according to Horn (1981)*/ + //! Calculates the first order derivative in x-direction according to Horn (1981) float calcFirstDerX( float* x11, float* x21, float* x31, float* x12, float* x22, float* x32, float* x13, float* x23, float* x33 ); - /** Calculates the first order derivative in y-direction according to Horn (1981)*/ + //! Calculates the first order derivative in y-direction according to Horn (1981) float calcFirstDerY( float* x11, float* x21, float* x31, float* x12, float* x22, float* x32, float* x13, float* x23, float* x33 ); }; diff --git a/src/analysis/raster/qgsninecellfilter.h b/src/analysis/raster/qgsninecellfilter.h index 75639d73662..3719bbdd45b 100644 --- a/src/analysis/raster/qgsninecellfilter.h +++ b/src/analysis/raster/qgsninecellfilter.h @@ -31,7 +31,7 @@ the method that calculates the new value from the nine values. Everything else ( class ANALYSIS_EXPORT QgsNineCellFilter { public: - /** Constructor that takes input file, output file and output format (GDAL string)*/ + //! Constructor that takes input file, output file and output format (GDAL string) QgsNineCellFilter( const QString& inputFile, const QString& outputFile, const QString& outputFormat ); virtual ~QgsNineCellFilter(); /** Starts the calculation, reads from mInputFile and stores the result in mOutputFile @@ -62,7 +62,7 @@ class ANALYSIS_EXPORT QgsNineCellFilter //default constructor forbidden. We need input file, output file and format obligatory QgsNineCellFilter(); - /** Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction*/ + //! Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction GDALDatasetH openInputFile( int& nCellsX, int& nCellsY ); /** Opens the output driver and tests if it supports the creation of a new dataset @return nullptr on error and the driver handle on success*/ @@ -79,11 +79,11 @@ class ANALYSIS_EXPORT QgsNineCellFilter double mCellSizeX; double mCellSizeY; - /** The nodata value of the input layer*/ + //! The nodata value of the input layer float mInputNodataValue; - /** The nodata value of the output layer*/ + //! The nodata value of the output layer float mOutputNodataValue; - /** Scale factor for z-value if x-/y- units are different to z-units (111120 for degree->meters and 370400 for degree->feet)*/ + //! Scale factor for z-value if x-/y- units are different to z-units (111120 for degree->meters and 370400 for degree->feet) double mZFactor; }; diff --git a/src/analysis/raster/qgsrastercalculator.h b/src/analysis/raster/qgsrastercalculator.h index 9e3dfd7fbe4..3b9b2329413 100644 --- a/src/analysis/raster/qgsrastercalculator.h +++ b/src/analysis/raster/qgsrastercalculator.h @@ -44,12 +44,12 @@ class ANALYSIS_EXPORT QgsRasterCalculator //! Result of the calculation enum Result { - Success = 0, /*!< Calculation sucessful */ - CreateOutputError = 1, /*!< Error creating output data file */ - InputLayerError = 2, /*!< Error reading input layer */ - Cancelled = 3, /*!< User cancelled calculation */ - ParserError = 4, /*!< Error parsing formula */ - MemoryError = 5, /*!< Error allocating memory for result */ + Success = 0, //!< Calculation sucessful + CreateOutputError = 1, //!< Error creating output data file + InputLayerError = 2, //!< Error reading input layer + Cancelled = 3, //!< User cancelled calculation + ParserError = 4, //!< Error parsing formula + MemoryError = 5, //!< Error allocating memory for result }; /** QgsRasterCalculator constructor. @@ -104,13 +104,13 @@ class ANALYSIS_EXPORT QgsRasterCalculator QString mOutputFile; QString mOutputFormat; - /** Output raster extent*/ + //! Output raster extent QgsRectangle mOutputRectangle; QgsCoordinateReferenceSystem mOutputCrs; - /** Number of output columns*/ + //! Number of output columns int mNumOutputColumns; - /** Number of output rows*/ + //! Number of output rows int mNumOutputRows; /***/ diff --git a/src/analysis/raster/qgsrastermatrix.h b/src/analysis/raster/qgsrastermatrix.h index 267c686fa54..81282553e02 100644 --- a/src/analysis/raster/qgsrastermatrix.h +++ b/src/analysis/raster/qgsrastermatrix.h @@ -56,21 +56,21 @@ class ANALYSIS_EXPORT QgsRasterMatrix opLOG10, }; - /** Takes ownership of data array*/ + //! Takes ownership of data array QgsRasterMatrix(); //! @note note available in python bindings QgsRasterMatrix( int nCols, int nRows, double* data, double nodataValue ); QgsRasterMatrix( const QgsRasterMatrix& m ); ~QgsRasterMatrix(); - /** Returns true if matrix is 1x1 (=scalar number)*/ + //! Returns true if matrix is 1x1 (=scalar number) bool isNumber() const { return ( mColumns == 1 && mRows == 1 ); } double number() const { return mData[0]; } - /** Returns data array (but not ownership)*/ + //! Returns data array (but not ownership) //! @note not available in python bindings double* data() { return mData; } - /** Returns data and ownership. Sets data and nrows, ncols of this matrix to 0*/ + //! Returns data and ownership. Sets data and nrows, ncols of this matrix to 0 //! @note not available in python bindings double* takeData(); @@ -83,9 +83,9 @@ class ANALYSIS_EXPORT QgsRasterMatrix void setNodataValue( double d ) { mNodataValue = d; } QgsRasterMatrix& operator=( const QgsRasterMatrix& m ); - /** Adds another matrix to this one*/ + //! Adds another matrix to this one bool add( const QgsRasterMatrix& other ); - /** Subtracts another matrix from this one*/ + //! Subtracts another matrix from this one bool subtract( const QgsRasterMatrix& other ); bool multiply( const QgsRasterMatrix& other ); bool divide( const QgsRasterMatrix& other ); @@ -116,7 +116,7 @@ class ANALYSIS_EXPORT QgsRasterMatrix double* mData; double mNodataValue; - /** +,-,*,/,^,<,>,<=,>=,=,!=, and, or*/ + //! +,-,*,/,^,<,>,<=,>=,=,!=, and, or bool twoArgumentOperation( TwoArgOperator op, const QgsRasterMatrix& other ); double calculateTwoArgumentOp( TwoArgOperator op, double arg1, double arg2 ) const; diff --git a/src/analysis/raster/qgsrelief.h b/src/analysis/raster/qgsrelief.h index 6fe4dd3c6fc..d6bf989c281 100644 --- a/src/analysis/raster/qgsrelief.h +++ b/src/analysis/raster/qgsrelief.h @@ -62,7 +62,7 @@ class ANALYSIS_EXPORT QgsRelief @return true in case of success*/ QList< ReliefColor > calculateOptimizedReliefClasses(); - /** Write frequency of elevation values to file for manual inspection*/ + //! Write frequency of elevation values to file for manual inspection bool exportFrequencyDistributionToCsv( const QString& file ); private: @@ -73,9 +73,9 @@ class ANALYSIS_EXPORT QgsRelief double mCellSizeX; double mCellSizeY; - /** The nodata value of the input layer*/ + //! The nodata value of the input layer float mInputNodataValue; - /** The nodata value of the output layer*/ + //! The nodata value of the output layer float mOutputNodataValue; double mZFactor; @@ -92,7 +92,7 @@ class ANALYSIS_EXPORT QgsRelief bool processNineCellWindow( float* x1, float* x2, float* x3, float* x4, float* x5, float* x6, float* x7, float* x8, float* x9, unsigned char* red, unsigned char* green, unsigned char* blue ); - /** Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction*/ + //! Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction GDALDatasetH openInputFile( int& nCellsX, int& nCellsY ); /** Opens the output driver and tests if it supports the creation of a new dataset @return nullptr on error and the driver handle on success*/ @@ -101,15 +101,15 @@ class ANALYSIS_EXPORT QgsRelief @return the output dataset or nullptr in case of error*/ GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver ); - /** Set elevation color*/ + //! Set elevation color bool setElevationColor( double elevation, int* red, int* green, int* blue ); - /** Sets relief colors*/ + //! Sets relief colors void setDefaultReliefColors(); /** Returns class (0-255) for an elevation value @return elevation class or -1 in case of error*/ int frequencyClassForElevation( double elevation, double minElevation, double elevationClassRange ); - /** Do one iteration of class break optimisation (algorithm from Garcia and Rodriguez)*/ + //! Do one iteration of class break optimisation (algorithm from Garcia and Rodriguez) void optimiseClassBreaks( QList& breaks, double* frequencies ); /** Calculates coefficients a and b @param input data points ( elevation class / frequency ) diff --git a/src/analysis/vector/qgsgeometryanalyzer.h b/src/analysis/vector/qgsgeometryanalyzer.h index c7456fda84e..037f2156b53 100644 --- a/src/analysis/vector/qgsgeometryanalyzer.h +++ b/src/analysis/vector/qgsgeometryanalyzer.h @@ -118,7 +118,7 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer const QString& outputFormat, int locationField1, int locationField2 = -1, int offsetField = -1, double offsetScale = 1.0, bool forceSingleGeometry = false, QgsVectorDataProvider* memoryProvider = nullptr, QProgressDialog* p = nullptr ); - /** Returns linear reference geometry as a multiline (or 0 if no match). Currently, the z-coordinates are considered to be the measures (no support for m-values in QGIS)*/ + //! Returns linear reference geometry as a multiline (or 0 if no match). Currently, the z-coordinates are considered to be the measures (no support for m-values in QGIS) QgsGeometry locateBetweenMeasures( double fromMeasure, double toMeasure, const QgsGeometry& lineGeom ); /** Returns linear reference geometry. Unlike the PostGIS function, this method always returns multipoint or 0 if no match (not geometry collection). * Currently, the z-coordinates are considered to be the measures (no support for m-values in QGIS) @@ -129,16 +129,16 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer QList simpleMeasure( QgsGeometry& geometry ); double perimeterMeasure( const QgsGeometry& geometry, QgsDistanceArea& measure ); - /** Helper function to simplify an individual feature*/ + //! Helper function to simplify an individual feature void simplifyFeature( QgsFeature& f, QgsVectorFileWriter* vfw, double tolerance ); - /** Helper function to get the cetroid of an individual feature*/ + //! Helper function to get the cetroid of an individual feature void centroidFeature( QgsFeature& f, QgsVectorFileWriter* vfw ); - /** Helper function to buffer an individual feature*/ + //! Helper function to buffer an individual feature void bufferFeature( QgsFeature& f, int nProcessedFeatures, QgsVectorFileWriter* vfw, bool dissolve, QgsGeometry& dissolveGeometry, double bufferDistance, int bufferDistanceField ); - /** Helper function to get the convex hull of feature(s)*/ + //! Helper function to get the convex hull of feature(s) void convexFeature( QgsFeature& f, int nProcessedFeatures, QgsGeometry& dissolveGeometry ); - /** Helper function to dissolve feature(s)*/ + //! Helper function to dissolve feature(s) QgsGeometry dissolveFeature( const QgsFeature& f, const QgsGeometry& dissolveInto ); //helper functions for event layer diff --git a/src/analysis/vector/qgspointsample.h b/src/analysis/vector/qgspointsample.h index e46d079b0f4..7db3d188571 100644 --- a/src/analysis/vector/qgspointsample.h +++ b/src/analysis/vector/qgspointsample.h @@ -42,13 +42,13 @@ class ANALYSIS_EXPORT QgsPointSample void addSamplePoints( QgsFeature& inputFeature, QgsVectorFileWriter& writer, int nPoints, double minDistance ); bool checkMinDistance( QgsPoint& pt, QgsSpatialIndex& index, double minDistance, QMap< QgsFeatureId, QgsPoint >& pointMap ); - /** Layer id of input polygon/multipolygon layer*/ + //! Layer id of input polygon/multipolygon layer QgsVectorLayer* mInputLayer; - /** Output path of result layer*/ + //! Output path of result layer QString mOutputLayer; - /** Attribute containing number of points per feature*/ + //! Attribute containing number of points per feature QString mNumberOfPointsAttribute; - /** Attribute containing minimum distance between sample points (or -1 if no min. distance constraint)*/ + //! Attribute containing minimum distance between sample points (or -1 if no min. distance constraint) QString mMinDistanceAttribute; QgsFeatureId mNCreatedPoints; //helper to find free ids }; diff --git a/src/analysis/vector/qgstransectsample.h b/src/analysis/vector/qgstransectsample.h index 8f4aaebaee3..09651ccfcc8 100644 --- a/src/analysis/vector/qgstransectsample.h +++ b/src/analysis/vector/qgstransectsample.h @@ -50,7 +50,7 @@ class ANALYSIS_EXPORT QgsTransectSample QgsGeometry findBaselineGeometry( const QVariant& strataId ); - /** Returns true if another transect is within the specified minimum distance*/ + //! Returns true if another transect is within the specified minimum distance static bool otherTransectWithinDistance( const QgsGeometry& geom, double minDistLayerUnit, double minDistance, QgsSpatialIndex& sIndex, const QMap& lineFeatureMap, QgsDistanceArea& da ); QgsVectorLayer* mStrataLayer; @@ -70,9 +70,9 @@ class ANALYSIS_EXPORT QgsTransectSample double mMinTransectLength; - /** If value is negative, the buffer distance ist set to the same value as the minimum distance*/ + //! If value is negative, the buffer distance ist set to the same value as the minimum distance double mBaselineBufferDistance; - /** If value is negative, no simplification is done to the baseline prior to create the buffer*/ + //! If value is negative, no simplification is done to the baseline prior to create the buffer double mBaselineSimplificationTolerance; /** Finds the closest points between two line segments @@ -83,7 +83,7 @@ class ANALYSIS_EXPORT QgsTransectSample @param pt2 out: closest point on secont geometry @return true in case of success*/ static bool closestSegmentPoints( const QgsGeometry& g1, const QgsGeometry& g2, double& dist, QgsPoint& pt1, QgsPoint& pt2 ); - /** Returns a copy of the multiline element closest to a point (caller takes ownership)*/ + //! Returns a copy of the multiline element closest to a point (caller takes ownership) static QgsGeometry closestMultilineElement( const QgsPoint& pt, const QgsGeometry& multiLine ); /** Returns clipped buffer line. Iteratively applies reduced tolerances if the result is not a single line @param stratumGeom stratum polygon @@ -92,7 +92,7 @@ class ANALYSIS_EXPORT QgsTransectSample @return clipped buffer line or 0 in case of error*/ QgsGeometry* clipBufferLine( const QgsGeometry& stratumGeom, QgsGeometry* clippedBaseline, double tolerance ); - /** Returns distance to buffer the baseline (takes care of units and buffer settings*/ + //! Returns distance to buffer the baseline (takes care of units and buffer settings double bufferDistance( double minDistanceFromAttribute ) const; }; diff --git a/src/analysis/vector/qgszonalstatistics.h b/src/analysis/vector/qgszonalstatistics.h index 5044708a913..05d2d10325d 100644 --- a/src/analysis/vector/qgszonalstatistics.h +++ b/src/analysis/vector/qgszonalstatistics.h @@ -111,25 +111,25 @@ class ANALYSIS_EXPORT QgsZonalStatistics int cellInfoForBBox( const QgsRectangle& rasterBBox, const QgsRectangle& featureBBox, double cellSizeX, double cellSizeY, int& offsetX, int& offsetY, int& nCellsX, int& nCellsY ) const; - /** Returns statistics by considering the pixels where the center point is within the polygon (fast)*/ + //! Returns statistics by considering the pixels where the center point is within the polygon (fast) void statisticsFromMiddlePointTest( void* band, const QgsGeometry& poly, int pixelOffsetX, int pixelOffsetY, int nCellsX, int nCellsY, double cellSizeX, double cellSizeY, const QgsRectangle& rasterBBox, FeatureStats& stats ); - /** Returns statistics with precise pixel - polygon intersection test (slow) */ + //! Returns statistics with precise pixel - polygon intersection test (slow) void statisticsFromPreciseIntersection( void* band, const QgsGeometry& poly, int pixelOffsetX, int pixelOffsetY, int nCellsX, int nCellsY, double cellSizeX, double cellSizeY, const QgsRectangle& rasterBBox, FeatureStats& stats ); - /** Tests whether a pixel's value should be included in the result*/ + //! Tests whether a pixel's value should be included in the result bool validPixel( float value ) const; QString getUniqueFieldName( const QString& fieldName ); QString mRasterFilePath; - /** Raster band to calculate statistics from (defaults to 1)*/ + //! Raster band to calculate statistics from (defaults to 1) int mRasterBand; QgsVectorLayer* mPolygonLayer; QString mAttributePrefix; - /** The nodata value of the input layer*/ + //! The nodata value of the input layer float mInputNodataValue; Statistics mStatistics; }; diff --git a/src/app/composer/qgsattributeselectiondialog.h b/src/app/composer/qgsattributeselectiondialog.h index 63e658082e0..767a57a6bb4 100644 --- a/src/app/composer/qgsattributeselectiondialog.h +++ b/src/app/composer/qgsattributeselectiondialog.h @@ -36,7 +36,7 @@ class QgsComposerObject; // QgsComposerColumnAlignmentDelegate -/** A delegate for showing column alignment as a combo box*/ +//! A delegate for showing column alignment as a combo box class QgsComposerColumnAlignmentDelegate : public QItemDelegate { Q_OBJECT @@ -53,7 +53,7 @@ class QgsComposerColumnAlignmentDelegate : public QItemDelegate // QgsComposerColumnAlignmentDelegate -/** A delegate for showing column attribute source as a QgsFieldExpressionWidget*/ +//! A delegate for showing column attribute source as a QgsFieldExpressionWidget class QgsComposerColumnSourceDelegate : public QItemDelegate, private QgsExpressionContextGenerator { Q_OBJECT @@ -74,7 +74,7 @@ class QgsComposerColumnSourceDelegate : public QItemDelegate, private QgsExpress // QgsComposerColumnWidthDelegate -/** A delegate for showing column width as a spin box*/ +//! A delegate for showing column width as a spin box class QgsComposerColumnWidthDelegate : public QItemDelegate { Q_OBJECT @@ -91,7 +91,7 @@ class QgsComposerColumnWidthDelegate : public QItemDelegate // QgsComposerColumnSortOrderDelegate -/** A delegate for showing column sort order as a combo box*/ +//! A delegate for showing column sort order as a combo box class QgsComposerColumnSortOrderDelegate : public QItemDelegate { Q_OBJECT @@ -108,7 +108,7 @@ class QgsComposerColumnSortOrderDelegate : public QItemDelegate // QgsAttributeSelectionDialog -/** A dialog to select what attributes to display (in the table item), set the column properties and specify a sort order*/ +//! A dialog to select what attributes to display (in the table item), set the column properties and specify a sort order class QgsAttributeSelectionDialog: public QDialog, private Ui::QgsAttributeSelectionDialogBase { Q_OBJECT diff --git a/src/app/composer/qgscomposer.h b/src/app/composer/qgscomposer.h index 3f12a1d6720..167406ed702 100644 --- a/src/app/composer/qgscomposer.h +++ b/src/app/composer/qgscomposer.h @@ -389,43 +389,43 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase //! Save window state void saveWindowState(); - /** Add a composer arrow to the item/widget map and creates a configuration widget for it*/ + //! Add a composer arrow to the item/widget map and creates a configuration widget for it void addComposerArrow( QgsComposerArrow* arrow ); - /** Add a composer polygon to the item/widget map and creates a configuration widget for it*/ + //! Add a composer polygon to the item/widget map and creates a configuration widget for it void addComposerPolygon( QgsComposerPolygon* polygon ); - /** Add a composer polyline to the item/widget map and creates a configuration widget for it*/ + //! Add a composer polyline to the item/widget map and creates a configuration widget for it void addComposerPolyline( QgsComposerPolyline* polyline ); - /** Add a composer map to the item/widget map and creates a configuration widget for it*/ + //! Add a composer map to the item/widget map and creates a configuration widget for it void addComposerMap( QgsComposerMap* map ); - /** Adds a composer label to the item/widget map and creates a configuration widget for it*/ + //! Adds a composer label to the item/widget map and creates a configuration widget for it void addComposerLabel( QgsComposerLabel* label ); - /** Adds a composer scale bar to the item/widget map and creates a configuration widget for it*/ + //! Adds a composer scale bar to the item/widget map and creates a configuration widget for it void addComposerScaleBar( QgsComposerScaleBar* scalebar ); - /** Adds a composer legend to the item/widget map and creates a configuration widget for it*/ + //! Adds a composer legend to the item/widget map and creates a configuration widget for it void addComposerLegend( QgsComposerLegend* legend ); - /** Adds a composer picture to the item/widget map and creates a configuration widget*/ + //! Adds a composer picture to the item/widget map and creates a configuration widget void addComposerPicture( QgsComposerPicture* picture ); - /** Adds a composer shape to the item/widget map and creates a configuration widget*/ + //! Adds a composer shape to the item/widget map and creates a configuration widget void addComposerShape( QgsComposerShape* shape ); - /** Adds a composer table v2 to the item/widget map and creates a configuration widget*/ + //! Adds a composer table v2 to the item/widget map and creates a configuration widget void addComposerTableV2( QgsComposerAttributeTableV2* table, QgsComposerFrame* frame ); - /** Adds composer html and creates a configuration widget*/ + //! Adds composer html and creates a configuration widget void addComposerHtmlFrame( QgsComposerHtml* html, QgsComposerFrame* frame ); - /** Removes item from the item/widget map and deletes the configuration widget. Does not delete the item itself*/ + //! Removes item from the item/widget map and deletes the configuration widget. Does not delete the item itself void deleteItem( QgsComposerItem* item ); - /** Shows the configuration widget for a composer item*/ + //! Shows the configuration widget for a composer item void showItemOptions( QgsComposerItem* i ); //XML, usually connected with QgsProject::readProject and QgsProject::writeProject @@ -463,19 +463,19 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase private: - /** Establishes the signal slot connections from the QgsComposerView to the composer*/ + //! Establishes the signal slot connections from the QgsComposerView to the composer void connectViewSlots(); - /** Establishes the signal slot connections from the QgsComposition to the composer*/ + //! Establishes the signal slot connections from the QgsComposition to the composer void connectCompositionSlots(); - /** Establishes other signal slot connections for the composer*/ + //! Establishes other signal slot connections for the composer void connectOtherSlots(); - /** Creates the composition widget*/ + //! Creates the composition widget void createCompositionWidget(); - /** Sets up the compositions undo/redo connections*/ + //! Sets up the compositions undo/redo connections void setupUndoView(); //! True if a composer map contains a WMS layer @@ -532,19 +532,19 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase QPrinter* printer(); - /** Composer title*/ + //! Composer title QString mTitle; - /** Labels in status bar which shows current mouse position*/ + //! Labels in status bar which shows current mouse position QLabel* mStatusCursorXLabel; QLabel* mStatusCursorYLabel; QLabel* mStatusCursorPageLabel; - /** Combobox in status bar which shows/adjusts current zoom level*/ + //! Combobox in status bar which shows/adjusts current zoom level QComboBox* mStatusZoomCombo; QList mStatusZoomLevelsList; - /** Label in status bar which shows messages from the composition*/ + //! Label in status bar which shows messages from the composition QLabel* mStatusCompositionLabel; - /** Label in status bar which shows atlas details*/ + //! Label in status bar which shows atlas details QLabel* mStatusAtlasLabel; //! Pointer to composer view diff --git a/src/app/composer/qgscomposerarrowwidget.h b/src/app/composer/qgscomposerarrowwidget.h index 0497de69861..e4ae878d1df 100644 --- a/src/app/composer/qgscomposerarrowwidget.h +++ b/src/app/composer/qgscomposerarrowwidget.h @@ -37,7 +37,7 @@ class QgsComposerArrowWidget: public QgsComposerItemBaseWidget, private Ui::QgsC QButtonGroup* mRadioButtonGroup; - /** Enables / disables the SVG line inputs*/ + //! Enables / disables the SVG line inputs void enableSvgInputElements( bool enable ); void updateLineSymbolMarker(); diff --git a/src/app/composer/qgscomposerattributetablewidget.h b/src/app/composer/qgscomposerattributetablewidget.h index e5d1431df08..104dbbf7e66 100644 --- a/src/app/composer/qgscomposerattributetablewidget.h +++ b/src/app/composer/qgscomposerattributetablewidget.h @@ -35,7 +35,7 @@ class QgsComposerAttributeTableWidget: public QgsComposerItemBaseWidget, private QgsComposerAttributeTableV2* mComposerTable; QgsComposerFrame* mFrame; - /** Blocks / unblocks the signals of all GUI elements*/ + //! Blocks / unblocks the signals of all GUI elements void blockAllSignals( bool b ); void toggleSourceControls(); @@ -80,10 +80,10 @@ class QgsComposerAttributeTableWidget: public QgsComposerItemBaseWidget, private void on_mWrapBehaviourComboBox_currentIndexChanged( int index ); void on_mAdvancedCustomisationButton_clicked(); - /** Inserts a new maximum number of features into the spin box (without the spinbox emitting a signal)*/ + //! Inserts a new maximum number of features into the spin box (without the spinbox emitting a signal) void setMaximumNumberOfFeatures( int n ); - /** Sets the GUI elements to the values of mComposerTable*/ + //! Sets the GUI elements to the values of mComposerTable void updateGuiElements(); void atlasToggled(); diff --git a/src/app/composer/qgscomposerhtmlwidget.h b/src/app/composer/qgscomposerhtmlwidget.h index 3807e714439..3370caa4f0d 100644 --- a/src/app/composer/qgscomposerhtmlwidget.h +++ b/src/app/composer/qgscomposerhtmlwidget.h @@ -50,11 +50,11 @@ class QgsComposerHtmlWidget: public QgsComposerItemBaseWidget, private Ui::QgsCo void on_mEmptyFrameCheckBox_toggled( bool checked ); void on_mHideEmptyBgCheckBox_toggled( bool checked ); - /** Sets the GUI elements to the values of mHtmlItem*/ + //! Sets the GUI elements to the values of mHtmlItem void setGuiElementValues(); protected slots: - /** Initializes data defined buttons to current atlas coverage layer*/ + //! Initializes data defined buttons to current atlas coverage layer void populateDataDefinedButtons(); private: diff --git a/src/app/composer/qgscomposeritemwidget.h b/src/app/composer/qgscomposeritemwidget.h index defdec92514..012bb252680 100644 --- a/src/app/composer/qgscomposeritemwidget.h +++ b/src/app/composer/qgscomposeritemwidget.h @@ -56,7 +56,7 @@ class QgsComposerConfigObject: public QObject QgsComposerConfigObject( QWidget* parent, QgsComposerObject* composerObject ); ~QgsComposerConfigObject(); - /** Sets a data defined property for the item from its current data defined button settings*/ + //! Sets a data defined property for the item from its current data defined button settings void setDataDefinedProperty( const QgsDataDefinedButton *ddBtn, QgsComposerObject::DataDefinedProperty p ); /** Registers a data defined button, setting up its initial value, connections and description. @@ -68,14 +68,14 @@ class QgsComposerConfigObject: public QObject void registerDataDefinedButton( QgsDataDefinedButton* button, QgsComposerObject::DataDefinedProperty property, QgsDataDefinedButton::DataType type, const QString& description ); - /** Returns the current atlas coverage layer (if set)*/ + //! Returns the current atlas coverage layer (if set) QgsVectorLayer* atlasCoverageLayer() const; - /** Returns the atlas for the composition*/ + //! Returns the atlas for the composition QgsAtlasComposition *atlasComposition() const; private slots: - /** Must be called when a data defined button changes*/ + //! Must be called when a data defined button changes void updateDataDefinedProperty(); //! Updates data defined buttons to reflect current state of atlas (eg coverage layer) @@ -108,10 +108,10 @@ class QgsComposerItemBaseWidget: public QgsPanelWidget void registerDataDefinedButton( QgsDataDefinedButton* button, QgsComposerObject::DataDefinedProperty property, QgsDataDefinedButton::DataType type, const QString& description ); - /** Returns the current atlas coverage layer (if set)*/ + //! Returns the current atlas coverage layer (if set) QgsVectorLayer* atlasCoverageLayer() const; - /** Returns the atlas for the composition*/ + //! Returns the atlas for the composition QgsAtlasComposition *atlasComposition() const; private: @@ -128,12 +128,12 @@ class QgsComposerItemWidget: public QWidget, private Ui::QgsComposerItemWidgetBa QgsComposerItemWidget( QWidget* parent, QgsComposerItem* item ); ~QgsComposerItemWidget(); - /** A combination of upper/middle/lower and left/middle/right*/ + //! A combination of upper/middle/lower and left/middle/right QgsComposerItem::ItemPositionMode positionMode() const; - /** Toggles display of the background group*/ + //! Toggles display of the background group void showBackgroundGroup( bool showGroup ); - /** Toggles display of the frame group*/ + //! Toggles display of the frame group void showFrameGroup( bool showGroup ); public slots: @@ -183,7 +183,7 @@ class QgsComposerItemWidget: public QWidget, private Ui::QgsComposerItemWidgetBa void setValuesForGuiNonPositionElements(); protected slots: - /** Initializes data defined buttons to current atlas coverage layer*/ + //! Initializes data defined buttons to current atlas coverage layer void populateDataDefinedButtons(); private: diff --git a/src/app/composer/qgscomposerlegenditemdialog.h b/src/app/composer/qgscomposerlegenditemdialog.h index c0f653608f4..4e6b54e3554 100644 --- a/src/app/composer/qgscomposerlegenditemdialog.h +++ b/src/app/composer/qgscomposerlegenditemdialog.h @@ -34,7 +34,7 @@ class QgsComposerLegendItemDialog: public QDialog, private Ui::QgsComposerLegend QgsComposerLegendItemDialog( const QStandardItem* item, QWidget* parent = nullptr ); ~QgsComposerLegendItemDialog(); - /** Returns the item text inserted by user*/ + //! Returns the item text inserted by user QString itemText() const; private: diff --git a/src/app/composer/qgscomposerlegendlayersdialog.h b/src/app/composer/qgscomposerlegendlayersdialog.h index 0a9f3e3d439..9ead16a66f4 100644 --- a/src/app/composer/qgscomposerlegendlayersdialog.h +++ b/src/app/composer/qgscomposerlegendlayersdialog.h @@ -34,7 +34,7 @@ class QgsComposerLegendLayersDialog: public QDialog, private Ui::QgsComposerLege private: QgsComposerLegendLayersDialog(); //forbidden - /** Stores the relation between items and map layer pointers. */ + //! Stores the relation between items and map layer pointers. QMap mItemLayerMap; }; diff --git a/src/app/composer/qgscomposerlegendwidget.h b/src/app/composer/qgscomposerlegendwidget.h index 4179c011665..b99f77af340 100644 --- a/src/app/composer/qgscomposerlegendwidget.h +++ b/src/app/composer/qgscomposerlegendwidget.h @@ -37,7 +37,7 @@ class QgsComposerLegendWidget: public QgsComposerItemBaseWidget, private Ui::Qgs explicit QgsComposerLegendWidget( QgsComposerLegend* legend ); ~QgsComposerLegendWidget(); - /** Updates the legend layers and groups*/ + //! Updates the legend layers and groups void updateLegend(); QgsComposerLegend* legend() { return mLegend; } @@ -94,10 +94,10 @@ class QgsComposerLegendWidget: public QgsComposerItemBaseWidget, private Ui::Qgs void setCurrentNodeStyleFromAction(); private slots: - /** Sets GUI according to state of mLegend*/ + //! Sets GUI according to state of mLegend void setGuiElements(); - /** Update the enabling state of the filter by atlas button */ + //! Update the enabling state of the filter by atlas button void updateFilterLegendByAtlasButton(); void on_mItemTreeView_doubleClicked( const QModelIndex &index ); diff --git a/src/app/composer/qgscomposermanager.h b/src/app/composer/qgscomposermanager.h index a1d8d3fdb14..75e1ab5b944 100644 --- a/src/app/composer/qgscomposermanager.h +++ b/src/app/composer/qgscomposermanager.h @@ -24,7 +24,7 @@ class QListWidgetItem; class QgsComposer; -/** Delegate for a line edit for renaming a composer. Prevents entry of duplicate composer names.*/ +//! Delegate for a line edit for renaming a composer. Prevents entry of duplicate composer names. class QgsComposerNameDelegate : public QItemDelegate { Q_OBJECT @@ -55,7 +55,7 @@ class QgsComposerManager: public QDialog, private Ui::QgsComposerManagerBase void addTemplates( const QMap& templates ); public slots: - /** Raise, unminimize and activate this window */ + //! Raise, unminimize and activate this window void activate(); private: @@ -90,24 +90,24 @@ class QgsComposerManager: public QDialog, private Ui::QgsComposerManagerBase #endif private slots: - /** Slot to update buttons state when selecting compositions */ + //! Slot to update buttons state when selecting compositions void toggleButtons(); void on_mAddButton_clicked(); - /** Slot to track combobox to use specific template path */ + //! Slot to track combobox to use specific template path void on_mTemplate_currentIndexChanged( int indx ); - /** Slot to choose path to template */ + //! Slot to choose path to template void on_mTemplatePathBtn_pressed(); - /** Slot to open default templates dir with user's system */ + //! Slot to open default templates dir with user's system void on_mTemplatesDefaultDirBtn_pressed(); - /** Slot to open user templates dir with user's system */ + //! Slot to open user templates dir with user's system void on_mTemplatesUserDirBtn_pressed(); - /** Refreshes the list of composers */ + //! Refreshes the list of composers void refreshComposers(); void remove_clicked(); void show_clicked(); - /** Duplicate composer */ + //! Duplicate composer void duplicate_clicked(); void rename_clicked(); void on_mComposerListWidget_itemChanged( QListWidgetItem * item ); diff --git a/src/app/composer/qgscomposermapgridwidget.h b/src/app/composer/qgscomposermapgridwidget.h index b4c55073160..27b1a5ee8ae 100644 --- a/src/app/composer/qgscomposermapgridwidget.h +++ b/src/app/composer/qgscomposermapgridwidget.h @@ -93,16 +93,16 @@ class QgsComposerMapGridWidget: public QgsComposerItemBaseWidget, private Ui::Qg protected: - /** Sets the current composer map values to the GUI elements*/ + //! Sets the current composer map values to the GUI elements virtual void updateGuiElements(); protected slots: - /** Initializes data defined buttons to current atlas coverage layer*/ + //! Initializes data defined buttons to current atlas coverage layer void populateDataDefinedButtons(); private slots: - /** Sets the GUI elements to the values of mPicture*/ + //! Sets the GUI elements to the values of mPicture void setGuiElementValues(); void updateGridLineStyleFromWidget(); @@ -114,7 +114,7 @@ class QgsComposerMapGridWidget: public QgsComposerItemBaseWidget, private Ui::Qg QgsComposerMap* mComposerMap; QgsComposerMapGrid* mComposerMapGrid; - /** Blocks / unblocks the signals of all GUI elements*/ + //! Blocks / unblocks the signals of all GUI elements void blockAllSignals( bool b ); void handleChangedFrameDisplay( QgsComposerMapGrid::BorderSide border, const QgsComposerMapGrid::DisplayMode mode ); @@ -135,10 +135,10 @@ class QgsComposerMapGridWidget: public QgsComposerItemBaseWidget, private Ui::Qg void updateGridLineSymbolMarker(); void updateGridMarkerSymbolMarker(); - /** Enables/disables grid frame related controls*/ + //! Enables/disables grid frame related controls void toggleFrameControls( bool frameEnabled, bool frameFillEnabled, bool frameSizeEnabled ); - /** Is there some predefined scales, globally or as project's options ?*/ + //! Is there some predefined scales, globally or as project's options ? bool hasPredefinedScales() const; }; diff --git a/src/app/composer/qgscomposermapwidget.h b/src/app/composer/qgscomposermapwidget.h index e89bbcc7389..4390356f554 100644 --- a/src/app/composer/qgscomposermapwidget.h +++ b/src/app/composer/qgscomposermapwidget.h @@ -93,22 +93,22 @@ class QgsComposerMapWidget: public QgsComposerItemBaseWidget, private Ui::QgsCom void addPageToToolbox( QWidget * widget, const QString& name ); - /** Sets the current composer map values to the GUI elements*/ + //! Sets the current composer map values to the GUI elements virtual void updateGuiElements(); protected slots: - /** Initializes data defined buttons to current atlas coverage layer*/ + //! Initializes data defined buttons to current atlas coverage layer void populateDataDefinedButtons(); private slots: - /** Sets the GUI elements to the values of mPicture*/ + //! Sets the GUI elements to the values of mPicture void setGuiElementValues(); - /** Enables or disables the atlas margin around feature option depending on coverage layer type*/ + //! Enables or disables the atlas margin around feature option depending on coverage layer type void atlasLayerChanged( QgsVectorLayer* layer ); - /** Enables or disables the atlas controls when composer atlas is toggled on/off*/ + //! Enables or disables the atlas controls when composer atlas is toggled on/off void compositionAtlasToggled( bool atlasEnabled ); void aboutToShowKeepLayersVisibilityPresetsMenu(); @@ -124,10 +124,10 @@ class QgsComposerMapWidget: public QgsComposerItemBaseWidget, private Ui::QgsCom private: QgsComposerMap* mComposerMap; - /** Sets extent of composer map from line edits*/ + //! Sets extent of composer map from line edits void updateComposerExtentFromGui(); - /** Blocks / unblocks the signals of all GUI elements*/ + //! Blocks / unblocks the signals of all GUI elements void blockAllSignals( bool b ); void handleChangedFrameDisplay( QgsComposerMapGrid::BorderSide border, const QgsComposerMapGrid::DisplayMode mode ); @@ -145,13 +145,13 @@ class QgsComposerMapWidget: public QgsComposerItemBaseWidget, private Ui::QgsCom void initAnnotationPositionBox( QComboBox* c, QgsComposerMapGrid::AnnotationPosition pos ); void initAnnotationDirectionBox( QComboBox* c, QgsComposerMapGrid::AnnotationDirection dir ); - /** Enables or disables the atlas margin and predefined scales radio depending on the atlas coverage layer type*/ + //! Enables or disables the atlas margin and predefined scales radio depending on the atlas coverage layer type void toggleAtlasScalingOptionsByLayerType(); - /** Recalculates the bounds for an atlas map when atlas properties change*/ + //! Recalculates the bounds for an atlas map when atlas properties change void updateMapForAtlas(); - /** Is there some predefined scales, globally or as project's options ?*/ + //! Is there some predefined scales, globally or as project's options ? bool hasPredefinedScales() const; QListWidgetItem* addGridListItem( const QString& id, const QString& name ); diff --git a/src/app/composer/qgscomposerpicturewidget.h b/src/app/composer/qgscomposerpicturewidget.h index 4f6eaf4466f..442819a5b1b 100644 --- a/src/app/composer/qgscomposerpicturewidget.h +++ b/src/app/composer/qgscomposerpicturewidget.h @@ -34,7 +34,7 @@ class QgsComposerPictureWidget: public QgsComposerItemBaseWidget, private Ui::Qg explicit QgsComposerPictureWidget( QgsComposerPicture* picture ); ~QgsComposerPictureWidget(); - /** Add the icons of the standard directories to the preview*/ + //! Add the icons of the standard directories to the preview void addStandardDirectoriesToPreview(); public slots: @@ -53,14 +53,14 @@ class QgsComposerPictureWidget: public QgsComposerItemBaseWidget, private Ui::Qg void resizeEvent( QResizeEvent * event ) override; protected slots: - /** Initializes data defined buttons to current atlas coverage layer*/ + //! Initializes data defined buttons to current atlas coverage layer void populateDataDefinedButtons(); private slots: - /** Sets the GUI elements to the values of mPicture*/ + //! Sets the GUI elements to the values of mPicture void setGuiElementValues(); - /** Sets the picture rotation GUI control value*/ + //! Sets the picture rotation GUI control value void setPicRotationSpinValue( double r ); /** Load SVG and pixel-based image previews @@ -75,15 +75,15 @@ class QgsComposerPictureWidget: public QgsComposerItemBaseWidget, private Ui::Qg private: QgsComposerPicture* mPicture; - /** Whether the picture selection previews have been loaded */ + //! Whether the picture selection previews have been loaded bool mPreviewsLoaded; - /** Add the icons of a directory to the preview. Returns 0 in case of success*/ + //! Add the icons of a directory to the preview. Returns 0 in case of success int addDirectoryToPreview( const QString& path ); - /** Tests if a file is valid svg*/ + //! Tests if a file is valid svg bool testSvgFile( const QString& filename ) const; - /** Tests if a file is a valid pixel format*/ + //! Tests if a file is a valid pixel format bool testImageFile( const QString& filename ) const; //! Renders an svg file to a QIcon, correctly handling any SVG parameters present in the file diff --git a/src/app/composer/qgscomposerpolygonwidget.h b/src/app/composer/qgscomposerpolygonwidget.h index 96e3a362021..83431611a3a 100644 --- a/src/app/composer/qgscomposerpolygonwidget.h +++ b/src/app/composer/qgscomposerpolygonwidget.h @@ -41,7 +41,7 @@ class QgsComposerPolygonWidget: public QgsComposerItemBaseWidget, private Ui::Qg private slots: void on_mPolygonStyleButton_clicked(); - /** Sets the GUI elements to the currentValues of mComposerShape*/ + //! Sets the GUI elements to the currentValues of mComposerShape void setGuiElementValues(); void updateStyleFromWidget(); diff --git a/src/app/composer/qgscomposerpolylinewidget.h b/src/app/composer/qgscomposerpolylinewidget.h index b74a8b699f0..75259127346 100644 --- a/src/app/composer/qgscomposerpolylinewidget.h +++ b/src/app/composer/qgscomposerpolylinewidget.h @@ -41,7 +41,7 @@ class QgsComposerPolylineWidget: public QgsComposerItemBaseWidget, private Ui::Q private slots: void on_mLineStyleButton_clicked(); - /** Sets the GUI elements to the currentValues of mComposerShape*/ + //! Sets the GUI elements to the currentValues of mComposerShape void setGuiElementValues(); void updateStyleFromWidget(); diff --git a/src/app/composer/qgscomposerscalebarwidget.h b/src/app/composer/qgscomposerscalebarwidget.h index 7a2872da3f2..0d1bc4945f1 100644 --- a/src/app/composer/qgscomposerscalebarwidget.h +++ b/src/app/composer/qgscomposerscalebarwidget.h @@ -66,10 +66,10 @@ class QgsComposerScaleBarWidget: public QgsComposerItemBaseWidget, private Ui::Q QgsComposerScaleBar* mComposerScaleBar; QButtonGroup mSegmentSizeRadioGroup; - /** Enables/disables the signals of the input gui elements*/ + //! Enables/disables the signals of the input gui elements void blockMemberSignals( bool enable ); - /** Enables/disables controls based on scale bar style*/ + //! Enables/disables controls based on scale bar style void toggleStyleSpecificControls( const QString& style ); void connectUpdateSignal(); diff --git a/src/app/composer/qgscomposershapewidget.h b/src/app/composer/qgscomposershapewidget.h index 21b86ea55ba..7742d828c6b 100644 --- a/src/app/composer/qgscomposershapewidget.h +++ b/src/app/composer/qgscomposershapewidget.h @@ -23,7 +23,7 @@ class QgsComposerShape; -/** Input widget for QgsComposerShape*/ +//! Input widget for QgsComposerShape class QgsComposerShapeWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerShapeWidgetBase { Q_OBJECT @@ -34,7 +34,7 @@ class QgsComposerShapeWidget: public QgsComposerItemBaseWidget, private Ui::QgsC private: QgsComposerShape* mComposerShape; - /** Blocks / unblocks the signal of all GUI elements*/ + //! Blocks / unblocks the signal of all GUI elements void blockAllSignals( bool block ); private slots: @@ -42,12 +42,12 @@ class QgsComposerShapeWidget: public QgsComposerItemBaseWidget, private Ui::QgsC void on_mCornerRadiusSpinBox_valueChanged( double val ); void on_mShapeStyleButton_clicked(); - /** Sets the GUI elements to the currentValues of mComposerShape*/ + //! Sets the GUI elements to the currentValues of mComposerShape void setGuiElementValues(); void updateShapeStyle(); - /** Enables or disables the rounded radius spin box based on shape type*/ + //! Enables or disables the rounded radius spin box based on shape type void toggleRadiusSpin( const QString& shapeText ); void updateSymbolFromWidget(); void cleanUpSymbolSelector( QgsPanelWidget* container ); diff --git a/src/app/composer/qgscomposertablebackgroundcolorsdialog.h b/src/app/composer/qgscomposertablebackgroundcolorsdialog.h index 54da619dbf0..575191998e5 100644 --- a/src/app/composer/qgscomposertablebackgroundcolorsdialog.h +++ b/src/app/composer/qgscomposertablebackgroundcolorsdialog.h @@ -56,7 +56,7 @@ class QgsComposerTableBackgroundColorsDialog: public QDialog, private Ui::QgsCom QMap< QgsComposerTableV2::CellStyleGroup, QgsColorButton* > mColorButtonMap; - /** Sets the GUI elements to the values of the table*/ + //! Sets the GUI elements to the values of the table void setGuiElementValues(); diff --git a/src/app/composer/qgscompositionwidget.h b/src/app/composer/qgscompositionwidget.h index 4d75ce65701..70e9daae9e8 100644 --- a/src/app/composer/qgscompositionwidget.h +++ b/src/app/composer/qgscompositionwidget.h @@ -61,23 +61,23 @@ class QgsCompositionWidget: public QgsPanelWidget, private Ui::QgsCompositionWid void on_mOffsetYSpinBox_valueChanged( double d ); void on_mSnapToleranceSpinBox_valueChanged( int tolerance ); - /** Sets GUI elements to width/height from composition*/ + //! Sets GUI elements to width/height from composition void displayCompositionWidthHeight(); - /** Sets Print as raster checkbox value*/ + //! Sets Print as raster checkbox value void setPrintAsRasterCheckBox( bool state ); - /** Sets number of pages spin box value*/ + //! Sets number of pages spin box value void setNumberPages(); signals: - /** Is emitted when page orientation changes*/ + //! Is emitted when page orientation changes void pageOrientationChanged( const QString& orientation ); private slots: - /** Must be called when a data defined button changes*/ + //! Must be called when a data defined button changes void updateDataDefinedProperty(); - /** Initializes data defined buttons to current atlas coverage layer*/ + //! Initializes data defined buttons to current atlas coverage layer void populateDataDefinedButtons(); void variablesChanged(); @@ -94,13 +94,13 @@ class QgsCompositionWidget: public QgsPanelWidget, private Ui::QgsCompositionWid QMap mPaperMap; QgsCompositionWidget(); //default constructor is forbidden - /** Sets width/height to chosen paper format and updates paper item*/ + //! Sets width/height to chosen paper format and updates paper item void applyCurrentPaperSettings(); - /** Applies the current width and height values*/ + //! Applies the current width and height values void applyWidthHeight(); - /** Makes sure width/height values for custom paper matches the current orientation*/ + //! Makes sure width/height values for custom paper matches the current orientation void adjustOrientation(); - /** Sets GUI elements to snaping distances of composition*/ + //! Sets GUI elements to snaping distances of composition void displaySnapingSettings(); void updatePageStyle(); @@ -110,13 +110,13 @@ class QgsCompositionWidget: public QgsPanelWidget, private Ui::QgsCompositionWid double size( QDoubleSpinBox *spin ); void setSize( QDoubleSpinBox *spin, double v ); - /** Blocks / unblocks the signals of all items*/ + //! Blocks / unblocks the signals of all items void blockSignals( bool block ); - /** Sets a data defined property for the item from its current data defined button settings*/ + //! Sets a data defined property for the item from its current data defined button settings void setDataDefinedProperty( const QgsDataDefinedButton *ddBtn, QgsComposerObject::DataDefinedProperty property ); - /** Returns the data defined property corresponding to a data defined button widget*/ + //! Returns the data defined property corresponding to a data defined button widget virtual QgsComposerObject::DataDefinedProperty ddPropertyForWidget( QgsDataDefinedButton* widget ); diff --git a/src/app/legend/qgsapplegendinterface.h b/src/app/legend/qgsapplegendinterface.h index 6a2ae34ec51..481e1c0f8c0 100644 --- a/src/app/legend/qgsapplegendinterface.h +++ b/src/app/legend/qgsapplegendinterface.h @@ -37,10 +37,10 @@ class QgsAppLegendInterface : public QgsLegendInterface public: - /** Constructor */ + //! Constructor explicit QgsAppLegendInterface( QgsLayerTreeView * layerTreeView ); - /** Destructor */ + //! Destructor ~QgsAppLegendInterface(); //! Return a string list of groups diff --git a/src/app/nodetool/qgsmaptoolnodetool.h b/src/app/nodetool/qgsmaptoolnodetool.h index 4fc3858943f..c7c607d0628 100644 --- a/src/app/nodetool/qgsmaptoolnodetool.h +++ b/src/app/nodetool/qgsmaptoolnodetool.h @@ -26,7 +26,7 @@ class QgsVertexEntry; class QgsSelectedFeature; class QgsNodeEditor; -/** A maptool to move/deletes/adds vertices of line or polygon features*/ +//! A maptool to move/deletes/adds vertices of line or polygon features class QgsMapToolNodeTool: public QgsMapToolEdit { Q_OBJECT @@ -138,46 +138,46 @@ class QgsMapToolNodeTool: public QgsMapToolEdit and applies it to the map canvas*/ QgsMapCanvasSnapper mSnapper; - /** Rubber bands during node move */ + //! Rubber bands during node move QMap mMoveRubberBands; - /** Rubber band for selected feature */ + //! Rubber band for selected feature QgsGeometryRubberBand* mSelectRubberBand; - /** Vertices of features to move */ + //! Vertices of features to move QMap > > mMoveVertices; - /** Object containing selected feature and it's vertexes */ + //! Object containing selected feature and it's vertexes QgsSelectedFeature *mSelectedFeature; - /** Dock widget which allows editing vertices */ + //! Dock widget which allows editing vertices QgsNodeEditor* mNodeEditor; - /** Flag if moving of vertexes is occurring */ + //! Flag if moving of vertexes is occurring bool mMoving; - /** Flag if selection of another feature can occur */ + //! Flag if selection of another feature can occur bool mSelectAnother; - /** Feature id of another feature where user clicked */ + //! Feature id of another feature where user clicked QgsFeatureId mAnother; - /** Stored position of last press down action to count how much vertexes should be moved */ + //! Stored position of last press down action to count how much vertexes should be moved QPoint mPressCoordinates; - /** Closest vertex to click in map coordinates */ + //! Closest vertex to click in map coordinates QgsPoint mClosestMapVertex; - /** Active rubberband for selecting vertexes */ + //! Active rubberband for selecting vertexes QRubberBand *mSelectionRubberBand; - /** Rectangle defining area for selecting vertexes */ + //! Rectangle defining area for selecting vertexes QRect* mRect; - /** Flag to tell if edition points */ + //! Flag to tell if edition points bool mIsPoint; - /** Vertex to deselect on release */ + //! Vertex to deselect on release int mDeselectOnRelease; }; diff --git a/src/app/ogr/qgsnewogrconnection.cpp b/src/app/ogr/qgsnewogrconnection.cpp index a387e91015b..dd7058c03df 100644 --- a/src/app/ogr/qgsnewogrconnection.cpp +++ b/src/app/ogr/qgsnewogrconnection.cpp @@ -100,7 +100,7 @@ void QgsNewOgrConnection::testConnection() } } -/** Autoconnected SLOTS **/ +//! Autoconnected SLOTS * void QgsNewOgrConnection::accept() { QSettings settings; @@ -140,4 +140,4 @@ void QgsNewOgrConnection::on_btnConnect_clicked() testConnection(); } -/** End Autoconnected SLOTS **/ +//! End Autoconnected SLOTS * diff --git a/src/app/ogr/qgsvectorlayersaveasdialog.h b/src/app/ogr/qgsvectorlayersaveasdialog.h index f7d71ed713e..e809b68c746 100644 --- a/src/app/ogr/qgsvectorlayersaveasdialog.h +++ b/src/app/ogr/qgsvectorlayersaveasdialog.h @@ -53,7 +53,7 @@ class APP_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec QStringList layerOptions() const; long crs() const; QgsAttributeList selectedAttributes() const; - /** Return selected attributes that must be exported with their displayed values instead of their raw values. Added in QGIS 2.16 */ + //! Return selected attributes that must be exported with their displayed values instead of their raw values. Added in QGIS 2.16 QgsAttributeList attributesAsDisplayedValues() const; bool addToCanvas() const; /** Returns type of symbology export. @@ -101,7 +101,7 @@ class APP_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec */ void setIncludeZ( bool checked ); - /** Returns creation action */ + //! Returns creation action QgsVectorFileWriter::ActionOnExistingFile creationActionOnExistingFile() const; private slots: diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp index 1b43237b6d9..1e5251eeb46 100644 --- a/src/app/qgisapp.cpp +++ b/src/app/qgisapp.cpp @@ -9255,13 +9255,13 @@ void QgisApp::unregisterMapLayerPropertiesFactory( QgsMapLayerConfigWidgetFactor mMapStyleWidget->setPageFactories( mMapLayerPanelFactories ); } -/** Get a pointer to the currently selected map layer */ +//! Get a pointer to the currently selected map layer QgsMapLayer *QgisApp::activeLayer() { return mLayerTreeView ? mLayerTreeView->currentLayer() : nullptr; } -/** Set the current layer */ +//! Set the current layer bool QgisApp::setActiveLayer( QgsMapLayer *layer ) { if ( !layer ) diff --git a/src/app/qgisapp.h b/src/app/qgisapp.h index 26b15e59b46..bd2a46c24ad 100644 --- a/src/app/qgisapp.h +++ b/src/app/qgisapp.h @@ -183,10 +183,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ QString crsAndFormatAdjustedLayerUri( const QString& uri, const QStringList& supportedCrs, const QStringList& supportedFormats ) const; - /** Add a 'pre-made' map layer to the project */ + //! Add a 'pre-made' map layer to the project void addMapLayer( QgsMapLayer *theMapLayer ); - /** Set the extents of the map canvas */ + //! Set the extents of the map canvas void setExtent( const QgsRectangle& theRect ); //! Remove all layers from the map and legend - reimplements same method from qgisappbase void removeAllLayers(); @@ -217,16 +217,16 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //!Overloaded version of the private function with same name that takes the imagename as a parameter void saveMapAsImage( const QString&, QPixmap * ); - /** Get the mapcanvas object from the app */ + //! Get the mapcanvas object from the app QgsMapCanvas *mapCanvas(); - /** Return the messageBar object which allows displaying unobtrusive messages to the user.*/ + //! Return the messageBar object which allows displaying unobtrusive messages to the user. QgsMessageBar *messageBar(); - /** Open the message log dock widget **/ + //! Open the message log dock widget * void openMessageLog(); - /** Adds a widget to the user input tool bar.*/ + //! Adds a widget to the user input tool bar. void addUserInputWidget( QWidget* widget ); //! Set theme (icons) @@ -278,7 +278,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * windows which are hidden rather than deleted when closed. */ void removeWindow( QAction *action ); - /** Returns the print composers*/ + //! Returns the print composers QSet printComposers() const {return mPrintComposers;} /** Get a unique title from user for new and duplicate composers * @param acceptEmpty whether to accept empty titles (one will be generated) @@ -286,15 +286,15 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * @return QString::null if user cancels input dialog */ bool uniqueComposerTitle( QWidget *parent, QString& composerTitle, bool acceptEmpty, const QString& currentTitle = QString() ); - /** Creates a new composer and returns a pointer to it*/ + //! Creates a new composer and returns a pointer to it QgsComposer* createNewComposer( QString title = QString() ); - /** Deletes a composer and removes entry from Set*/ + //! Deletes a composer and removes entry from Set void deleteComposer( QgsComposer *c ); /** Duplicates a composer and adds it to Set */ QgsComposer *duplicateComposer( QgsComposer *currentComposer, QString title = QString() ); - /** Overloaded function used to sort menu entries alphabetically */ + //! Overloaded function used to sort menu entries alphabetically QMenu* createPopupMenu() override; /** @@ -388,7 +388,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow QAction *actionLayerSaveAs() { return mActionLayerSaveAs; } QAction *actionRemoveLayer() { return mActionRemoveLayer; } QAction *actionDuplicateLayer() { return mActionDuplicateLayer; } - /** @note added in 2.4 */ + //! @note added in 2.4 QAction *actionSetLayerScaleVisibility() { return mActionSetLayerScaleVisibility; } QAction *actionSetLayerCrs() { return mActionSetLayerCRS; } QAction *actionSetProjectCrsFromLayer() { return mActionSetProjectCRSFromLayer; } @@ -493,7 +493,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * @returns list of layers in legend order, or empty list */ QList editableLayers( bool modified = false ) const; - /** Get timeout for timed messages: default of 5 seconds */ + //! Get timeout for timed messages: default of 5 seconds int messageTimeout(); //! emit initializationCompleted signal @@ -504,7 +504,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow QList decorationItems() { return mDecorationItems; } void addDecorationItem( QgsDecorationItem *item ) { mDecorationItems.append( item ); } - /** @note added in 2.1 */ + //! @note added in 2.1 static QString normalizedMenuName( const QString & name ) { return name.normalized( QString::NormalizationForm_KD ).remove( QRegExp( "[^a-zA-Z]" ) ); } #ifdef Q_OS_WIN @@ -513,19 +513,19 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void parseVersionInfo( QNetworkReply* reply, int& latestVersion, QStringList& versionInfo ); - /** Register a new tab in the layer properties dialog */ + //! Register a new tab in the layer properties dialog void registerMapLayerPropertiesFactory( QgsMapLayerConfigWidgetFactory* factory ); - /** Unregister a previously registered tab in the layer properties dialog */ + //! Unregister a previously registered tab in the layer properties dialog void unregisterMapLayerPropertiesFactory( QgsMapLayerConfigWidgetFactory* factory ); - /** Register a new custom drop handler. */ + //! Register a new custom drop handler. void registerCustomDropHandler( QgsCustomDropHandler* handler ); - /** Unregister a previously registered custom drop handler. */ + //! Unregister a previously registered custom drop handler. void unregisterCustomDropHandler( QgsCustomDropHandler* handler ); - /** Process the list of URIs that have been dropped in QGIS */ + //! Process the list of URIs that have been dropped in QGIS void handleDropUriList( const QgsMimeDataUtils::UriList& lst ); public slots: @@ -570,7 +570,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! starts/stops editing mode of a layer bool toggleEditing( QgsMapLayer *layer, bool allowCancel = true ); - /** Save edits for active vector layer and start new transactions */ + //! Save edits for active vector layer and start new transactions void saveActiveLayerEdits(); /** Save edits of a layer @@ -588,19 +588,19 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Save current edits for selected layer(s) and start new transaction(s) void saveEdits(); - /** Save edits for all layers and start new transactions */ + //! Save edits for all layers and start new transactions void saveAllEdits( bool verifyAction = true ); - /** Rollback current edits for selected layer(s) and start new transaction(s) */ + //! Rollback current edits for selected layer(s) and start new transaction(s) void rollbackEdits(); - /** Rollback edits for all layers and start new transactions */ + //! Rollback edits for all layers and start new transactions void rollbackAllEdits( bool verifyAction = true ); - /** Cancel edits for selected layer(s) and toggle off editing */ + //! Cancel edits for selected layer(s) and toggle off editing void cancelEdits(); - /** Cancel all edits for all layers and toggle off editing */ + //! Cancel all edits for all layers and toggle off editing void cancelAllEdits( bool verifyAction = true ); void updateUndoActions(); @@ -644,7 +644,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void copyFeatures( QgsFeatureStore & featureStore ); void loadGDALSublayers( const QString& uri, const QStringList& list ); - /** Deletes the selected attributes for the currently selected vector layer*/ + //! Deletes the selected attributes for the currently selected vector layer void deleteSelected( QgsMapLayer *layer = nullptr, QWidget *parent = nullptr, bool promptConfirmation = false ); //! project was written @@ -679,10 +679,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Watch for QFileOpenEvent. virtual bool event( QEvent *event ) override; - /** Open a raster layer using the Raster Data Provider. */ + //! Open a raster layer using the Raster Data Provider. QgsRasterLayer *addRasterLayer( QString const & uri, QString const & baseName, QString const & providerKey ); - /** Open a plugin layer using its provider */ + //! Open a plugin layer using its provider QgsPluginLayer* addPluginLayer( const QString& uri, const QString& baseName, const QString& providerKey ); void addWfsLayer( const QString& uri, const QString& typeName ); @@ -793,12 +793,12 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow Only workds on raster layers*/ void legendLayerStretchUsingCurrentExtent(); - /** Apply the same style to selected layers or to current legend group*/ + //! Apply the same style to selected layers or to current legend group void applyStyleToGroup(); - /** Set the CRS of the current legend group*/ + //! Set the CRS of the current legend group void legendGroupSetCrs(); - /** Set the WMS data of the current legend group*/ + //! Set the WMS data of the current legend group void legendGroupSetWmsData(); //! zoom to extent of layer @@ -813,9 +813,9 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * (stretch based on pixels values in full dataset) * Valid for non wms raster layers only. */ void fullHistogramStretch(); - /** Perform a local cumulative cut stretch */ + //! Perform a local cumulative cut stretch void localCumulativeCutStretch(); - /** Perform a full extent cumulative cut stretch */ + //! Perform a full extent cumulative cut stretch void fullCumulativeCutStretch(); /** Increase raster brightness * Valid for non wms raster layers only. */ @@ -960,9 +960,9 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void fileNewBlank(); //! As above but allows forcing without prompt and forcing blank project void fileNew( bool thePromptToSaveFlag, bool forceBlank = false ); - /** What type of project to open after launch */ + //! What type of project to open after launch void fileOpenAfterLaunch(); - /** After project read, set any auto-opened project as successful */ + //! After project read, set any auto-opened project as successful void fileOpenedOKAfterLaunch(); //! Create a new file from a template project bool fileNewFromTemplate( const QString& fileName ); @@ -1112,10 +1112,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! stop "busy" progress bar void canvasRefreshFinished(); - /** Dialog for verification of action on many edits */ + //! Dialog for verification of action on many edits bool verifyEditsActionDialog( const QString& act, const QString& upon ); - /** Update gui actions/menus when layers are modified */ + //! Update gui actions/menus when layers are modified void updateLayerModifiedActions(); //! change layer subset of current vector layer @@ -1130,10 +1130,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! change log message icon in statusbar void toggleLogMessageIcon( bool hasLogMessage ); - /** Called when some layer's editing mode was toggled on/off */ + //! Called when some layer's editing mode was toggled on/off void layerEditStateChanged(); - /** Update the label toolbar buttons */ + //! Update the label toolbar buttons void updateLabelToolButtons(); /** Activates or deactivates actions depending on the current maplayer type. @@ -1203,13 +1203,13 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void modifyAnnotation(); void reprojectAnnotations(); - /** Alerts user when labeling font for layer has not been found on system */ + //! Alerts user when labeling font for layer has not been found on system void labelingFontNotFound( QgsVectorLayer *vlayer, const QString& fontfamily ); - /** Alerts user when commit errors occurred */ + //! Alerts user when commit errors occurred void commitError( QgsVectorLayer *vlayer ); - /** Opens the labeling dialog for a layer when called from labelingFontNotFound alert */ + //! Opens the labeling dialog for a layer when called from labelingFontNotFound alert void labelingDialogFontNotFound( QAction *act ); //! shows label settings dialog (for labeling-ng) @@ -1266,10 +1266,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void writeAnnotationItemsToProject( QDomDocument& doc ); - /** Creates the composer instances in a project file and adds them to the menu*/ + //! Creates the composer instances in a project file and adds them to the menu bool loadComposersFromProject( const QDomDocument& doc ); - /** Slot to handle display of composers menu, e.g. sorting */ + //! Slot to handle display of composers menu, e.g. sorting void on_mPrintComposersMenu_aboutToShow(); bool loadAnnotationItemsFromProject( const QDomDocument& doc ); @@ -1333,10 +1333,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ void showStatisticsDockWidget(); - /** Pushes a layer error to the message bar */ + //! Pushes a layer error to the message bar void onLayerError( const QString& msg ); - /** Set the layer for the map style dock. Doesn't show the style dock */ + //! Set the layer for the map style dock. Doesn't show the style dock void setMapStyleDockLayer( QgsMapLayer *layer ); //! Handles processing of dropped mimedata @@ -1380,7 +1380,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow @note added in version 2.3*/ void composerRemoved( QgsComposerView* v ); - /** This signal is emitted when QGIS' initialization is complete */ + //! This signal is emitted when QGIS' initialization is complete void initializationCompleted(); void customCrsValidation( QgsCoordinateReferenceSystem &crs ); @@ -1415,7 +1415,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ bool addRasterLayer( QgsRasterLayer * theRasterLayer ); - /** Open a raster layer - this is the generic function which takes all parameters */ + //! Open a raster layer - this is the generic function which takes all parameters QgsRasterLayer* addRasterLayerPrivate( const QString & uri, const QString & baseName, const QString & providerKey, bool guiWarning, bool guiUpdate ); @@ -1439,7 +1439,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow @return empty geometry in case of error or if canceled */ QgsGeometry unionGeometries( const QgsVectorLayer* vl, QgsFeatureList& featureList, bool &canceled ); - /** Deletes all the composer objects and clears mPrintComposers*/ + //! Deletes all the composer objects and clears mPrintComposers void deletePrintComposers(); void saveAsVectorFileGeneral( QgsVectorLayer* vlayer = nullptr, bool symbologyOption = true ); @@ -1450,9 +1450,9 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ QgsVectorLayer * pasteToNewMemoryVector(); - /** Returns all annotation items in the canvas*/ + //! Returns all annotation items in the canvas QList annotationItems(); - /** Removes annotation items in the canvas*/ + //! Removes annotation items in the canvas void removeAnnotationItems(); //! Configure layer tree view according to the user options from QSettings @@ -1478,13 +1478,13 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void updateCrsStatusBar(); void createDecorations(); - /** Do histogram stretch for singleband gray / multiband color rasters*/ + //! Do histogram stretch for singleband gray / multiband color rasters void histogramStretch( bool visibleAreaOnly = false, QgsRaster::ContrastEnhancementLimits theLimits = QgsRaster::ContrastEnhancementMinMax ); - /** Apply raster brightness */ + //! Apply raster brightness void adjustBrightnessContrast( int delta, bool updateBrightness = true ); - /** Copy a vector style from a layer to another one, if they have the same geometry type */ + //! Copy a vector style from a layer to another one, if they have the same geometry type void duplicateVectorStyle( QgsVectorLayer* srcLayer, QgsVectorLayer* destLayer ); QgisAppStyleSheet *mStyleSheetBuilder; @@ -1695,7 +1695,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow QList mRecentProjects; //! Print composers of this project, accessible by id string QSet mPrintComposers; - /** QGIS-internal vector feature clipboard */ + //! QGIS-internal vector feature clipboard QgsClipboard *mInternalClipboard; //! Flag to indicate how the project properties dialog was summoned bool mShowProjectionTab; diff --git a/src/app/qgisappinterface.h b/src/app/qgisappinterface.h index 62e773bda07..14a790a903b 100644 --- a/src/app/qgisappinterface.h +++ b/src/app/qgisappinterface.h @@ -165,7 +165,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface #endif void openURL( const QString& url, bool useQgisDocDirectory = true ) override; - /** Return a pointer to the map canvas used by qgisapp */ + //! Return a pointer to the map canvas used by qgisapp QgsMapCanvas * mapCanvas() override; /** @@ -184,10 +184,10 @@ class APP_EXPORT QgisAppInterface : public QgisInterface QgsMessageBar * messageBar() override; - /** Open the message log dock widget **/ + //! Open the message log dock widget * void openMessageLog() override; - /** Adds a widget to the user input tool bar.*/ + //! Adds a widget to the user input tool bar. void addUserInputWidget( QWidget* widget ) override; // ### QGIS 3: return QgsComposer*, not QgsComposerView* @@ -210,56 +210,56 @@ class APP_EXPORT QgisAppInterface : public QgisInterface */ QgsComposerView* duplicateComposer( QgsComposerView* composerView, const QString& title = QString() ) override; - /** Deletes parent composer of composer view, after closing composer window */ + //! Deletes parent composer of composer view, after closing composer window void deleteComposer( QgsComposerView* composerView ) override; - /** Return changeable options built from settings and/or defaults */ + //! Return changeable options built from settings and/or defaults QMap defaultStyleSheetOptions() override; /** Generate stylesheet * @param opts generated default option values, or a changed copy of them */ void buildStyleSheet( const QMap& opts ) override; - /** Save changed default option keys/values to user settings */ + //! Save changed default option keys/values to user settings void saveStyleSheetOptions( const QMap& opts ) override; - /** Get reference font for initial qApp (may not be same as QgisApp) */ + //! Get reference font for initial qApp (may not be same as QgisApp) QFont defaultStyleSheetFont() override; - /** Add action to the plugins menu */ + //! Add action to the plugins menu void addPluginToMenu( const QString& name, QAction* action ) override; - /** Remove action from the plugins menu */ + //! Remove action from the plugins menu void removePluginMenu( const QString& name, QAction* action ) override; - /** Add action to the Database menu */ + //! Add action to the Database menu void addPluginToDatabaseMenu( const QString& name, QAction* action ) override; - /** Remove action from the Database menu */ + //! Remove action from the Database menu void removePluginDatabaseMenu( const QString& name, QAction* action ) override; - /** Add action to the Raster menu */ + //! Add action to the Raster menu void addPluginToRasterMenu( const QString& name, QAction* action ) override; - /** Remove action from the Raster menu */ + //! Remove action from the Raster menu void removePluginRasterMenu( const QString& name, QAction* action ) override; - /** Add action to the Vector menu */ + //! Add action to the Vector menu void addPluginToVectorMenu( const QString& name, QAction* action ) override; - /** Remove action from the Raster menu */ + //! Remove action from the Raster menu void removePluginVectorMenu( const QString& name, QAction* action ) override; - /** Add action to the Web menu */ + //! Add action to the Web menu void addPluginToWebMenu( const QString& name, QAction* action ) override; - /** Remove action from the Web menu */ + //! Remove action from the Web menu void removePluginWebMenu( const QString& name, QAction* action ) override; - /** Add "add layer" action to the layer menu */ + //! Add "add layer" action to the layer menu void insertAddLayerAction( QAction *action ) override; - /** Remove "add layer" action from the layer menu */ + //! Remove "add layer" action from the layer menu void removeAddLayerAction( QAction *action ) override; - /** Add a dock widget to the main window */ + //! Add a dock widget to the main window void addDockWidget( Qt::DockWidgetArea area, QDockWidget * dockwidget ) override; - /** Remove specified dock widget from main window (doesn't delete it). */ + //! Remove specified dock widget from main window (doesn't delete it). void removeDockWidget( QDockWidget * dockwidget ) override; //! return CAD dock widget @@ -282,10 +282,10 @@ class APP_EXPORT QgisAppInterface : public QgisInterface * windows which are hidden rather than deleted when closed. */ virtual void removeWindow( QAction *action ) override; - /** Register action to the shortcuts manager so its shortcut can be changed in GUI. */ + //! Register action to the shortcuts manager so its shortcut can be changed in GUI. virtual bool registerMainWindowAction( QAction* action, const QString& defaultShortcut ) override; - /** Unregister a previously registered action. (e.g. when plugin is going to be unloaded. */ + //! Unregister a previously registered action. (e.g. when plugin is going to be unloaded. virtual bool unregisterMainWindowAction( QAction* action ) override; /** Register a new tab in the vector layer properties dialog. @@ -408,9 +408,9 @@ class APP_EXPORT QgisAppInterface : public QgisInterface virtual QAction *actionAddRasterLayer() override; virtual QAction *actionAddPgLayer() override; virtual QAction *actionAddWmsLayer() override; - /** Get access to the native Add ArcGIS FeatureServer action. */ + //! Get access to the native Add ArcGIS FeatureServer action. virtual QAction *actionAddAfsLayer() override; - /** Get access to the native Add ArcGIS MapServer action. */ + //! Get access to the native Add ArcGIS MapServer action. virtual QAction *actionAddAmsLayer() override; virtual QAction *actionCopyLayerStyle() override; virtual QAction *actionPasteLayerStyle() override; @@ -500,7 +500,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface */ virtual QList editableLayers( bool modified = false ) const override; - /** Get timeout for timed messages: default of 5 seconds */ + //! Get timeout for timed messages: default of 5 seconds virtual int messageTimeout() override; signals: diff --git a/src/app/qgisappstylesheet.h b/src/app/qgisappstylesheet.h index 67f2418b23c..fc41601c159 100644 --- a/src/app/qgisappstylesheet.h +++ b/src/app/qgisappstylesheet.h @@ -33,7 +33,7 @@ class APP_EXPORT QgisAppStyleSheet: public QObject QgisAppStyleSheet( QObject * parent = nullptr ); ~QgisAppStyleSheet(); - /** Return changeable options built from settings and/or defaults */ + //! Return changeable options built from settings and/or defaults QMap defaultOptions(); /** Generate stylesheet @@ -42,10 +42,10 @@ class APP_EXPORT QgisAppStyleSheet: public QObject */ void buildStyleSheet( const QMap& opts ); - /** Save changed default option keys/values to user settings */ + //! Save changed default option keys/values to user settings void saveToSettings( const QMap& opts ); - /** Get reference font for initial qApp */ + //! Get reference font for initial qApp QFont defaultFont() { return mDefaultFont; } signals: @@ -55,7 +55,7 @@ class APP_EXPORT QgisAppStyleSheet: public QObject void appStyleSheetChanged( const QString& appStyleSheet ); private: - /** Set active configuration values */ + //! Set active configuration values void setActiveValues(); // qt styles diff --git a/src/app/qgsalignrasterdialog.cpp b/src/app/qgsalignrasterdialog.cpp index 14fb627beaa..33f82bfb329 100644 --- a/src/app/qgsalignrasterdialog.cpp +++ b/src/app/qgsalignrasterdialog.cpp @@ -55,7 +55,7 @@ static QString _rasterLayerName( const QString& filename ) -/** Helper class to report progress */ +//! Helper class to report progress struct QgsAlignRasterDialogProgress : public QgsAlignRaster::ProgressHandler { explicit QgsAlignRasterDialogProgress( QProgressBar* pb ) : mPb( pb ) {} diff --git a/src/app/qgsalignrasterdialog.h b/src/app/qgsalignrasterdialog.h index aefa9440cbd..e6cfe9fde30 100644 --- a/src/app/qgsalignrasterdialog.h +++ b/src/app/qgsalignrasterdialog.h @@ -21,7 +21,7 @@ class QgsAlignRaster; -/** Dialog providing user interface for QgsAlignRaster */ +//! Dialog providing user interface for QgsAlignRaster class QgsAlignRasterDialog : public QDialog, private Ui::QgsAlignRasterDialog { Q_OBJECT @@ -62,7 +62,7 @@ class QgsAlignRasterDialog : public QDialog, private Ui::QgsAlignRasterDialog class QgsMapLayerComboBox; class QCheckBox; -/** Simple dialog to display details of one layer's configuration */ +//! Simple dialog to display details of one layer's configuration class QgsAlignRasterLayerConfigDialog : public QDialog { Q_OBJECT diff --git a/src/app/qgsbrowserdockwidget.h b/src/app/qgsbrowserdockwidget.h index b2294d3dd8f..1117410d2cc 100644 --- a/src/app/qgsbrowserdockwidget.h +++ b/src/app/qgsbrowserdockwidget.h @@ -50,7 +50,7 @@ class QgsBrowserPropertiesWidget : public QWidget explicit QgsBrowserPropertiesWidget( QWidget* parent = nullptr ); static QgsBrowserPropertiesWidget* createWidget( QgsDataItem* item, QWidget* parent = nullptr ); virtual void setItem( QgsDataItem* item ) { Q_UNUSED( item ) } - /** Set content widget, usually item paramWidget. Takes ownership. */ + //! Set content widget, usually item paramWidget. Takes ownership. virtual void setWidget( QWidget* widget ); /** Sets whether the properties widget should display in condensed mode, ie, for display in a dock diff --git a/src/app/qgsclipboard.h b/src/app/qgsclipboard.h index acd8cbc4925..16b56fac6a7 100644 --- a/src/app/qgsclipboard.h +++ b/src/app/qgsclipboard.h @@ -57,9 +57,9 @@ class APP_EXPORT QgsClipboard : public QObject //! Available formats for copying features as text enum CopyFormat { - AttributesOnly, /*!< Tab delimited text, attributes only */ - AttributesWithWKT, /*!< Tab delimited text, with geometry in WKT format */ - GeoJSON, /*!< GeoJSON FeatureCollection format */ + AttributesOnly, //!< Tab delimited text, attributes only + AttributesWithWKT, //!< Tab delimited text, with geometry in WKT format + GeoJSON, //!< GeoJSON FeatureCollection format }; /** @@ -145,7 +145,7 @@ class APP_EXPORT QgsClipboard : public QObject void systemClipboardChanged(); signals: - /** Emitted when content changed */ + //! Emitted when content changed void changed(); private: @@ -181,7 +181,7 @@ class APP_EXPORT QgsClipboard : public QObject QgsFields mFeatureFields; QgsCoordinateReferenceSystem mCRS; - /** True when the data from the system clipboard should be read */ + //! True when the data from the system clipboard should be read bool mUseSystemClipboard; friend class TestQgisAppClipboard; diff --git a/src/app/qgsdecorationgrid.h b/src/app/qgsdecorationgrid.h index 3d6ccd3ce8b..89eda78e2d9 100644 --- a/src/app/qgsdecorationgrid.h +++ b/src/app/qgsdecorationgrid.h @@ -59,81 +59,81 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem BoundaryDirection }; - /** Sets coordinate grid style. */ + //! Sets coordinate grid style. void setGridStyle( GridStyle style ) {mGridStyle = style;} GridStyle gridStyle() const { return mGridStyle; } - /** Sets coordinate interval in x-direction for composergrid. */ + //! Sets coordinate interval in x-direction for composergrid. void setGridIntervalX( double interval ) { mGridIntervalX = interval;} double gridIntervalX() const { return mGridIntervalX; } - /** Sets coordinate interval in y-direction for composergrid. */ + //! Sets coordinate interval in y-direction for composergrid. void setGridIntervalY( double interval ) { mGridIntervalY = interval;} double gridIntervalY() const { return mGridIntervalY; } - /** Sets x-coordinate offset for composer grid */ + //! Sets x-coordinate offset for composer grid void setGridOffsetX( double offset ) { mGridOffsetX = offset; } double gridOffsetX() const { return mGridOffsetX; } - /** Sets y-coordinate offset for composer grid */ + //! Sets y-coordinate offset for composer grid void setGridOffsetY( double offset ) { mGridOffsetY = offset; } double gridOffsetY() const { return mGridOffsetY; } - /** Sets the pen to draw composer grid */ + //! Sets the pen to draw composer grid void setGridPen( const QPen& p ) { mGridPen = p; } QPen gridPen() const { return mGridPen; } - /** Sets with of grid pen */ + //! Sets with of grid pen void setGridPenWidth( double w ) { mGridPen.setWidthF( w ); } - /** Sets the color of the grid pen */ + //! Sets the color of the grid pen void setGridPenColor( const QColor& c ) { mGridPen.setColor( c ); } - /** Sets font for grid annotations */ + //! Sets font for grid annotations void setGridAnnotationFont( const QFont& f ) { mGridAnnotationFont = f; } QFont gridAnnotationFont() const { return mGridAnnotationFont; } - /** Sets coordinate precision for grid annotations */ + //! Sets coordinate precision for grid annotations void setGridAnnotationPrecision( int p ) {mGridAnnotationPrecision = p;} int gridAnnotationPrecision() const {return mGridAnnotationPrecision;} - /** Sets flag if grid annotation should be shown */ + //! Sets flag if grid annotation should be shown void setShowGridAnnotation( bool show ) {mShowGridAnnotation = show;} bool showGridAnnotation() const {return mShowGridAnnotation;} - /** Sets position of grid annotations. Possibilities are inside or outside of the map frame */ + //! Sets position of grid annotations. Possibilities are inside or outside of the map frame void setGridAnnotationPosition( GridAnnotationPosition p ) {mGridAnnotationPosition = p;} GridAnnotationPosition gridAnnotationPosition() const {return mGridAnnotationPosition;} - /** Sets distance between map frame and annotations */ + //! Sets distance between map frame and annotations void setAnnotationFrameDistance( double d ) {mAnnotationFrameDistance = d;} double annotationFrameDistance() const {return mAnnotationFrameDistance;} - /** Sets grid annotation direction. Can be horizontal, vertical, direction of axis and horizontal and vertical */ + //! Sets grid annotation direction. Can be horizontal, vertical, direction of axis and horizontal and vertical void setGridAnnotationDirection( GridAnnotationDirection d ) {mGridAnnotationDirection = d;} GridAnnotationDirection gridAnnotationDirection() const {return mGridAnnotationDirection;} - /** Sets length of the cros segments (if grid style is cross) */ + //! Sets length of the cros segments (if grid style is cross) /* void setCrossLength( double l ) {mCrossLength = l;} */ /* double crossLength() {return mCrossLength;} */ - /** Set symbol that is used to draw grid lines. Takes ownership*/ + //! Set symbol that is used to draw grid lines. Takes ownership void setLineSymbol( QgsLineSymbol* symbol ); const QgsLineSymbol* lineSymbol() const { return mLineSymbol; } - /** Set symbol that is used to draw markers. Takes ownership*/ + //! Set symbol that is used to draw markers. Takes ownership void setMarkerSymbol( QgsMarkerSymbol* symbol ); const QgsMarkerSymbol* markerSymbol() const { return mMarkerSymbol; } - /** Sets map unit type */ + //! Sets map unit type void setMapUnits( QgsUnitTypes::DistanceUnit t ) { mMapUnits = t; } QgsUnitTypes::DistanceUnit mapUnits() { return mMapUnits; } - /** Set mapUnits value */ + //! Set mapUnits value void setDirty( bool dirty = true ); bool isDirty(); - /** Computes interval that is approx. 1/5 of canvas extent */ + //! Computes interval that is approx. 1/5 of canvas extent bool getIntervalFromExtent( double* values, bool useXAxis = true ); - /** Computes interval from current raster layer */ + //! Computes interval from current raster layer bool getIntervalFromCurrentLayer( double* values ); double getDefaultInterval( bool useXAxis = true ); @@ -154,7 +154,7 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem private: - /** Enum for different frame borders*/ + //! Enum for different frame borders enum Border { Left, @@ -163,31 +163,31 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem Top }; - /** Line or Symbol */ + //! Line or Symbol GridStyle mGridStyle; - /** Grid line interval in x-direction (map units)*/ + //! Grid line interval in x-direction (map units) double mGridIntervalX; - /** Grid line interval in y-direction (map units)*/ + //! Grid line interval in y-direction (map units) double mGridIntervalY; - /** Grid line offset in x-direction*/ + //! Grid line offset in x-direction double mGridOffsetX; - /** Grid line offset in y-direction*/ + //! Grid line offset in y-direction double mGridOffsetY; - /** Grid line pen*/ + //! Grid line pen QPen mGridPen; - /** Font for grid line annotation*/ + //! Font for grid line annotation QFont mGridAnnotationFont; - /** Digits after the dot*/ + //! Digits after the dot int mGridAnnotationPrecision; - /** True if coordinate values should be drawn*/ + //! True if coordinate values should be drawn bool mShowGridAnnotation; - /** Annotation position inside or outside of map frame*/ + //! Annotation position inside or outside of map frame GridAnnotationPosition mGridAnnotationPosition; - /** Distance between map frame and annotation*/ + //! Distance between map frame and annotation double mAnnotationFrameDistance; - /** Annotation can be horizontal / vertical or different for axes*/ + //! Annotation can be horizontal / vertical or different for axes GridAnnotationDirection mGridAnnotationDirection; - /** The length of the cross sides for mGridStyle Cross*/ + //! The length of the cross sides for mGridStyle Cross /* double mCrossLength; */ QgsLineSymbol* mLineSymbol; @@ -213,23 +213,23 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem /** Returns the grid lines for the y-coordinates. Not vertical in case of rotation @return 0 in case of success*/ int yGridLines( QList< QPair< qreal, QLineF > >& lines ) const; - /** Returns the item border of a point (in item coordinates)*/ + //! Returns the item border of a point (in item coordinates) Border borderForLineCoord( QPointF point, QPainter* p ) const; /** Draws Text. Takes care about all the composer specific issues (calculation to pixel, scaling of font and painter to work around the Qt font bug)*/ void drawText( QPainter* p, double x, double y, const QString& text, const QFont& font ) const; - /** Like the above, but with a rectangle for multiline text*/ + //! Like the above, but with a rectangle for multiline text void drawText( QPainter* p, const QRectF& rect, const QString& text, const QFont& font, Qt::AlignmentFlag halignment = Qt::AlignLeft, Qt::AlignmentFlag valignment = Qt::AlignTop ) const; - /** Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE*/ + //! Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE double textWidthMillimeters( const QFont& font, const QString& text ) const; - /** Returns the font height of a character in millimeters. */ + //! Returns the font height of a character in millimeters. double fontHeightCharacterMM( const QFont& font, QChar c ) const; - /** Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE*/ + //! Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE double fontAscentMillimeters( const QFont& font ) const; - /** Calculates font to from point size to pixel size*/ + //! Calculates font to from point size to pixel size double pixelFontSize( double pointSize ) const; - /** Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE*/ + //! Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE QFont scaledFontPixelSize( const QFont& font ) const; /* friend class QgsDecorationGridDialog; */ diff --git a/src/app/qgsdecorationitem.h b/src/app/qgsdecorationitem.h index 93d0dfd8d98..9e6ea80473d 100644 --- a/src/app/qgsdecorationitem.h +++ b/src/app/qgsdecorationitem.h @@ -79,7 +79,7 @@ class APP_EXPORT QgsDecorationItem: public QObject protected: - /** True if decoration item has to be displayed*/ + //! True if decoration item has to be displayed bool mEnabled; //! Placement of the decoration diff --git a/src/app/qgsdelattrdialog.h b/src/app/qgsdelattrdialog.h index 999338e21b1..b6ddf6ecfa8 100644 --- a/src/app/qgsdelattrdialog.h +++ b/src/app/qgsdelattrdialog.h @@ -30,7 +30,7 @@ class APP_EXPORT QgsDelAttrDialog: public QDialog, private Ui::QgsDelAttrDialogB public: QgsDelAttrDialog( const QgsVectorLayer* vl ); ~QgsDelAttrDialog(); - /** Returns the selected attribute indices*/ + //! Returns the selected attribute indices QList selectedAttributes(); }; diff --git a/src/app/qgsdiagramproperties.h b/src/app/qgsdiagramproperties.h index f5c83ae5de9..5bc297e0674 100644 --- a/src/app/qgsdiagramproperties.h +++ b/src/app/qgsdiagramproperties.h @@ -34,7 +34,7 @@ class APP_EXPORT QgsDiagramProperties : public QWidget, private Ui::QgsDiagramPr ~QgsDiagramProperties(); - /** Adds an attribute from the list of available attributes to the assigned attributes with a random color.*/ + //! Adds an attribute from the list of available attributes to the assigned attributes with a random color. void addAttribute( QTreeWidgetItem * item ); public slots: diff --git a/src/app/qgsdisplayangle.h b/src/app/qgsdisplayangle.h index 2cf8d6cd8b7..71c2b0682b6 100644 --- a/src/app/qgsdisplayangle.h +++ b/src/app/qgsdisplayangle.h @@ -20,7 +20,7 @@ class QgsMapToolMeasureAngle; -/** A class that displays results of angle measurements with the proper unit*/ +//! A class that displays results of angle measurements with the proper unit class APP_EXPORT QgsDisplayAngle: public QDialog, private Ui::QgsDisplayAngleBase { Q_OBJECT diff --git a/src/app/qgsdxfexportdialog.h b/src/app/qgsdxfexportdialog.h index f54f933b9c3..1cb012725ed 100644 --- a/src/app/qgsdxfexportdialog.h +++ b/src/app/qgsdxfexportdialog.h @@ -91,7 +91,7 @@ class QgsDxfExportDialog : public QDialog, private Ui::QgsDxfExportDialogBase QgsCoordinateReferenceSystem crs() const; public slots: - /** Change the selection of layers in the list */ + //! Change the selection of layers in the list void selectAll(); void unSelectAll(); diff --git a/src/app/qgsfieldcalculator.h b/src/app/qgsfieldcalculator.h index b8b4f27923c..54936d9d6f3 100644 --- a/src/app/qgsfieldcalculator.h +++ b/src/app/qgsfieldcalculator.h @@ -22,7 +22,7 @@ class QgsVectorLayer; -/** A dialog class that provides calculation of new fields using existing fields, values and a set of operators*/ +//! A dialog class that provides calculation of new fields using existing fields, values and a set of operators class APP_EXPORT QgsFieldCalculator: public QDialog, private Ui::QgsFieldCalculatorBase { Q_OBJECT @@ -44,23 +44,23 @@ class APP_EXPORT QgsFieldCalculator: public QDialog, private Ui::QgsFieldCalcula void on_mButtonBox_helpRequested() { QgsContextHelp::run( metaObject()->className() ); } private slots: - /** Sets the ok button enabled / disabled*/ + //! Sets the ok button enabled / disabled void setOkButtonState(); void setPrecisionMinMax(); private: //! default constructor forbidden QgsFieldCalculator(); - /** Inserts existing fields into the combo box*/ + //! Inserts existing fields into the combo box void populateFields(); - /** Inserts the types supported by the provider into the combo box*/ + //! Inserts the types supported by the provider into the combo box void populateOutputFieldTypes(); QgsVectorLayer* mVectorLayer; - /** Key: field name, Value: field index*/ + //! Key: field name, Value: field index QMap mFieldMap; - /** Create a field based on the definitions */ + //! Create a field based on the definitions inline QgsField fieldDefinition() { return QgsField( mOutputFieldNameLineEdit->text(), @@ -73,7 +73,7 @@ class APP_EXPORT QgsFieldCalculator: public QDialog, private Ui::QgsFieldCalcula ); } - /** Idx of changed attribute*/ + //! Idx of changed attribute int mAttributeId; friend class TestQgsFieldCalculator; diff --git a/src/app/qgsfieldsproperties.h b/src/app/qgsfieldsproperties.h index 71b04d3bb3c..e0bfc4f0f8c 100644 --- a/src/app/qgsfieldsproperties.h +++ b/src/app/qgsfieldsproperties.h @@ -196,7 +196,7 @@ class APP_EXPORT QgsFieldsProperties : public QWidget, private Ui_QgsFieldsPrope void updateExpression(); - /** Editing of layer was toggled */ + //! Editing of layer was toggled void editingToggled(); protected: diff --git a/src/app/qgshandlebadlayers.h b/src/app/qgshandlebadlayers.h index 9822688084f..c2aeaed5643 100644 --- a/src/app/qgshandlebadlayers.h +++ b/src/app/qgshandlebadlayers.h @@ -30,7 +30,7 @@ class APP_EXPORT QgsHandleBadLayersHandler public: QgsHandleBadLayersHandler(); - /** Implementation of the handler */ + //! Implementation of the handler virtual void handleBadLayers( const QList& layers ) override; }; diff --git a/src/app/qgsidentifyresultsdialog.h b/src/app/qgsidentifyresultsdialog.h index 52c5d718adf..b1c88090bd1 100644 --- a/src/app/qgsidentifyresultsdialog.h +++ b/src/app/qgsidentifyresultsdialog.h @@ -84,7 +84,7 @@ class APP_EXPORT QgsIdentifyResultsWebViewItem: public QObject, public QTreeWidg QgsIdentifyResultsWebViewItem( QTreeWidget *treeWidget = nullptr ); QgsIdentifyResultsWebView *webView() { return mWebView; } void setHtml( const QString &html ); - /** @note added in 2.1 */ + //! @note added in 2.1 void setContent( const QByteArray & data, const QString & mimeType = QString(), const QUrl & baseUrl = QUrl() ); public slots: @@ -122,12 +122,12 @@ class APP_EXPORT QgsIdentifyResultsDialog: public QDialog, private Ui::QgsIdenti ~QgsIdentifyResultsDialog(); - /** Add add feature from vector layer */ + //! Add add feature from vector layer void addFeature( QgsVectorLayer * layer, const QgsFeature &f, const QMap< QString, QString > &derivedAttributes ); - /** Add add feature from other layer */ + //! Add add feature from other layer void addFeature( QgsRasterLayer * layer, const QString& label, const QMap< QString, QString > &attributes, @@ -136,13 +136,13 @@ class APP_EXPORT QgsIdentifyResultsDialog: public QDialog, private Ui::QgsIdenti const QgsFeature &feature = QgsFeature(), const QMap ¶ms = ( QMap() ) ); - /** Add feature from identify results */ + //! Add feature from identify results void addFeature( const QgsMapToolIdentify::IdentifyResult& result ); - /** Map tool was deactivated */ + //! Map tool was deactivated void deactivate(); - /** Map tool was activated */ + //! Map tool was activated void activate(); signals: @@ -156,7 +156,7 @@ class APP_EXPORT QgsIdentifyResultsDialog: public QDialog, private Ui::QgsIdenti void activateLayer( QgsMapLayer * ); public slots: - /** Remove results */ + //! Remove results void clear(); void updateViewModes(); diff --git a/src/app/qgsjoindialog.h b/src/app/qgsjoindialog.h index bf33894e05d..b80e3636c5b 100644 --- a/src/app/qgsjoindialog.h +++ b/src/app/qgsjoindialog.h @@ -30,13 +30,13 @@ class APP_EXPORT QgsJoinDialog: public QDialog, private Ui::QgsJoinDialogBase QgsJoinDialog( QgsVectorLayer* layer, QList alreadyJoinedLayers, QWidget * parent = nullptr, Qt::WindowFlags f = 0 ); ~QgsJoinDialog(); - /** Configure the dialog for an existing join */ + //! Configure the dialog for an existing join void setJoinInfo( const QgsVectorJoinInfo& joinInfo ); - /** Returns the join info */ + //! Returns the join info QgsVectorJoinInfo joinInfo() const; - /** Returns true if user wants to create an attribute index on the join field*/ + //! Returns true if user wants to create an attribute index on the join field bool createAttributeIndex() const; private slots: @@ -45,7 +45,7 @@ class APP_EXPORT QgsJoinDialog: public QDialog, private Ui::QgsJoinDialogBase void checkDefinitionValid(); private: - /** Target layer*/ + //! Target layer QgsVectorLayer* mLayer; }; diff --git a/src/app/qgslabelinggui.h b/src/app/qgslabelinggui.h index 789c1506290..a4671b1ed21 100644 --- a/src/app/qgslabelinggui.h +++ b/src/app/qgslabelinggui.h @@ -52,7 +52,7 @@ class APP_EXPORT QgsLabelingGui : public QgsTextFormatWidget, private QgsExpress void blockInitSignals( bool block ); void syncDefinedCheckboxFrame( QgsDataDefinedButton* ddBtn, QCheckBox* chkBx, QFrame* f ); void populateDataDefinedButtons( QgsPalLayerSettings& s ); - /** Sets data defined property attribute to map */ + //! Sets data defined property attribute to map void setDataDefinedProperty( const QgsDataDefinedButton* ddBtn, QgsPalLayerSettings::DataDefinedProperties p, QgsPalLayerSettings& lyr ); private: diff --git a/src/app/qgslabelpropertydialog.h b/src/app/qgslabelpropertydialog.h index 5d202aec8b0..2aa3279021c 100644 --- a/src/app/qgslabelpropertydialog.h +++ b/src/app/qgslabelpropertydialog.h @@ -24,7 +24,7 @@ #include -/** A dialog to enter data defined label attributes*/ +//! A dialog to enter data defined label attributes class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPropertyDialogBase { Q_OBJECT @@ -32,7 +32,7 @@ class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPro QgsLabelPropertyDialog( const QString& layerId, const QString& providerId, int featureId, const QFont& labelFont, const QString& labelText, QWidget * parent = nullptr, Qt::WindowFlags f = 0 ); ~QgsLabelPropertyDialog(); - /** Returns properties changed by the user*/ + //! Returns properties changed by the user const QgsAttributeMap& changedProperties() const { return mChangedProperties; } signals: @@ -67,25 +67,25 @@ class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPro void on_mLabelTextLineEdit_textChanged( const QString& text ); private: - /** Sets activation / values to the gui elements depending on the label settings and feature values*/ + //! Sets activation / values to the gui elements depending on the label settings and feature values void init( const QString& layerId, const QString& providerId, int featureId, const QString& labelText ); void disableGuiElements(); - /** Block / unblock all input element signals*/ + //! Block / unblock all input element signals void blockElementSignals( bool block ); void setDataDefinedValues( const QgsPalLayerSettings &layerSettings, QgsVectorLayer* vlayer ); void enableDataDefinedWidgets( QgsVectorLayer* vlayer ); - /** Updates font when family or style is updated */ + //! Updates font when family or style is updated void updateFont( const QFont& font, bool block = true ); - /** Updates combobox with named styles of font */ + //! Updates combobox with named styles of font void populateFontStyleComboBox(); void fillHaliComboBox(); void fillValiComboBox(); - /** Insert changed value into mChangedProperties*/ + //! Insert changed value into mChangedProperties void insertChangedValue( QgsPalLayerSettings::DataDefinedProperties p, const QVariant& value ); QgsAttributeMap mChangedProperties; @@ -94,10 +94,10 @@ class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPro QFontDatabase mFontDB; - /** Label field for the current layer (or -1 if none)*/ + //! Label field for the current layer (or -1 if none) int mCurLabelField; - /** Current feature */ + //! Current feature QgsFeature mCurLabelFeat; }; diff --git a/src/app/qgslayerstylingwidget.h b/src/app/qgslayerstylingwidget.h index 1ab3332d77d..b16d2deee28 100644 --- a/src/app/qgslayerstylingwidget.h +++ b/src/app/qgslayerstylingwidget.h @@ -61,7 +61,7 @@ class APP_EXPORT QgsMapLayerStyleCommand : public QUndoCommand virtual void undo() override; virtual void redo() override; - /** Try to merge with other commands of this type when they are created in small time interval */ + //! Try to merge with other commands of this type when they are created in small time interval virtual bool mergeWith( const QUndoCommand* other ) override; private: diff --git a/src/app/qgsmaplayerstyleguiutils.h b/src/app/qgsmaplayerstyleguiutils.h index e9e8a8a683d..67bd119632d 100644 --- a/src/app/qgsmaplayerstyleguiutils.h +++ b/src/app/qgsmaplayerstyleguiutils.h @@ -23,7 +23,7 @@ class QgsMapLayer; class QAction; class QMenu; -/** Various GUI utility functions for dealing with map layer's style manager */ +//! Various GUI utility functions for dealing with map layer's style manager class QgsMapLayerStyleGuiUtils : public QObject { Q_OBJECT diff --git a/src/app/qgsmaptooladdcircularstring.h b/src/app/qgsmaptooladdcircularstring.h index d21b9417614..a9274b2af69 100644 --- a/src/app/qgsmaptooladdcircularstring.h +++ b/src/app/qgsmaptooladdcircularstring.h @@ -44,7 +44,7 @@ class QgsMapToolAddCircularString: public QgsMapToolCapture * Completed circular strings will be added to this tool by calling its addCurve() method. * */ QgsMapToolCapture* mParentTool; - /** Circular string points (in map coordinates)*/ + //! Circular string points (in map coordinates) QgsPointSequence mPoints; //! The rubberband to show the already completed circular strings QgsGeometryRubberBand* mRubberBand; diff --git a/src/app/qgsmaptooladdfeature.h b/src/app/qgsmaptooladdfeature.h index f2cf8777d5e..654ed4095e1 100644 --- a/src/app/qgsmaptooladdfeature.h +++ b/src/app/qgsmaptooladdfeature.h @@ -15,12 +15,12 @@ #include "qgsmaptoolcapture.h" -/** This tool adds new point/line/polygon features to already existing vector layers*/ +//! This tool adds new point/line/polygon features to already existing vector layers class APP_EXPORT QgsMapToolAddFeature : public QgsMapToolCapture { Q_OBJECT public: - /** @note mode parameter added in QGIS 2.12 */ + //! @note mode parameter added in QGIS 2.12 QgsMapToolAddFeature( QgsMapCanvas* canvas, CaptureMode mode = CaptureNone ); virtual ~QgsMapToolAddFeature(); void cadCanvasReleaseEvent( QgsMapMouseEvent * e ) override; diff --git a/src/app/qgsmaptooladdpart.h b/src/app/qgsmaptooladdpart.h index 84ee29461be..c9af2e1923a 100644 --- a/src/app/qgsmaptooladdpart.h +++ b/src/app/qgsmaptooladdpart.h @@ -15,7 +15,7 @@ #include "qgsmaptoolcapture.h" -/** A map tool that adds new parts to multipart features*/ +//! A map tool that adds new parts to multipart features class APP_EXPORT QgsMapToolAddPart : public QgsMapToolCapture { Q_OBJECT @@ -28,6 +28,6 @@ class APP_EXPORT QgsMapToolAddPart : public QgsMapToolCapture void activate() override; private: - /** Check if there is any feature selected */ + //! Check if there is any feature selected bool checkSelection(); }; diff --git a/src/app/qgsmaptooladdring.h b/src/app/qgsmaptooladdring.h index 35b595ebe59..8a21c8a3e60 100644 --- a/src/app/qgsmaptooladdring.h +++ b/src/app/qgsmaptooladdring.h @@ -15,7 +15,7 @@ #include "qgsmaptoolcapture.h" -/** A tool to cut holes into polygons and multipolygon features*/ +//! A tool to cut holes into polygons and multipolygon features class APP_EXPORT QgsMapToolAddRing: public QgsMapToolCapture { Q_OBJECT diff --git a/src/app/qgsmaptoolannotation.h b/src/app/qgsmaptoolannotation.h index 1cb9adc081d..d94632e8676 100644 --- a/src/app/qgsmaptoolannotation.h +++ b/src/app/qgsmaptoolannotation.h @@ -36,18 +36,18 @@ class APP_EXPORT QgsMapToolAnnotation: public QgsMapTool void keyPressEvent( QKeyEvent* e ) override; protected: - /** Creates a new item. To be implemented by subclasses. Returns 0 by default*/ + //! Creates a new item. To be implemented by subclasses. Returns 0 by default virtual QgsAnnotationItem* createItem( QMouseEvent* e ); - /** Creates an editor widget (caller takes ownership)*/ + //! Creates an editor widget (caller takes ownership) QDialog* createItemEditor( QgsAnnotationItem* item ); private: - /** Returns the topmost annotation item at the position (or 0 if none)*/ + //! Returns the topmost annotation item at the position (or 0 if none) QgsAnnotationItem* itemAtPos( QPointF pos ); QgsAnnotationItem* selectedItem(); - /** Returns a list of all annotationitems in the canvas*/ + //! Returns a list of all annotationitems in the canvas QList annotationItems(); - /** Switches visibility states of text items*/ + //! Switches visibility states of text items void toggleTextItemVisibilities(); QgsAnnotationItem::MouseMoveAction mCurrentMoveAction; diff --git a/src/app/qgsmaptooldeletepart.h b/src/app/qgsmaptooldeletepart.h index d87feb216a4..efbe76412d1 100644 --- a/src/app/qgsmaptooldeletepart.h +++ b/src/app/qgsmaptooldeletepart.h @@ -20,7 +20,7 @@ class QgsVertexMarker; -/** Map tool to delete vertices from line/polygon features*/ +//! Map tool to delete vertices from line/polygon features class APP_EXPORT QgsMapToolDeletePart: public QgsMapToolEdit { Q_OBJECT diff --git a/src/app/qgsmaptooldeletering.h b/src/app/qgsmaptooldeletering.h index df3d9adfd4d..9281069b116 100644 --- a/src/app/qgsmaptooldeletering.h +++ b/src/app/qgsmaptooldeletering.h @@ -19,7 +19,7 @@ #include "qgsmaptooledit.h" class QgsVertexMarker; -/** Map tool to delete vertices from line/polygon features*/ +//! Map tool to delete vertices from line/polygon features class APP_EXPORT QgsMapToolDeleteRing : public QgsMapToolEdit { diff --git a/src/app/qgsmaptoollabel.h b/src/app/qgsmaptoollabel.h index 2ff0c385431..c1a6677789f 100644 --- a/src/app/qgsmaptoollabel.h +++ b/src/app/qgsmaptoollabel.h @@ -23,7 +23,7 @@ class QgsRubberBand; -/** Base class for map tools that modify label properties*/ +//! Base class for map tools that modify label properties class APP_EXPORT QgsMapToolLabel: public QgsMapTool { Q_OBJECT @@ -63,7 +63,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool protected: QgsRubberBand* mLabelRubberBand; QgsRubberBand* mFeatureRubberBand; - /** Shows label fixpoint (left/bottom by default)*/ + //! Shows label fixpoint (left/bottom by default) QgsRubberBand* mFixPointRubberBand; struct LabelDetails @@ -76,7 +76,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool QgsPalLayerSettings settings; }; - /** Currently dragged label position*/ + //! Currently dragged label position LabelDetails mCurrentLabel; @@ -91,10 +91,10 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool @return true in case of success*/ bool currentLabelRotationPoint( QgsPoint& pos, bool ignoreUpsideDown = false, bool rotatingUnpinned = false ); - /** Creates label / feature / fixpoint rubber bands for the current label position*/ + //! Creates label / feature / fixpoint rubber bands for the current label position void createRubberBands(); - /** Removes label / feature / fixpoint rubber bands*/ + //! Removes label / feature / fixpoint rubber bands void deleteRubberBands(); /** Returns current label's text @@ -107,17 +107,17 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool @return true in case of success*/ bool currentFeature( QgsFeature& f, bool fetchGeom = false ); - /** Returns the font for the current feature (considering default font and data defined properties)*/ + //! Returns the font for the current feature (considering default font and data defined properties) QFont currentLabelFont(); - /** Returns a data defined attribute column name for particular property or empty string if not defined */ + //! Returns a data defined attribute column name for particular property or empty string if not defined QString dataDefinedColumnName( QgsPalLayerSettings::DataDefinedProperties p, const QgsPalLayerSettings& labelSettings ) const; /** Returns a data defined attribute column index @return -1 if column does not exist or an expression is used instead */ int dataDefinedColumnIndex( QgsPalLayerSettings::DataDefinedProperties p, const QgsPalLayerSettings& labelSettings, const QgsVectorLayer* vlayer ) const; - /** Returns whether to preserve predefined rotation data during label pin/unpin operations*/ + //! Returns whether to preserve predefined rotation data during label pin/unpin operations bool currentLabelPreserveRotation(); /** Get data defined position of current label diff --git a/src/app/qgsmaptoolmeasureangle.h b/src/app/qgsmaptoolmeasureangle.h index 05b69034522..2b1acd53e40 100644 --- a/src/app/qgsmaptoolmeasureangle.h +++ b/src/app/qgsmaptoolmeasureangle.h @@ -23,7 +23,7 @@ class QgsDisplayAngle; class QgsRubberBand; -/** Map tool to measure angle between two segments*/ +//! Map tool to measure angle between two segments class APP_EXPORT QgsMapToolMeasureAngle: public QgsMapTool { Q_OBJECT @@ -46,28 +46,28 @@ class APP_EXPORT QgsMapToolMeasureAngle: public QgsMapTool void deactivate() override; private: - /** Points defining the angle (three for measuring)*/ + //! Points defining the angle (three for measuring) QList mAnglePoints; QgsRubberBand* mRubberBand; QgsDisplayAngle* mResultDisplay; - /** Creates a new rubber band and deletes the old one*/ + //! Creates a new rubber band and deletes the old one void createRubberBand(); - /** Snaps point to background layers*/ + //! Snaps point to background layers QgsPoint snapPoint( QPoint p ); - /** Tool for measuring */ + //! Tool for measuring QgsDistanceArea mDa; public slots: - /** Recalculate angle if projection state changed*/ + //! Recalculate angle if projection state changed void updateSettings(); private slots: - /** Deletes the rubber band and the dialog*/ + //! Deletes the rubber band and the dialog void stopMeasuring(); - /** Configures distance area objects with ellipsoid / output crs*/ + //! Configures distance area objects with ellipsoid / output crs void configureDistanceArea(); }; diff --git a/src/app/qgsmaptoolmovefeature.h b/src/app/qgsmaptoolmovefeature.h index c30cf149749..fd888423155 100644 --- a/src/app/qgsmaptoolmovefeature.h +++ b/src/app/qgsmaptoolmovefeature.h @@ -18,7 +18,7 @@ #include "qgsmaptooladvanceddigitizing.h" -/** Map tool for translating feature position by mouse drag*/ +//! Map tool for translating feature position by mouse drag class APP_EXPORT QgsMapToolMoveFeature: public QgsMapToolAdvancedDigitizing { Q_OBJECT @@ -34,13 +34,13 @@ class APP_EXPORT QgsMapToolMoveFeature: public QgsMapToolAdvancedDigitizing void deactivate() override; private: - /** Start point of the move in map coordinates*/ + //! Start point of the move in map coordinates QgsPoint mStartPointMapCoords; - /** Rubberband that shows the feature being moved*/ + //! Rubberband that shows the feature being moved QgsRubberBand* mRubberBand; - /** Id of moved feature*/ + //! Id of moved feature QgsFeatureIds mMovedFeatures; QPoint mPressPos; diff --git a/src/app/qgsmaptoolmovelabel.h b/src/app/qgsmaptoolmovelabel.h index 4eddaaee10c..464eb99c4ad 100644 --- a/src/app/qgsmaptoolmovelabel.h +++ b/src/app/qgsmaptoolmovelabel.h @@ -20,7 +20,7 @@ #include "qgsmaptoollabel.h" -/** A map tool for dragging label positions*/ +//! A map tool for dragging label positions class APP_EXPORT QgsMapToolMoveLabel: public QgsMapToolLabel { Q_OBJECT @@ -37,7 +37,7 @@ class APP_EXPORT QgsMapToolMoveLabel: public QgsMapToolLabel protected: - /** Start point of the move in map coordinates*/ + //! Start point of the move in map coordinates QgsPoint mStartPointMapCoords; double mClickOffsetX; diff --git a/src/app/qgsmaptooloffsetcurve.h b/src/app/qgsmaptooloffsetcurve.h index 9f55a5a31d3..d3b685f021b 100644 --- a/src/app/qgsmaptooloffsetcurve.h +++ b/src/app/qgsmaptooloffsetcurve.h @@ -34,30 +34,30 @@ class APP_EXPORT QgsMapToolOffsetCurve: public QgsMapToolEdit void canvasMoveEvent( QgsMapMouseEvent* e ) override; private slots: - /** Places curve offset to value entered in the spin box*/ + //! Places curve offset to value entered in the spin box void placeOffsetCurveToValue(); - /** Apply the offset either from the spin box or from the mouse event */ + //! Apply the offset either from the spin box or from the mouse event void applyOffset(); private: - /** Rubberband that shows the position of the offset curve*/ + //! Rubberband that shows the position of the offset curve QgsRubberBand* mRubberBand; - /** Geometry to manipulate*/ + //! Geometry to manipulate QgsGeometry mOriginalGeometry; - /** Geometry after manipulation*/ + //! Geometry after manipulation QgsGeometry mModifiedGeometry; - /** ID of manipulated feature*/ + //! ID of manipulated feature QgsFeatureId mModifiedFeature; - /** Layer ID of source layer*/ + //! Layer ID of source layer QString mSourceLayerId; - /** Internal flag to distinguish move from click*/ + //! Internal flag to distinguish move from click bool mGeometryModified; - /** Shows current distance value and allows numerical editing*/ + //! Shows current distance value and allows numerical editing QgsDoubleSpinBox* mDistanceWidget; - /** Marker to show the cursor was snapped to another location*/ + //! Marker to show the cursor was snapped to another location QgsVertexMarker* mSnapVertexMarker; - /** Forces geometry copy (no modification of geometry in current layer)*/ + //! Forces geometry copy (no modification of geometry in current layer) bool mForceCopy; bool mMultiPartGeometry; @@ -67,11 +67,11 @@ class APP_EXPORT QgsMapToolOffsetCurve: public QgsMapToolEdit void createDistanceWidget(); void deleteDistanceWidget(); void setOffsetForRubberBand( double offset ); - /** Creates a linestring from the polygon ring containing the snapped vertex. Caller takes ownership of the created object*/ + //! Creates a linestring from the polygon ring containing the snapped vertex. Caller takes ownership of the created object QgsGeometry linestringFromPolygon( const QgsGeometry& featureGeom, int vertex ); - /** Returns a single line from a multiline (or does nothing if geometry is already a single line). Deletes the input geometry*/ + //! Returns a single line from a multiline (or does nothing if geometry is already a single line). Deletes the input geometry QgsGeometry convertToSingleLine( const QgsGeometry& geom, int vertex, bool& isMulti ); - /** Converts offset line back to a multiline if necessary*/ + //! Converts offset line back to a multiline if necessary QgsGeometry* convertToMultiLine( QgsGeometry* geom ); }; diff --git a/src/app/qgsmaptoolpinlabels.h b/src/app/qgsmaptoolpinlabels.h index cc74ba8f563..3a4e4120a5d 100644 --- a/src/app/qgsmaptoolpinlabels.h +++ b/src/app/qgsmaptoolpinlabels.h @@ -23,7 +23,7 @@ class QgsRubberBand; class QgsLabelPosition; -/** A map tool for pinning (writing to attribute table) and unpinning labelpositions and rotation*/ +//! A map tool for pinning (writing to attribute table) and unpinning labelpositions and rotation class APP_EXPORT QgsMapToolPinLabels: public QgsMapToolLabel { Q_OBJECT diff --git a/src/app/qgsmaptoolpointsymbol.h b/src/app/qgsmaptoolpointsymbol.h index 360110e83b4..8ac68288965 100644 --- a/src/app/qgsmaptoolpointsymbol.h +++ b/src/app/qgsmaptoolpointsymbol.h @@ -42,7 +42,7 @@ class APP_EXPORT QgsMapToolPointSymbol: public QgsMapToolEdit QgsVectorLayer* mActiveLayer; QgsFeatureId mFeatureNumber; - /** Screen coordinate of the snaped feature*/ + //! Screen coordinate of the snaped feature QPoint mSnappedPoint; virtual void canvasPressOnFeature( QgsMapMouseEvent* e, const QgsFeature& feature, const QgsPoint& snappedPoint ) = 0; diff --git a/src/app/qgsmaptoolreshape.h b/src/app/qgsmaptoolreshape.h index 72dcc07c045..e0d0ebc1212 100644 --- a/src/app/qgsmaptoolreshape.h +++ b/src/app/qgsmaptoolreshape.h @@ -18,7 +18,7 @@ #include "qgsmaptoolcapture.h" -/** A map tool that draws a line and splits the features cut by the line*/ +//! A map tool that draws a line and splits the features cut by the line class APP_EXPORT QgsMapToolReshape: public QgsMapToolCapture { Q_OBJECT diff --git a/src/app/qgsmaptoolrotatefeature.h b/src/app/qgsmaptoolrotatefeature.h index b20acdc63c1..19c479bb667 100644 --- a/src/app/qgsmaptoolrotatefeature.h +++ b/src/app/qgsmaptoolrotatefeature.h @@ -61,7 +61,7 @@ class APP_EXPORT QgsAngleMagnetWidget : public QWidget }; -/** Map tool to rotate features */ +//! Map tool to rotate features class APP_EXPORT QgsMapToolRotateFeature: public QgsMapToolEdit { Q_OBJECT @@ -91,14 +91,14 @@ class APP_EXPORT QgsMapToolRotateFeature: public QgsMapToolEdit void createRotationWidget(); void deleteRotationWidget(); - /** Start point of the move in map coordinates*/ + //! Start point of the move in map coordinates QgsPoint mStartPointMapCoords; QPointF mInitialPos; - /** Rubberband that shows the feature being moved*/ + //! Rubberband that shows the feature being moved QgsRubberBand* mRubberBand; - /** Id of moved feature*/ + //! Id of moved feature QgsFeatureIds mRotatedFeatures; double mRotation; double mRotationOffset; @@ -108,7 +108,7 @@ class APP_EXPORT QgsMapToolRotateFeature: public QgsMapToolEdit bool mRotationActive; - /** Shows current angle value and allows numerical editing*/ + //! Shows current angle value and allows numerical editing QgsAngleMagnetWidget* mRotationWidget; }; diff --git a/src/app/qgsmaptoolrotatelabel.h b/src/app/qgsmaptoolrotatelabel.h index 6b515016282..06af32172b4 100644 --- a/src/app/qgsmaptoolrotatelabel.h +++ b/src/app/qgsmaptoolrotatelabel.h @@ -36,13 +36,13 @@ class APP_EXPORT QgsMapToolRotateLabel: public QgsMapToolLabel protected: static int roundTo15Degrees( double n ); - /** Converts azimuth value to counterclockwise 0 - 360*/ + //! Converts azimuth value to counterclockwise 0 - 360 static double azimuthToCCW( double a ); QgsRubberBand* createRotationPreviewBox(); void setRotationPreviewBox( double rotation ); - /** Rotates input point counterclockwise around centerPoint*/ + //! Rotates input point counterclockwise around centerPoint QgsPoint rotatePointCounterClockwise( const QgsPoint& input, const QgsPoint& centerPoint, double degrees ); double mStartRotation; //rotation value prior to start rotating @@ -52,7 +52,7 @@ class APP_EXPORT QgsMapToolRotateLabel: public QgsMapToolLabel QgsPointRotationItem* mRotationItem; QgsRubberBand* mRotationPreviewBox; - /** True if ctrl was pressed during the last mouse move event*/ + //! True if ctrl was pressed during the last mouse move event bool mCtrlPressed; }; diff --git a/src/app/qgsmaptoolrotatepointsymbols.h b/src/app/qgsmaptoolrotatepointsymbols.h index 82d1db4b2b6..087cccc1ca5 100644 --- a/src/app/qgsmaptoolrotatepointsymbols.h +++ b/src/app/qgsmaptoolrotatepointsymbols.h @@ -50,27 +50,27 @@ class APP_EXPORT QgsMapToolRotatePointSymbols: public QgsMapToolPointSymbol private: - /** Last azimut between mouse and edited point*/ + //! Last azimut between mouse and edited point double mCurrentMouseAzimut; - /** Last feature rotation*/ + //! Last feature rotation double mCurrentRotationFeature; bool mRotating; QSet mCurrentRotationAttributes; - /** Item that displays rotation during mouse move*/ + //! Item that displays rotation during mouse move QgsPointRotationItem* mRotationItem; - /** True if ctrl was pressed during the last mouse move event*/ + //! True if ctrl was pressed during the last mouse move event bool mCtrlPressed; //! Clone of first found marker symbol for feature with rotation attribute set QScopedPointer< QgsMarkerSymbol > mMarkerSymbol; void drawArrow( double azimut ) const; - /** Calculates the azimut between mousePos and mSnappedPoint*/ + //! Calculates the azimut between mousePos and mSnappedPoint double calculateAzimut( QPoint mousePos ); - /** Create item with the point symbol for a specific feature. This will be used to show the rotation to the user*/ + //! Create item with the point symbol for a specific feature. This will be used to show the rotation to the user void createPixmapItem( QgsMarkerSymbol *markerSymbol ); - /** Sets the rotation of the pixmap item*/ + //! Sets the rotation of the pixmap item void setPixmapItemRotation( double rotation ); - /** Rounds value to 15 degree integer (used if ctrl pressed)*/ + //! Rounds value to 15 degree integer (used if ctrl pressed) static int roundTo15Degrees( double n ); }; diff --git a/src/app/qgsmaptoolshowhidelabels.h b/src/app/qgsmaptoolshowhidelabels.h index 631c0ed5524..25cc468d8a0 100644 --- a/src/app/qgsmaptoolshowhidelabels.h +++ b/src/app/qgsmaptoolshowhidelabels.h @@ -22,7 +22,7 @@ #include "qgsfeature.h" -/** A map tool for showing or hidding a feature's label*/ +//! A map tool for showing or hidding a feature's label class APP_EXPORT QgsMapToolShowHideLabels : public QgsMapToolLabel { Q_OBJECT diff --git a/src/app/qgsmaptoolsimplify.h b/src/app/qgsmaptoolsimplify.h index b5e1349480f..64624b148cf 100644 --- a/src/app/qgsmaptoolsimplify.h +++ b/src/app/qgsmaptoolsimplify.h @@ -49,7 +49,7 @@ class APP_EXPORT QgsSimplifyDialog : public QDialog, private Ui::SimplifyLineDia }; -/** Map tool to simplify line/polygon features */ +//! Map tool to simplify line/polygon features class APP_EXPORT QgsMapToolSimplify: public QgsMapToolEdit { Q_OBJECT @@ -71,12 +71,12 @@ class APP_EXPORT QgsMapToolSimplify: public QgsMapToolEdit QString statusText() const; public slots: - /** Slot to change display when slidebar is moved */ + //! Slot to change display when slidebar is moved void setTolerance( double tolerance ); void setToleranceUnits( int units ); - /** Slot to store feture after simplification */ + //! Slot to store feture after simplification void storeSimplified(); void clearSelection(); @@ -91,15 +91,15 @@ class APP_EXPORT QgsMapToolSimplify: public QgsMapToolEdit int vertexCount( const QgsGeometry& g ) const; // data - /** Dialog with slider to set correct tolerance value */ + //! Dialog with slider to set correct tolerance value QgsSimplifyDialog* mSimplifyDialog; - /** Rubber bands to draw current state of simplification */ + //! Rubber bands to draw current state of simplification QList mRubberBands; - /** Features with which we are working */ + //! Features with which we are working QList mSelectedFeatures; - /** Real value of tolerance */ + //! Real value of tolerance double mTolerance; QgsTolerance::UnitType mToleranceUnits; diff --git a/src/app/qgsmaptoolsplitfeatures.h b/src/app/qgsmaptoolsplitfeatures.h index 29e19711977..249df5a6562 100644 --- a/src/app/qgsmaptoolsplitfeatures.h +++ b/src/app/qgsmaptoolsplitfeatures.h @@ -18,7 +18,7 @@ #include "qgsmaptoolcapture.h" -/** A map tool that draws a line and splits the features cut by the line*/ +//! A map tool that draws a line and splits the features cut by the line class APP_EXPORT QgsMapToolSplitFeatures: public QgsMapToolCapture { Q_OBJECT diff --git a/src/app/qgsmaptoolsplitparts.h b/src/app/qgsmaptoolsplitparts.h index 58a2fbe17e3..6a325218994 100644 --- a/src/app/qgsmaptoolsplitparts.h +++ b/src/app/qgsmaptoolsplitparts.h @@ -18,7 +18,7 @@ #include "qgsmaptoolcapture.h" -/** A map tool that draws a line and splits the parts cut by the line*/ +//! A map tool that draws a line and splits the parts cut by the line class QgsMapToolSplitParts: public QgsMapToolCapture { Q_OBJECT diff --git a/src/app/qgsmeasuretool.h b/src/app/qgsmeasuretool.h index 72900357bc8..ca35cb8bd06 100644 --- a/src/app/qgsmeasuretool.h +++ b/src/app/qgsmeasuretool.h @@ -105,7 +105,7 @@ class APP_EXPORT QgsMeasureTool : public QgsMapTool //@param p (pixel) coordinate QgsPoint snapPoint( QPoint p ); - /** Removes the last vertex from mRubberBand*/ + //! Removes the last vertex from mRubberBand void undo(); }; diff --git a/src/app/qgsmergeattributesdialog.h b/src/app/qgsmergeattributesdialog.h index 20e7243328c..7e0d4f13e6d 100644 --- a/src/app/qgsmergeattributesdialog.h +++ b/src/app/qgsmergeattributesdialog.h @@ -30,7 +30,7 @@ class QgsVectorLayer; class QComboBox; -/** A dialog to insert the merge behaviour for attributes (e.g. for the union features editing tool)*/ +//! A dialog to insert the merge behaviour for attributes (e.g. for the union features editing tool) class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeAttributesDialogBase { Q_OBJECT @@ -38,7 +38,7 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA enum ItemDataRole { - FieldIndex = Qt::UserRole /*!< index of corresponding field in source table */ + FieldIndex = Qt::UserRole //!< Index of corresponding field in source table }; @@ -68,16 +68,16 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA private: QgsMergeAttributesDialog(); //default constructor forbidden void createTableWidgetContents(); - /** Create new combo box with the options for featureXX / mean / min / max */ + //! Create new combo box with the options for featureXX / mean / min / max QComboBox* createMergeComboBox( QVariant::Type columnType ) const; /** Returns the table widget column index of a combo box @return the column index or -1 in case of error*/ int findComboColumn( QComboBox* c ) const; - /** Calculates the merged value of a column (depending on the selected merge behaviour) and inserts the value in the corresponding cell*/ + //! Calculates the merged value of a column (depending on the selected merge behaviour) and inserts the value in the corresponding cell void refreshMergedValue( int col ); - /** Inserts the attribute value of a specific feature into the row of merged attributes*/ + //! Inserts the attribute value of a specific feature into the row of merged attributes QVariant featureAttribute( QgsFeatureId featureId, int col ); - /** Appends the values of the features for the final value*/ + //! Appends the values of the features for the final value QVariant concatenationAttribute( int col ); /** Calculates a summary statistic for a column. Returns null if no valid numerical @@ -85,13 +85,13 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA */ QVariant calcStatistic( int col, QgsStatisticalSummary::Statistic stat ); - /** Sets mSelectionRubberBand to a new feature*/ + //! Sets mSelectionRubberBand to a new feature void createRubberBandForFeature( QgsFeatureId featureId ); QgsFeatureList mFeatureList; QgsVectorLayer* mVectorLayer; QgsMapCanvas* mMapCanvas; - /** Item that highlights the selected feature in the merge table*/ + //! Item that highlights the selected feature in the merge table QgsRubberBand* mSelectionRubberBand; QgsFields mFields; diff --git a/src/app/qgsnewspatialitelayerdialog.h b/src/app/qgsnewspatialitelayerdialog.h index 570ec34d6ce..d1f6dacf3c0 100644 --- a/src/app/qgsnewspatialitelayerdialog.h +++ b/src/app/qgsnewspatialitelayerdialog.h @@ -52,10 +52,10 @@ class APP_EXPORT QgsNewSpatialiteLayerDialog: public QDialog, private Ui::QgsNew void on_buttonBox_rejected(); private: - /** Returns the selected geometry type*/ + //! Returns the selected geometry type QString selectedType() const; - /** Create a new database */ + //! Create a new database bool createDb(); bool apply(); diff --git a/src/app/qgsoptions.h b/src/app/qgsoptions.h index 73a48a12068..d9b2a479479 100644 --- a/src/app/qgsoptions.h +++ b/src/app/qgsoptions.h @@ -81,7 +81,7 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption */ void on_mProjectOnLaunchCmbBx_currentIndexChanged( int indx ); - /** Slot to choose path to project to open after launch */ + //! Slot to choose path to project to open after launch void on_mProjectOnLaunchPushBtn_pressed(); /** @@ -91,42 +91,42 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption */ bool newVisible(); - /** Slot to select the default font point size for app */ + //! Slot to select the default font point size for app void on_spinFontSize_valueChanged( int fontSize ); - /** Slot to set font family for app to Qt default */ + //! Slot to set font family for app to Qt default void on_mFontFamilyRadioQt_released(); - /** Slot to set font family for app to custom choice */ + //! Slot to set font family for app to custom choice void on_mFontFamilyRadioCustom_released(); - /** Slot to select custom font family choice for app */ + //! Slot to select custom font family choice for app void on_mFontFamilyComboBox_currentFontChanged( const QFont& font ); - /** Slot to set whether to use custom group boxes */ + //! Slot to set whether to use custom group boxes void on_mCustomGroupBoxChkBx_clicked( bool chkd ); void on_mProxyTypeComboBox_currentIndexChanged( int idx ); - /** Add a new URL to exclude from Proxy*/ + //! Add a new URL to exclude from Proxy void on_mAddUrlPushButton_clicked(); - /** Remove an URL to exclude from Proxy*/ + //! Remove an URL to exclude from Proxy void on_mRemoveUrlPushButton_clicked(); - /** Slot to flag restoring/delete window state settings upon restart*/ + //! Slot to flag restoring/delete window state settings upon restart void on_mRestoreDefaultWindowStateBtn_clicked(); - /** Slot to enable custom environment variables table and buttons */ + //! Slot to enable custom environment variables table and buttons void on_mCustomVariablesChkBx_toggled( bool chkd ); - /** Slot to add a custom environment variable to the app */ + //! Slot to add a custom environment variable to the app void on_mAddCustomVarBtn_clicked(); - /** Slot to remove a custom environment variable from the app */ + //! Slot to remove a custom environment variable from the app void on_mRemoveCustomVarBtn_clicked(); - /** Slot to filter out current environment variables not specific to QGIS */ + //! Slot to filter out current environment variables not specific to QGIS void on_mCurrentVariablesQGISChxBx_toggled( bool qgisSpecific ); /* Let the user add a path to the list of search paths @@ -177,16 +177,16 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption * used in scale combobox */ void on_pbnDefaultScaleValues_clicked(); - /** Let the user load scales from file */ + //! Let the user load scales from file void on_pbnImportScales_clicked(); - /** Let the user load scales from file */ + //! Let the user load scales from file void on_pbnExportScales_clicked(); - /** Auto slot executed when the active page in the option section widget is changed */ + //! Auto slot executed when the active page in the option section widget is changed void on_mOptionsStackedWidget_currentChanged( int theIndx ); - /** A scale in the list of predefined scales changed */ + //! A scale in the list of predefined scales changed void scaleItemChanged( QListWidgetItem* changedScaleItem ); /* Load the list of drivers available in GDAL */ @@ -209,7 +209,7 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption QgsCoordinateReferenceSystem mLayerDefaultCrs; bool mLoadedGdalDriverList; - /** Generate table row for custom environment variables */ + //! Generate table row for custom environment variables void addCustomEnvVarRow( const QString& varName, const QString& varVal, const QString& varApply = QString() ); void saveDefaultDatumTransformations(); diff --git a/src/app/qgspointrotationitem.h b/src/app/qgspointrotationitem.h index 2b83afda26c..d8fa69bdcbd 100644 --- a/src/app/qgspointrotationitem.h +++ b/src/app/qgspointrotationitem.h @@ -20,7 +20,7 @@ #include #include -/** An item that shows a rotated point symbol (e.g. arrow) centered to a map location together with a text displaying the rotation value*/ +//! An item that shows a rotated point symbol (e.g. arrow) centered to a map location together with a text displaying the rotation value class APP_EXPORT QgsPointRotationItem: public QgsMapCanvasItem { public: @@ -36,14 +36,14 @@ class APP_EXPORT QgsPointRotationItem: public QgsMapCanvasItem void paint( QPainter * painter ) override; - /** Sets the center point of the rotation symbol (in map coordinates)*/ + //! Sets the center point of the rotation symbol (in map coordinates) void setPointLocation( const QgsPoint& p ); /** Sets the rotation of the symbol and displays the new rotation number. Units are degrees, starting from north direction, clockwise direction*/ void setSymbolRotation( int r ) {mRotation = r;} - /** Sets rotation symbol from image (takes ownership)*/ + //! Sets rotation symbol from image (takes ownership) void setSymbol( const QImage& symbolImage ); void setOrientation( Orientation o ) { mOrientation = o; } @@ -51,13 +51,13 @@ class APP_EXPORT QgsPointRotationItem: public QgsMapCanvasItem private: QgsPointRotationItem(); - /** Converts rotation into QPainter rotation considering mOrientation*/ + //! Converts rotation into QPainter rotation considering mOrientation int painterRotation( int rotation ) const; - /** Clockwise (default) or counterclockwise*/ + //! Clockwise (default) or counterclockwise Orientation mOrientation; - /** Font to display the numerical rotation values*/ + //! Font to display the numerical rotation values QFont mFont; - /** Symboll pixmap*/ + //! Symboll pixmap QPixmap mPixmap; int mRotation; }; diff --git a/src/app/qgsprojectlayergroupdialog.h b/src/app/qgsprojectlayergroupdialog.h index 66c1e0c7e5c..9ca1fc34216 100644 --- a/src/app/qgsprojectlayergroupdialog.h +++ b/src/app/qgsprojectlayergroupdialog.h @@ -22,12 +22,12 @@ class QDomElement; class QgsLayerTreeGroup; -/** A dialog to select layers and groups from a qgs project*/ +//! A dialog to select layers and groups from a qgs project class APP_EXPORT QgsProjectLayerGroupDialog: public QDialog, private Ui::QgsProjectLayerGroupDialogBase { Q_OBJECT public: - /** Constructor. If a project file is given, the groups/layers are displayed directly and the file selection hidden*/ + //! Constructor. If a project file is given, the groups/layers are displayed directly and the file selection hidden QgsProjectLayerGroupDialog( QWidget * parent = nullptr, const QString& projectFile = QString(), Qt::WindowFlags f = 0 ); ~QgsProjectLayerGroupDialog(); diff --git a/src/app/qgsprojectproperties.h b/src/app/qgsprojectproperties.h index cbebec59d56..54a086fbf66 100644 --- a/src/app/qgsprojectproperties.h +++ b/src/app/qgsprojectproperties.h @@ -61,10 +61,10 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui: QString title() const; void title( QString const & title ); - /** Accessor for projection */ + //! Accessor for projection QString projectionWkt(); - /** Indicates that the projection switch is on */ + //! Indicates that the projection switch is on bool isProjected(); public slots: @@ -86,13 +86,13 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui: * used in scale combobox instead of global ones */ void on_pbnRemoveScale_clicked(); - /** Let the user load scales from file */ + //! Let the user load scales from file void on_pbnImportScales_clicked(); - /** Let the user load scales from file */ + //! Let the user load scales from file void on_pbnExportScales_clicked(); - /** A scale in the list of project scales changed */ + //! A scale in the list of project scales changed void scaleItemChanged( QListWidgetItem* changedScaleItem ); /*! @@ -183,10 +183,10 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui: //! Formats for displaying coordinates enum CoordinateFormat { - DecimalDegrees, /*!< Decimal degrees */ - DegreesMinutes, /*!< Degrees, decimal minutes */ - DegreesMinutesSeconds, /*!< Degrees, minutes, seconds */ - MapUnits, /*! Show coordinates in map units */ + DecimalDegrees, //!< Decimal degrees + DegreesMinutes, //!< Degrees, decimal minutes + DegreesMinutesSeconds, //!< Degrees, minutes, seconds + MapUnits, //! Show coordinates in map units }; QgsRelationManagerDialog *mRelationManagerDlg; diff --git a/src/app/qgsrastercalcdialog.h b/src/app/qgsrastercalcdialog.h index 3c0d47bd40a..f2dbfcaa32a 100644 --- a/src/app/qgsrastercalcdialog.h +++ b/src/app/qgsrastercalcdialog.h @@ -21,7 +21,7 @@ #include "ui_qgsrastercalcdialogbase.h" #include "qgsrastercalculator.h" -/** A dialog to enter a raster calculation expression*/ +//! A dialog to enter a raster calculation expression class APP_EXPORT QgsRasterCalcDialog: public QDialog, private Ui::QgsRasterCalcDialogBase { Q_OBJECT @@ -35,11 +35,11 @@ class APP_EXPORT QgsRasterCalcDialog: public QDialog, private Ui::QgsRasterCalcD QgsCoordinateReferenceSystem outputCrs() const; bool addLayerToProject() const; - /** Bounding box for output raster*/ + //! Bounding box for output raster QgsRectangle outputRectangle() const; - /** Number of pixels in x-direction*/ + //! Number of pixels in x-direction int numberOfColumns() const; - /** Number of pixels in y-direction*/ + //! Number of pixels in y-direction int numberOfRows() const; QVector rasterEntries() const; @@ -51,7 +51,7 @@ class APP_EXPORT QgsRasterCalcDialog: public QDialog, private Ui::QgsRasterCalcD void on_mCurrentLayerExtentButton_clicked(); void on_mExpressionTextEdit_textChanged(); void on_mOutputLayerLineEdit_textChanged( const QString& text ); - /** Enables ok button if calculator expression is valid and output file path exists*/ + //! Enables ok button if calculator expression is valid and output file path exists void setAcceptButtonState(); //calculator buttons @@ -83,17 +83,17 @@ class APP_EXPORT QgsRasterCalcDialog: public QDialog, private Ui::QgsRasterCalcD private: //insert available GDAL drivers that support the create() option void insertAvailableOutputFormats(); - /** Accesses the available raster layers/bands from the layer registry*/ + //! Accesses the available raster layers/bands from the layer registry void insertAvailableRasterBands(); - /** Returns true if raster calculator expression has valid syntax*/ + //! Returns true if raster calculator expression has valid syntax bool expressionValid() const; - /** Returns true if output file directory exists*/ + //! Returns true if output file directory exists bool filePathValid() const; static QString quoteBandEntry( const QString& layerName ); - /** Stores relation between driver name and extension*/ + //! Stores relation between driver name and extension QMap mDriverExtensionMap; QList mAvailableRasterBands; diff --git a/src/app/qgsrasterlayerproperties.h b/src/app/qgsrasterlayerproperties.h index 00dc6407fdd..9ce8db5286c 100644 --- a/src/app/qgsrasterlayerproperties.h +++ b/src/app/qgsrasterlayerproperties.h @@ -47,105 +47,105 @@ class APP_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private * @param ml Map layer for which properties will be displayed */ QgsRasterLayerProperties( QgsMapLayer *lyr, QgsMapCanvas* theCanvas, QWidget *parent = nullptr, Qt::WindowFlags = QgisGui::ModalDialogFlags ); - /** \brief Destructor */ + //! \brief Destructor ~QgsRasterLayerProperties(); - /** Synchronize state with associated raster layer */ + //! Synchronize state with associated raster layer void sync(); public slots: //TODO: Verify that these all need to be public - /** \brief Applies the settings made in the dialog without closing the box */ + //! \brief Applies the settings made in the dialog without closing the box void apply(); - /** Called when cancel button is pressed */ + //! Called when cancel button is pressed void onCancel(); - /** \brief Slot to update layer display name as original is edited. */ + //! \brief Slot to update layer display name as original is edited. void on_mLayerOrigNameLineEd_textEdited( const QString& text ); - /** \brief this slot asks the rasterlayer to construct pyramids */ + //! \brief this slot asks the rasterlayer to construct pyramids void on_buttonBuildPyramids_clicked(); - /** \brief slot executed when user presses "Add Values From Display" button on the transparency page */ + //! \brief slot executed when user presses "Add Values From Display" button on the transparency page void on_pbnAddValuesFromDisplay_clicked(); - /** \brief slot executed when user presses "Add Values Manually" button on the transparency page */ + //! \brief slot executed when user presses "Add Values Manually" button on the transparency page void on_pbnAddValuesManually_clicked(); - /** \brief slot executed when user changes the layer's CRS */ + //! \brief slot executed when user changes the layer's CRS void on_mCrsSelector_crsChanged( const QgsCoordinateReferenceSystem& crs ); - /** \brief slot executed when user wishes to reset noNoDataValue and transparencyTable to default value */ + //! \brief slot executed when user wishes to reset noNoDataValue and transparencyTable to default value void on_pbnDefaultValues_clicked(); - /** \brief slot executed when user wishes to export transparency values */ + //! \brief slot executed when user wishes to export transparency values void on_pbnExportTransparentPixelValues_clicked(); - /** \brief auto slot executed when the active page in the main widget stack is changed */ + //! \brief auto slot executed when the active page in the main widget stack is changed void mOptionsStackedWidget_CurrentChanged( int indx ); - /** \brief slow executed when user wishes to import transparency values */ + //! \brief slow executed when user wishes to import transparency values void on_pbnImportTransparentPixelValues_clicked(); - /** \brief slot executed when user presses "Remove Selected Row" button on the transparency page */ + //! \brief slot executed when user presses "Remove Selected Row" button on the transparency page void on_pbnRemoveSelectedRow_clicked(); - /** \brief slot executed when the single band radio button is pressed. */ - /** \brief slot executed when the reset null value to file default icon is selected */ + //! \brief slot executed when the single band radio button is pressed. + //! \brief slot executed when the reset null value to file default icon is selected //void on_btnResetNull_clicked(); void pixelSelected( const QgsPoint& ); - /** \brief slot executed when the transparency level changes. */ + //! \brief slot executed when the transparency level changes. void sliderTransparency_valueChanged( int ); private slots: void on_mRenderTypeComboBox_currentIndexChanged( int index ); - /** Load the default style when appropriate button is pressed. */ + //! Load the default style when appropriate button is pressed. void loadDefaultStyle_clicked(); - /** Save the default style when appropriate button is pressed. */ + //! Save the default style when appropriate button is pressed. void saveDefaultStyle_clicked(); - /** Load a saved style when appropriate button is pressed. */ + //! Load a saved style when appropriate button is pressed. void loadStyle_clicked(); - /** Save a style when appriate button is pressed. */ + //! Save a style when appriate button is pressed. void saveStyleAs_clicked(); - /** Help button */ + //! Help button void on_buttonBox_helpRequested() { QgsContextHelp::run( metaObject()->className() ); } - /** Slot to reset all color rendering options to default */ + //! Slot to reset all color rendering options to default void on_mResetColorRenderingBtn_clicked(); - /** Enable or disable Build pyramids button depending on selection in pyramids list*/ + //! Enable or disable Build pyramids button depending on selection in pyramids list void toggleBuildPyramidsButton(); - /** Enable or disable saturation controls depending on choice of grayscale mode */ + //! Enable or disable saturation controls depending on choice of grayscale mode void toggleSaturationControls( int grayscaleMode ); - /** Enable or disable colorize controls depending on checkbox */ + //! Enable or disable colorize controls depending on checkbox void toggleColorizeControls( bool colorizeEnabled ); - /** Transparency cell changed */ + //! Transparency cell changed void transparencyCellTextEdited( const QString & text ); void aboutToShowStyleMenu(); - /** Make GUI reflect the layer's state */ + //! Make GUI reflect the layer's state void syncToLayer(); signals: - /** Emitted when changes to layer were saved to update legend */ + //! Emitted when changes to layer were saved to update legend void refreshLegend( const QString& layerID, bool expandItem ); private: - /** \brief A constant that signals property not used */ + //! \brief A constant that signals property not used const QString TRSTRING_NOT_SET; - /** \brief Default contrast enhancement algorithm */ + //! \brief Default contrast enhancement algorithm QString mDefaultContrastEnhancementAlgorithm; - /** \brief default standard deviation */ + //! \brief default standard deviation double mDefaultStandardDeviation; - /** \brief Default band combination */ + //! \brief Default band combination int mDefaultRedBand; int mDefaultGreenBand; int mDefaultBlueBand; - /** \brief Flag to indicate if Gray minimum maximum values are actual minimum maximum values */ + //! \brief Flag to indicate if Gray minimum maximum values are actual minimum maximum values bool mGrayMinimumMaximumEstimated; - /** \brief Flag to indicate if RGB minimum maximum values are actual minimum maximum values */ + //! \brief Flag to indicate if RGB minimum maximum values are actual minimum maximum values bool mRGBMinimumMaximumEstimated; - /** \brief Pointer to the raster layer that this property dilog changes the behaviour of. */ + //! \brief Pointer to the raster layer that this property dilog changes the behaviour of. QgsRasterLayer * mRasterLayer; /** \brief If the underlying raster layer doesn't have a provider @@ -161,7 +161,7 @@ class APP_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private void setupTransparencyTable( int nBands ); - /** \brief Clear the current transparency table and populate the table with the correct types for current drawing mode and data type*/ + //! \brief Clear the current transparency table and populate the table with the correct types for current drawing mode and data type void populateTransparencyTable( QgsRasterRenderer* renderer ); void setTransparencyCell( int row, int column, double value ); diff --git a/src/app/qgssnappingwidget.h b/src/app/qgssnappingwidget.h index e1089a18883..189864f7c1a 100644 --- a/src/app/qgssnappingwidget.h +++ b/src/app/qgssnappingwidget.h @@ -54,7 +54,7 @@ class APP_EXPORT QgsSnappingWidget : public QWidget */ QgsSnappingWidget( QgsProject* project, QgsMapCanvas* canvas, QWidget* parent = nullptr ); - /** Destructor */ + //! Destructor virtual ~QgsSnappingWidget(); /** diff --git a/src/app/qgsstatusbarmagnifierwidget.h b/src/app/qgsstatusbarmagnifierwidget.h index fb48d9eba66..88784893922 100644 --- a/src/app/qgsstatusbarmagnifierwidget.h +++ b/src/app/qgsstatusbarmagnifierwidget.h @@ -40,7 +40,7 @@ class APP_EXPORT QgsStatusBarMagnifierWidget : public QWidget */ QgsStatusBarMagnifierWidget( QWidget* parent = nullptr ); - /** Destructor */ + //! Destructor virtual ~QgsStatusBarMagnifierWidget(); void setDefaultFactor( double factor ); diff --git a/src/app/qgsstatusbarscalewidget.h b/src/app/qgsstatusbarscalewidget.h index 1444043ad87..aa382b4d2a0 100644 --- a/src/app/qgsstatusbarscalewidget.h +++ b/src/app/qgsstatusbarscalewidget.h @@ -39,7 +39,7 @@ class APP_EXPORT QgsStatusBarScaleWidget : public QWidget public: explicit QgsStatusBarScaleWidget( QgsMapCanvas* canvas, QWidget *parent = 0 ); - /** Destructor */ + //! Destructor virtual ~QgsStatusBarScaleWidget(); /** diff --git a/src/app/qgstextannotationdialog.h b/src/app/qgstextannotationdialog.h index 381afbfd9d1..c673dc961dd 100644 --- a/src/app/qgstextannotationdialog.h +++ b/src/app/qgstextannotationdialog.h @@ -36,7 +36,7 @@ class APP_EXPORT QgsTextAnnotationDialog: public QDialog, private Ui::QgsTextAnn private: QgsTextAnnotationItem* mItem; - /** Text document (a clone of the annotation items document)*/ + //! Text document (a clone of the annotation items document) QTextDocument* mTextDocument; QgsAnnotationWidget* mEmbeddedWidget; diff --git a/src/app/qgstip.h b/src/app/qgstip.h index e90e71a37b9..c81ddbd8355 100644 --- a/src/app/qgstip.h +++ b/src/app/qgstip.h @@ -30,24 +30,24 @@ class APP_EXPORT QgsTip { public: - /** Constructor */ + //! Constructor QgsTip() {} - /** Destructor */ + //! Destructor ~QgsTip() {} // // Accessors // - /** Get the tip title */ + //! Get the tip title QString title() {return mTitle;} - /** Get the tip content */ + //! Get the tip content QString content() {return mContent;} // // Mutators // - /** Set the tip title */ + //! Set the tip title void setTitle( const QString& theTitle ) {mTitle = theTitle;} - /** Set the tip content*/ + //! Set the tip content void setContent( const QString& theContent ) {mContent = theContent;} private: QString mTitle; diff --git a/src/app/qgstipfactory.h b/src/app/qgstipfactory.h index 41ca9417fb5..b78635a5702 100644 --- a/src/app/qgstipfactory.h +++ b/src/app/qgstipfactory.h @@ -31,9 +31,9 @@ class APP_EXPORT QgsTipFactory : public QObject { Q_OBJECT //used for tr() so we don't need to do QObject::tr() public: - /** Constructor */ + //! Constructor QgsTipFactory(); - /** Destructor */ + //! Destructor ~QgsTipFactory(); /** Get a random tip (generic or gui-centric) * @return An QgsTip containing the tip diff --git a/src/app/qgsundowidget.h b/src/app/qgsundowidget.h index f395b91d6bc..5687bd7fc4e 100644 --- a/src/app/qgsundowidget.h +++ b/src/app/qgsundowidget.h @@ -59,7 +59,7 @@ class APP_EXPORT QgsUndoWidget : public QgsPanelWidget */ void destroyStack(); - /** Access to dock's contents */ + //! Access to dock's contents QWidget* dockContents() { return dockWidgetContents; } public slots: diff --git a/src/app/qgsvectorlayerproperties.h b/src/app/qgsvectorlayerproperties.h index 3dc282d5a58..ebfb3018c31 100644 --- a/src/app/qgsvectorlayerproperties.h +++ b/src/app/qgsvectorlayerproperties.h @@ -55,7 +55,7 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private QgsVectorLayerProperties( QgsVectorLayer *lyr = nullptr, QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags ); ~QgsVectorLayerProperties(); - /** Returns the display name entered in the dialog*/ + //! Returns the display name entered in the dialog QString displayName(); void setRendererDirty( bool ) {} @@ -69,26 +69,26 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private @return false in case of a non-existing attribute.*/ bool deleteAttribute( int attr ); - /** Adds a properties page factory to the vector layer properties dialog. */ + //! Adds a properties page factory to the vector layer properties dialog. void addPropertiesPageFactory( QgsMapLayerConfigWidgetFactory *factory ); public slots: void insertFieldOrExpression(); - /** Reset to original (vector layer) values */ + //! Reset to original (vector layer) values void syncToLayer(); - /** Get metadata about the layer in nice formatted html */ + //! Get metadata about the layer in nice formatted html QString metadata(); - /** Slot to update layer display name as original is edited */ + //! Slot to update layer display name as original is edited void on_mLayerOrigNameLineEdit_textEdited( const QString& text ); - /** Called when apply button is pressed or dialog is accepted */ + //! Called when apply button is pressed or dialog is accepted void apply(); - /** Called when cancel button is pressed */ + //! Called when cancel button is pressed void onCancel(); // @@ -115,20 +115,20 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private signals: - /** Emitted when changes to layer were saved to update legend */ + //! Emitted when changes to layer were saved to update legend void refreshLegend( const QString& layerID, bool expandItem ); void refreshLegend( const QString& layerID ); void toggleEditing( QgsMapLayer * ); private slots: - /** Toggle editing of layer */ + //! Toggle editing of layer void toggleEditing(); - /** Save the style based on selected format from the menu */ + //! Save the style based on selected format from the menu void saveStyleAsMenuTriggered( QAction * ); - /** Called when is possible to choice if load the style from filesystem or from db */ + //! Called when is possible to choice if load the style from filesystem or from db void loadStyleMenuTriggered( QAction * ); void aboutToShowStyleMenu(); @@ -146,7 +146,7 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private void saveStyleAs( StyleType styleType ); - /** When provider supports, it will list all the styles relative the layer in a dialog */ + //! When provider supports, it will list all the styles relative the layer in a dialog void showListOfStylesFromDatabase(); void updateSymbologyPage(); @@ -165,15 +165,15 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private QAction* mActionLoadStyle; QAction* mActionSaveStyleAs; - /** Renderer dialog which is shown*/ + //! Renderer dialog which is shown QgsRendererPropertiesDialog* mRendererDialog; - /** Labeling dialog. If apply is pressed, options are applied to vector's QgsLabel */ + //! Labeling dialog. If apply is pressed, options are applied to vector's QgsLabel QgsLabelingWidget* labelingDialog; - /** Actions dialog. If apply is pressed, the actions are stored for later use */ + //! Actions dialog. If apply is pressed, the actions are stored for later use QgsAttributeActionDialog* mActionDialog; - /** Diagram dialog. If apply is pressed, options are applied to vector's diagrams*/ + //! Diagram dialog. If apply is pressed, options are applied to vector's diagrams QgsDiagramProperties* diagramPropertiesDialog; - /** Fields dialog. If apply is pressed, options are applied to vector's diagrams*/ + //! Fields dialog. If apply is pressed, options are applied to vector's diagrams QgsFieldsProperties* mFieldsPropertiesDialog; //! List of joins of a layer at the time of creation of the dialog. Used to return joins to previous state if dialog is cancelled @@ -188,7 +188,7 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private void initDiagramTab(); - /** Adds a new join to mJoinTreeWidget*/ + //! Adds a new join to mJoinTreeWidget void addJoinToTreeWidget( const QgsVectorJoinInfo& join , const int insertIndex = -1 ); QgsExpressionContext mContext; diff --git a/src/core/auth/qgsauthcertutils.h b/src/core/auth/qgsauthcertutils.h index 9f50eb40729..8625c4587c8 100644 --- a/src/core/auth/qgsauthcertutils.h +++ b/src/core/auth/qgsauthcertutils.h @@ -35,7 +35,7 @@ class QgsAuthConfigSslServer; class CORE_EXPORT QgsAuthCertUtils { public: - /** Type of CA certificate source */ + //! Type of CA certificate source enum CaCertSource { SystemRoot = 0, @@ -44,7 +44,7 @@ class CORE_EXPORT QgsAuthCertUtils Connection = 3 }; - /** Type of certificate trust policy */ + //! Type of certificate trust policy enum CertTrustPolicy { DefaultTrust = 0, @@ -53,7 +53,7 @@ class CORE_EXPORT QgsAuthCertUtils NoPolicy = 3 }; - /** Type of certificate usage */ + //! Type of certificate usage enum CertUsageType { UndeterminedUsage = 0, @@ -69,7 +69,7 @@ class CORE_EXPORT QgsAuthCertUtils CRLSigningUsage }; - /** Type of certificate key group */ + //! Type of certificate key group enum ConstraintGroup { KeyUsage = 0, @@ -77,10 +77,10 @@ class CORE_EXPORT QgsAuthCertUtils }; - /** SSL Protocol name strings per enum */ + //! SSL Protocol name strings per enum static QString getSslProtocolName( QSsl::SslProtocol protocol ); - /** Map certificate sha1 to certificate as simple cache */ + //! Map certificate sha1 to certificate as simple cache static QMap mapDigestToCerts( const QList& certs ); /** Map certificates to their oraganization. @@ -97,10 +97,10 @@ class CORE_EXPORT QgsAuthCertUtils */ static QMap< QString, QList > sslConfigsGroupedByOrg( const QList& configs ); - /** Return list of concatenated certs from a PEM or DER formatted file */ + //! Return list of concatenated certs from a PEM or DER formatted file static QList certsFromFile( const QString &certspath ); - /** Return first cert from a PEM or DER formatted file */ + //! Return first cert from a PEM or DER formatted file static QSslCertificate certFromFile( const QString &certpath ); /** Return non-encrypted key from a PEM or DER formatted file @@ -112,7 +112,7 @@ class CORE_EXPORT QgsAuthCertUtils const QString &keypass = QString(), QString *algtype = nullptr ); - /** Return list of concatenated certs from a PEM Base64 text block */ + //! Return list of concatenated certs from a PEM Base64 text block static QList certsFromString( const QString &pemtext ); /** Return list of certificate, private key and algorithm (as PEM text) from file path components @@ -150,7 +150,7 @@ class CORE_EXPORT QgsAuthCertUtils */ static QString getCaSourceName( QgsAuthCertUtils::CaCertSource source , bool single = false ); - /** Get the general name via RFC 5280 resolution */ + //! Get the general name via RFC 5280 resolution static QString resolvedCertName( const QSslCertificate& cert, bool issuer = false ); /** Get combined distinguished name for certificate @@ -163,10 +163,10 @@ class CORE_EXPORT QgsAuthCertUtils const QCA::Certificate& acert = QCA::Certificate(), bool issuer = false ); - /** Get the general name for certificate trust */ + //! Get the general name for certificate trust static QString getCertTrustName( QgsAuthCertUtils::CertTrustPolicy trust ); - /** Get string with colon delimeters every 2 characters */ + //! Get string with colon delimeters every 2 characters static QString getColonDelimited( const QString& txt ); /** Get the sha1 hash for certificate @@ -210,25 +210,25 @@ class CORE_EXPORT QgsAuthCertUtils */ static QString certificateUsageTypeString( QgsAuthCertUtils::CertUsageType usagetype ); - /** Try to determine the certificates usage types */ + //! Try to determine the certificates usage types static QList certificateUsageTypes( const QSslCertificate& cert ); - /** Get whether a certificate is an Authority */ + //! Get whether a certificate is an Authority static bool certificateIsAuthority( const QSslCertificate& cert ); - /** Get whether a certificate can sign other certificates */ + //! Get whether a certificate can sign other certificates static bool certificateIsIssuer( const QSslCertificate& cert ); - /** Get whether a certificate is an Authority or can at least sign other certificates */ + //! Get whether a certificate is an Authority or can at least sign other certificates static bool certificateIsAuthorityOrIssuer( const QSslCertificate& cert ); - /** Get whether a certificate is probably used for a SSL server */ + //! Get whether a certificate is probably used for a SSL server static bool certificateIsSslServer( const QSslCertificate& cert ); - /** Get whether a certificate is probably used for a client identity */ + //! Get whether a certificate is probably used for a client identity static bool certificateIsSslClient( const QSslCertificate& cert ); - /** Get short strings describing an SSL error */ + //! Get short strings describing an SSL error static QString sslErrorEnumString( QSslError::SslError errenum ); /** Get short strings describing SSL errors. diff --git a/src/core/auth/qgsauthconfig.h b/src/core/auth/qgsauthconfig.h index 139c5d0e35a..1d5161c38be 100644 --- a/src/core/auth/qgsauthconfig.h +++ b/src/core/auth/qgsauthconfig.h @@ -44,10 +44,10 @@ class CORE_EXPORT QgsAuthMethodConfig */ QgsAuthMethodConfig( const QString& method = QString(), int version = 0 ); - /** Operator used to compare configs' equality */ + //! Operator used to compare configs' equality bool operator==( const QgsAuthMethodConfig& other ) const; - /** Operator used to compare configs' inequality */ + //! Operator used to compare configs' inequality bool operator!=( const QgsAuthMethodConfig& other ) const; /** @@ -55,25 +55,25 @@ class CORE_EXPORT QgsAuthMethodConfig * @note This is set by QgsAuthManager when the config is initially stored */ const QString id() const { return mId; } - /** Set auth config ID */ + //! Set auth config ID void setId( const QString& id ) { mId = id; } - /** Get name of configuration */ + //! Get name of configuration const QString name() const { return mName; } - /** Set name of configuration */ + //! Set name of configuration void setName( const QString& name ) { mName = name; } - /** A URI to auto-select a config when connecting to a resource */ + //! A URI to auto-select a config when connecting to a resource const QString uri() const { return mUri; } void setUri( const QString& uri ) { mUri = uri; } - /** Textual key of the associated authentication method */ + //! Textual key of the associated authentication method QString method() const { return mMethod; } void setMethod( const QString& method ) { mMethod = method; } - /** Get version of the configuration */ + //! Get version of the configuration int version() const { return mVersion; } - /** Set version of the configuration */ + //! Set version of the configuration void setVersion( int version ) { mVersion = version; } /** @@ -93,7 +93,7 @@ class CORE_EXPORT QgsAuthMethodConfig */ void loadConfigString( const QString& configstr ); - /** Get extended configuration, mapped to key/value pairs of QStrings */ + //! Get extended configuration, mapped to key/value pairs of QStrings QgsStringMap configMap() const { return mConfigMap; } /** * Set extended configuration map @@ -142,7 +142,7 @@ class CORE_EXPORT QgsAuthMethodConfig */ bool hasConfig( const QString &key ) const; - /** Clear all configs */ + //! Clear all configs void clearConfigMap() { mConfigMap.clear(); } /** @@ -213,28 +213,28 @@ class CORE_EXPORT QgsPkiBundle static const QgsPkiBundle fromPkcs12Paths( const QString &bundlepath, const QString &bundlepass = QString::null ); - /** Whether the bundle, either its certificate or private key, is null */ + //! Whether the bundle, either its certificate or private key, is null bool isNull() const; - /** Whether the bundle is valid */ + //! Whether the bundle is valid bool isValid() const; - /** The sha hash of the client certificate */ + //! The sha hash of the client certificate const QString certId() const; - /** Client certificate object */ + //! Client certificate object const QSslCertificate clientCert() const { return mCert; } - /** Set client certificate object */ + //! Set client certificate object void setClientCert( const QSslCertificate &cert ); - /** Private key object */ + //! Private key object const QSslKey clientKey() const { return mCertKey; } - /** Set private key object */ + //! Set private key object void setClientKey( const QSslKey &certkey ); - /** Chain of Certificate Authorities for client certificate */ + //! Chain of Certificate Authorities for client certificate const QList caChain() const { return mCaChain; } - /** Set chain of Certificate Authorities for client certificate */ + //! Set chain of Certificate Authorities for client certificate void setCaChain( const QList &cachain ) { mCaChain = cachain; } private: @@ -260,22 +260,22 @@ class CORE_EXPORT QgsPkiConfigBundle const QSslCertificate& cert, const QSslKey& certkey ); - /** Whether the bundle is valid */ + //! Whether the bundle is valid bool isValid(); - /** Authentication method configuration */ + //! Authentication method configuration const QgsAuthMethodConfig config() const { return mConfig; } - /** Set authentication method configuration */ + //! Set authentication method configuration void setConfig( const QgsAuthMethodConfig& config ) { mConfig = config; } - /** Client certificate object */ + //! Client certificate object const QSslCertificate clientCert() const { return mCert; } - /** Set client certificate object */ + //! Set client certificate object void setClientCert( const QSslCertificate& cert ) { mCert = cert; } - /** Private key object */ + //! Private key object const QSslKey clientCertKey() const { return mCertKey; } - /** Set private key object */ + //! Set private key object void setClientCertKey( const QSslKey& certkey ) { mCertKey = certkey; } private: @@ -291,36 +291,36 @@ class CORE_EXPORT QgsPkiConfigBundle class CORE_EXPORT QgsAuthConfigSslServer { public: - /** Construct a default SSL server configuration */ + //! Construct a default SSL server configuration QgsAuthConfigSslServer(); ~QgsAuthConfigSslServer() {} - /** Server certificate object */ + //! Server certificate object const QSslCertificate sslCertificate() const { return mSslCert; } - /** Set server certificate object */ + //! Set server certificate object void setSslCertificate( const QSslCertificate& cert ) { mSslCert = cert; } - /** Server host:port string */ + //! Server host:port string const QString sslHostPort() const { return mSslHostPort; } - /** Set server host:port string */ + //! Set server host:port string void setSslHostPort( const QString& hostport ) { mSslHostPort = hostport; } - /** SSL server protocol to use in connections */ + //! SSL server protocol to use in connections QSsl::SslProtocol sslProtocol() const { return mSslProtocol; } - /** Set SSL server protocol to use in connections */ + //! Set SSL server protocol to use in connections void setSslProtocol( QSsl::SslProtocol protocol ) { mSslProtocol = protocol; } - /** SSL server errors to ignore in connections */ + //! SSL server errors to ignore in connections const QList sslIgnoredErrors() const; - /** SSL server errors (as enum list) to ignore in connections */ + //! SSL server errors (as enum list) to ignore in connections const QList sslIgnoredErrorEnums() const { return mSslIgnoredErrors; } - /** Set SSL server errors (as enum list) to ignore in connections */ + //! Set SSL server errors (as enum list) to ignore in connections void setSslIgnoredErrorEnums( const QList& errors ) { mSslIgnoredErrors = errors; } - /** SSL client's peer verify mode to use in connections */ + //! SSL client's peer verify mode to use in connections QSslSocket::PeerVerifyMode sslPeerVerifyMode() const { return mSslPeerVerifyMode; } - /** Set SSL client's peer verify mode to use in connections */ + //! Set SSL client's peer verify mode to use in connections void setSslPeerVerifyMode( QSslSocket::PeerVerifyMode mode ) { mSslPeerVerifyMode = mode; } /** Number or SSL client's peer to verify in connections @@ -332,22 +332,22 @@ class CORE_EXPORT QgsAuthConfigSslServer */ void setSslPeerVerifyDepth( int depth ) { mSslPeerVerifyDepth = depth; } - /** Version of the configuration (used for future upgrading) */ + //! Version of the configuration (used for future upgrading) int version() const { return mVersion; } - /** Set version of the configuration (used for future upgrading) */ + //! Set version of the configuration (used for future upgrading) void setVersion( int version ) { mVersion = version; } - /** Qt version when the configuration was made (SSL protocols may differ) */ + //! Qt version when the configuration was made (SSL protocols may differ) int qtVersion() const { return mQtVersion; } - /** Set Qt version when the configuration was made (SSL protocols may differ) */ + //! Set Qt version when the configuration was made (SSL protocols may differ) void setQtVersion( int version ) { mQtVersion = version; } - /** Configuration as a concatenated string */ + //! Configuration as a concatenated string const QString configString() const; - /** Load concatenated string into configuration, e.g. from auth database */ + //! Load concatenated string into configuration, e.g. from auth database void loadConfigString( const QString& config = QString() ); - /** Whether configuration is null (missing components) */ + //! Whether configuration is null (missing components) bool isNull() const; private: diff --git a/src/core/auth/qgsauthcrypto.h b/src/core/auth/qgsauthcrypto.h index cbd2c678e50..0625804054c 100644 --- a/src/core/auth/qgsauthcrypto.h +++ b/src/core/auth/qgsauthcrypto.h @@ -29,22 +29,22 @@ class CORE_EXPORT QgsAuthCrypto { public: - /** Whether QCA has the qca-ossl plugin, which a base run-time requirement */ + //! Whether QCA has the qca-ossl plugin, which a base run-time requirement static bool isDisabled(); - /** Encrypt data using master password */ + //! Encrypt data using master password static const QString encrypt( const QString& pass, const QString& cipheriv, const QString& text ); - /** Decrypt data using master password */ + //! Decrypt data using master password static const QString decrypt( const QString& pass, const QString& cipheriv, const QString& text ); - /** Generate SHA256 hash for master password, with iterations and salt */ + //! Generate SHA256 hash for master password, with iterations and salt static void passwordKeyHash( const QString &pass, QString *salt, QString *hash, QString *cipheriv = nullptr ); - /** Verify existing master password hash to a re-generated one */ + //! Verify existing master password hash to a re-generated one static bool verifyPasswordKeyHash( const QString& pass, const QString& salt, const QString& hash, diff --git a/src/core/auth/qgsauthmanager.h b/src/core/auth/qgsauthmanager.h index fee03683487..0d41dd43de7 100644 --- a/src/core/auth/qgsauthmanager.h +++ b/src/core/auth/qgsauthmanager.h @@ -57,7 +57,7 @@ class CORE_EXPORT QgsAuthManager : public QObject public: - /** Message log level (mirrors that of QgsMessageLog, so it can also output there) */ + //! Message log level (mirrors that of QgsMessageLog, so it can also output there) enum MessageLevel { INFO = 0, @@ -72,22 +72,22 @@ class CORE_EXPORT QgsAuthManager : public QObject ~QgsAuthManager(); - /** Set up the application instance of the authentication database connection */ + //! Set up the application instance of the authentication database connection QSqlDatabase authDbConnection() const; - /** Name of the authentication database table that stores configs */ + //! Name of the authentication database table that stores configs const QString authDbConfigTable() const { return smAuthConfigTable; } - /** Name of the authentication database table that stores server exceptions/configs */ + //! Name of the authentication database table that stores server exceptions/configs const QString authDbServersTable() const { return smAuthServersTable; } - /** Initialize QCA, prioritize qca-ossl plugin and optionally set up the authentication database */ + //! Initialize QCA, prioritize qca-ossl plugin and optionally set up the authentication database bool init( const QString& pluginPath = QString::null ); - /** Whether QCA has the qca-ossl plugin, which a base run-time requirement */ + //! Whether QCA has the qca-ossl plugin, which a base run-time requirement bool isDisabled() const; - /** Standard message for when QCA's qca-ossl plugin is missing and system is disabled */ + //! Standard message for when QCA's qca-ossl plugin is missing and system is disabled const QString disabledMessage() const; /** The standard authentication database file in ~/.qgis3/ or defined location @@ -114,10 +114,10 @@ class CORE_EXPORT QgsAuthManager : public QObject */ bool verifyMasterPassword( const QString &compare = QString::null ); - /** Whether master password has be input and verified, i.e. authentication database is accessible */ + //! Whether master password has be input and verified, i.e. authentication database is accessible bool masterPasswordIsSet() const; - /** Verify a password hash existing in authentication database */ + //! Verify a password hash existing in authentication database bool masterPasswordHashInDb() const; /** Clear supplied master password @@ -166,16 +166,16 @@ class CORE_EXPORT QgsAuthManager : public QObject */ void setScheduledAuthDbEraseRequestEmitted( bool emitted ) { mScheduledDbEraseRequestEmitted = emitted; } - /** Simple text tag describing authentication system for message logs */ + //! Simple text tag describing authentication system for message logs QString authManTag() const { return smAuthManTag; } - /** Instantiate and register existing C++ core authentication methods from plugins */ + //! Instantiate and register existing C++ core authentication methods from plugins bool registerCoreAuthMethods(); - /** Get mapping of authentication config ids and their base configs (not decrypted data) */ + //! Get mapping of authentication config ids and their base configs (not decrypted data) QgsAuthMethodConfigsMap availableAuthMethodConfigs( const QString &dataprovider = QString() ); - /** Sync the confg/authentication method cache with what is in database */ + //! Sync the confg/authentication method cache with what is in database void updateConfigAuthMethods(); /** @@ -221,7 +221,7 @@ class CORE_EXPORT QgsAuthManager : public QObject */ QgsAuthMethod::Expansions supportedAuthMethodExpansions( const QString &authcfg ); - /** Get a unique generated 7-character string to assign to as config id */ + //! Get a unique generated 7-character string to assign to as config id const QString uniqueConfigId() const; /** @@ -236,10 +236,10 @@ class CORE_EXPORT QgsAuthManager : public QObject */ bool hasConfigId( const QString &txt ) const; - /** Return regular expression for authcfg=.{7} key/value token for authentication ids */ + //! Return regular expression for authcfg=.{7} key/value token for authentication ids QString configIdRegex() const { return smAuthCfgRegex;} - /** Get list of authentication ids from database */ + //! Get list of authentication ids from database QStringList configIds() const; /** @@ -327,28 +327,28 @@ class CORE_EXPORT QgsAuthManager : public QObject ////////////////// Generic settings /////////////////////// - /** Store an authentication setting (stored as string via QVariant( value ).toString() ) */ + //! Store an authentication setting (stored as string via QVariant( value ).toString() ) bool storeAuthSetting( const QString& key, const QVariant& value, bool encrypt = false ); - /** Get an authentication setting (retrieved as string and returned as QVariant( QString )) */ + //! Get an authentication setting (retrieved as string and returned as QVariant( QString )) QVariant getAuthSetting( const QString& key, const QVariant& defaultValue = QVariant(), bool decrypt = false ); - /** Check if an authentication setting exists */ + //! Check if an authentication setting exists bool existsAuthSetting( const QString& key ); - /** Remove an authentication setting */ + //! Remove an authentication setting bool removeAuthSetting( const QString& key ); #ifndef QT_NO_OPENSSL ////////////////// Certificate calls /////////////////////// - /** Initialize various SSL authentication caches */ + //! Initialize various SSL authentication caches bool initSslCaches(); - /** Store a certificate identity */ + //! Store a certificate identity bool storeCertIdentity( const QSslCertificate& cert, const QSslKey& key ); - /** Get a certificate identity by id (sha hash) */ + //! Get a certificate identity by id (sha hash) const QSslCertificate getCertIdentity( const QString& id ); /** Get a certificate identity bundle by id (sha hash). @@ -356,38 +356,38 @@ class CORE_EXPORT QgsAuthManager : public QObject */ const QPair getCertIdentityBundle( const QString& id ); - /** Get a certificate identity bundle by id (sha hash) returned as PEM text */ + //! Get a certificate identity bundle by id (sha hash) returned as PEM text const QStringList getCertIdentityBundleToPem( const QString& id ); - /** Get certificate identities */ + //! Get certificate identities const QList getCertIdentities(); - /** Get list of certificate identity ids from database */ + //! Get list of certificate identity ids from database QStringList getCertIdentityIds() const; - /** Check if a certificate identity exists */ + //! Check if a certificate identity exists bool existsCertIdentity( const QString& id ); - /** Remove a certificate identity */ + //! Remove a certificate identity bool removeCertIdentity( const QString& id ); - /** Store an SSL certificate custom config */ + //! Store an SSL certificate custom config bool storeSslCertCustomConfig( const QgsAuthConfigSslServer& config ); - /** Get an SSL certificate custom config by id (sha hash) and host:port */ + //! Get an SSL certificate custom config by id (sha hash) and host:port const QgsAuthConfigSslServer getSslCertCustomConfig( const QString& id, const QString &hostport ); - /** Get an SSL certificate custom config by host:port */ + //! Get an SSL certificate custom config by host:port const QgsAuthConfigSslServer getSslCertCustomConfigByHost( const QString& hostport ); - /** Get SSL certificate custom configs */ + //! Get SSL certificate custom configs const QList getSslCertCustomConfigs(); - /** Check if SSL certificate custom config exists */ + //! Check if SSL certificate custom config exists bool existsSslCertCustomConfig( const QString& id, const QString &hostport ); - /** Remove an SSL certificate custom config */ + //! Remove an SSL certificate custom config bool removeSslCertCustomConfig( const QString& id, const QString &hostport ); /** Get ignored SSL error cache, keyed with cert/connection's sha:host:port. @@ -395,44 +395,44 @@ class CORE_EXPORT QgsAuthManager : public QObject */ QHash > getIgnoredSslErrorCache() { return mIgnoredSslErrorsCache; } - /** Utility function to dump the cache for debug purposes */ + //! Utility function to dump the cache for debug purposes void dumpIgnoredSslErrorsCache_(); - /** Update ignored SSL error cache with possible ignored SSL errors, using server config */ + //! Update ignored SSL error cache with possible ignored SSL errors, using server config bool updateIgnoredSslErrorsCacheFromConfig( const QgsAuthConfigSslServer &config ); - /** Update ignored SSL error cache with possible ignored SSL errors, using sha:host:port key */ + //! Update ignored SSL error cache with possible ignored SSL errors, using sha:host:port key bool updateIgnoredSslErrorsCache( const QString &shahostport, const QList &errors ); - /** Rebuild ignoredSSL error cache */ + //! Rebuild ignoredSSL error cache bool rebuildIgnoredSslErrorCache(); - /** Store multiple certificate authorities */ + //! Store multiple certificate authorities bool storeCertAuthorities( const QList& certs ); - /** Store a certificate authority */ + //! Store a certificate authority bool storeCertAuthority( const QSslCertificate& cert ); - /** Get a certificate authority by id (sha hash) */ + //! Get a certificate authority by id (sha hash) const QSslCertificate getCertAuthority( const QString& id ); - /** Check if a certificate authority exists */ + //! Check if a certificate authority exists bool existsCertAuthority( const QSslCertificate& cert ); - /** Remove a certificate authority */ + //! Remove a certificate authority bool removeCertAuthority( const QSslCertificate& cert ); - /** Get root system certificate authorities */ + //! Get root system certificate authorities const QList getSystemRootCAs(); - /** Get extra file-based certificate authorities */ + //! Get extra file-based certificate authorities const QList getExtraFileCAs(); - /** Get database-stored certificate authorities */ + //! Get database-stored certificate authorities const QList getDatabaseCAs(); - /** Get sha1-mapped database-stored certificate authorities */ + //! Get sha1-mapped database-stored certificate authorities const QMap getMappedDatabaseCAs(); /** Get all CA certs mapped to their sha1 from cache. @@ -443,10 +443,10 @@ class CORE_EXPORT QgsAuthManager : public QObject return mCaCertsCache; } - /** Rebuild certificate authority cache */ + //! Rebuild certificate authority cache bool rebuildCaCertsCache(); - /** Store user trust value for a certificate */ + //! Store user trust value for a certificate bool storeCertTrustPolicy( const QSslCertificate& cert, QgsAuthCertUtils::CertTrustPolicy policy ); /** Get a whether certificate is trusted by user @@ -454,45 +454,45 @@ class CORE_EXPORT QgsAuthManager : public QObject */ QgsAuthCertUtils::CertTrustPolicy getCertTrustPolicy( const QSslCertificate& cert ); - /** Remove a group certificate authorities */ + //! Remove a group certificate authorities bool removeCertTrustPolicies( const QList& certs ); - /** Remove a certificate authority */ + //! Remove a certificate authority bool removeCertTrustPolicy( const QSslCertificate& cert ); - /** Get trust policy for a particular certificate */ + //! Get trust policy for a particular certificate QgsAuthCertUtils::CertTrustPolicy getCertificateTrustPolicy( const QSslCertificate& cert ); - /** Set the default certificate trust policy perferred by user */ + //! Set the default certificate trust policy perferred by user bool setDefaultCertTrustPolicy( QgsAuthCertUtils::CertTrustPolicy policy ); - /** Get the default certificate trust policy perferred by user */ + //! Get the default certificate trust policy perferred by user QgsAuthCertUtils::CertTrustPolicy defaultCertTrustPolicy(); - /** Get cache of certificate sha1s, per trust policy */ + //! Get cache of certificate sha1s, per trust policy const QMap getCertTrustCache() { return mCertTrustCache; } - /** Rebuild certificate authority cache */ + //! Rebuild certificate authority cache bool rebuildCertTrustCache(); - /** Get list of all trusted CA certificates */ + //! Get list of all trusted CA certificates const QList getTrustedCaCerts( bool includeinvalid = false ); - /** Get list of all untrusted CA certificates */ + //! Get list of all untrusted CA certificates const QList getUntrustedCaCerts( QList trustedCAs = QList() ); - /** Rebuild trusted certificate authorities cache */ + //! Rebuild trusted certificate authorities cache bool rebuildTrustedCaCertsCache(); - /** Get cache of trusted certificate authorities, ready for network connections */ + //! Get cache of trusted certificate authorities, ready for network connections const QList getTrustedCaCertsCache() { return mTrustedCaCertsCache; } - /** Get concatenated string of all trusted CA certificates */ + //! Get concatenated string of all trusted CA certificates const QByteArray getTrustedCaCertsPemText(); #endif - /** Return pointer to mutex */ + //! Return pointer to mutex QMutex *mutex() { return mMutex; } signals: @@ -511,17 +511,17 @@ class CORE_EXPORT QgsAuthManager : public QObject */ void masterPasswordVerified( bool verified ) const; - /** Emitted when a user has indicated they may want to erase the authentication db. */ + //! Emitted when a user has indicated they may want to erase the authentication db. void authDatabaseEraseRequested() const; - /** Emitted when the authentication db is significantly changed, e.g. large record removal, erased, etc. */ + //! Emitted when the authentication db is significantly changed, e.g. large record removal, erased, etc. void authDatabaseChanged() const; public slots: - /** Clear all authentication configs from authentication method caches */ + //! Clear all authentication configs from authentication method caches void clearAllCachedConfigs(); - /** Clear an authentication config from its associated authentication method cache */ + //! Clear an authentication config from its associated authentication method cache void clearCachedConfig( const QString& authcfg ); private slots: diff --git a/src/core/auth/qgsauthmethod.h b/src/core/auth/qgsauthmethod.h index f40e592140b..7178279c96e 100644 --- a/src/core/auth/qgsauthmethod.h +++ b/src/core/auth/qgsauthmethod.h @@ -55,16 +55,16 @@ class CORE_EXPORT QgsAuthMethod : public QObject virtual ~QgsAuthMethod() {} - /** A non-translated short name representing the auth method */ + //! A non-translated short name representing the auth method virtual QString key() const = 0; - /** A non-translated short description representing the auth method for use in debug output and About dialog */ + //! A non-translated short description representing the auth method for use in debug output and About dialog virtual QString description() const = 0; - /** Translatable display version of the 'description()' */ + //! Translatable display version of the 'description()' virtual QString displayDescription() const = 0; - /** Increment this if method is significantly updated, allow updater code to be written for previously stored authcfg */ + //! Increment this if method is significantly updated, allow updater code to be written for previously stored authcfg int version() const { return mVersion; } /** Flags that represent the update points (where authentication configurations are expanded) @@ -149,15 +149,15 @@ class CORE_EXPORT QgsAuthMethod : public QObject , mVersion( 0 ) {} - /** Tag signifying that this is an authentcation method (e.g. for use as title in message log panel output) */ + //! Tag signifying that this is an authentcation method (e.g. for use as title in message log panel output) static QString authMethodTag() { return QObject::tr( "Authentication method" ); } - /** Set the version of the auth method (useful for future upgrading) */ + //! Set the version of the auth method (useful for future upgrading) void setVersion( int version ) { mVersion = version; } - /** Set the support expansions (points in providers where the authentication is injected) of the auth method */ + //! Set the support expansions (points in providers where the authentication is injected) of the auth method void setExpansions( QgsAuthMethod::Expansions expansions ) { mExpansions = expansions; } - /** Set list of data providers this auth method supports */ + //! Set list of data providers this auth method supports void setDataProviders( const QStringList& dataproviders ) { mDataProviders = dataproviders; } QgsAuthMethod::Expansions mExpansions; diff --git a/src/core/auth/qgsauthmethodregistry.h b/src/core/auth/qgsauthmethodregistry.h index cee62da27a4..655d0c3b804 100644 --- a/src/core/auth/qgsauthmethodregistry.h +++ b/src/core/auth/qgsauthmethodregistry.h @@ -41,22 +41,22 @@ class CORE_EXPORT QgsAuthMethodRegistry { public: - /** Means of accessing canonical single instance */ + //! Means of accessing canonical single instance static QgsAuthMethodRegistry* instance( const QString& pluginPath = QString::null ); - /** Virtual dectructor */ + //! Virtual dectructor virtual ~QgsAuthMethodRegistry(); - /** Return path for the library of the auth method */ + //! Return path for the library of the auth method QString library( const QString & authMethodKey ) const; - /** Return list of auth method plugins found */ + //! Return list of auth method plugins found QString pluginList( bool asHtml = false ) const; - /** Return library directory where plugins are found */ + //! Return library directory where plugins are found const QDir & libraryDirectory() const; - /** Set library directory where to search for plugins */ + //! Set library directory where to search for plugins void setLibraryDirectory( const QDir & path ); /** Create an instance of the auth method @@ -94,28 +94,28 @@ class CORE_EXPORT QgsAuthMethodRegistry const QString & functionName ); #endif - /** Return the library object associated with an auth method key */ + //! Return the library object associated with an auth method key QLibrary *authMethodLibrary( const QString & authMethodKey ) const; - /** Return list of available auth methods by their keys */ + //! Return list of available auth methods by their keys QStringList authMethodList() const; - /** Return metadata of the auth method or nullptr if not found */ + //! Return metadata of the auth method or nullptr if not found const QgsAuthMethodMetadata* authMethodMetadata( const QString& authMethodKey ) const; // void registerGuis( QWidget *widget ); - /** Type for auth method metadata associative container */ + //! Type for auth method metadata associative container typedef std::map AuthMethods; private: - /** Ctor private since instance() creates it */ + //! Ctor private since instance() creates it QgsAuthMethodRegistry( const QString& pluginPath ); - /** Associative container of auth method metadata handles */ + //! Associative container of auth method metadata handles AuthMethods mAuthMethods; - /** Directory in which auth method plugins are installed */ + //! Directory in which auth method plugins are installed QDir mLibraryDirectory; }; diff --git a/src/core/composer/qgsatlascomposition.h b/src/core/composer/qgsatlascomposition.h index 3f82382080c..5d7568d44a2 100644 --- a/src/core/composer/qgsatlascomposition.h +++ b/src/core/composer/qgsatlascomposition.h @@ -189,10 +189,10 @@ class CORE_EXPORT QgsAtlasComposition : public QObject /** Begins the rendering. Returns true if successful, false if no matching atlas features found.*/ bool beginRender(); - /** Ends the rendering. Restores original extent */ + //! Ends the rendering. Restores original extent void endRender(); - /** Returns the number of features in the coverage layer */ + //! Returns the number of features in the coverage layer int numFeatures() const; /** Prepare the atlas map for the given feature. Sets the extent and context variables @@ -207,7 +207,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ bool prepareForFeature( const QgsFeature *feat ); - /** Returns the current filename. Must be called after prepareForFeature() */ + //! Returns the current filename. Must be called after prepareForFeature() QString currentFilename() const; void writeXml( QDomElement& elem, QDomDocument& doc ) const; @@ -251,10 +251,10 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ int currentFeatureNumber() const { return mCurrentFeatureNo; } - /** Recalculates the bounds of an atlas driven map */ + //! Recalculates the bounds of an atlas driven map void prepareMap( QgsComposerMap* map ); - /** Returns the current atlas geometry in the given projection system (default to the coverage layer's CRS) */ + //! Returns the current atlas geometry in the given projection system (default to the coverage layer's CRS) QgsGeometry currentGeometry( const QgsCoordinateReferenceSystem& projectedTo = QgsCoordinateReferenceSystem() ) const; public slots: @@ -270,25 +270,25 @@ class CORE_EXPORT QgsAtlasComposition : public QObject void firstFeature(); signals: - /** Emitted when one of the parameters changes */ + //! Emitted when one of the parameters changes void parameterChanged(); - /** Emitted when atlas is enabled or disabled */ + //! Emitted when atlas is enabled or disabled void toggled( bool ); - /** Is emitted when the atlas has an updated status bar message for the composer window*/ + //! Is emitted when the atlas has an updated status bar message for the composer window void statusMsgChanged( const QString& message ); - /** Is emitted when the coverage layer for an atlas changes*/ + //! Is emitted when the coverage layer for an atlas changes void coverageLayerChanged( QgsVectorLayer* layer ); - /** Is emitted when atlas rendering has begun*/ + //! Is emitted when atlas rendering has begun void renderBegun(); - /** Is emitted when atlas rendering has ended*/ + //! Is emitted when atlas rendering has ended void renderEnded(); - /** Is emitted when the current atlas feature changes*/ + //! Is emitted when the current atlas feature changes void featureChanged( QgsFeature* feature ); /** Is emitted when the number of features for the atlas changes. diff --git a/src/core/composer/qgscomposerarrow.h b/src/core/composer/qgscomposerarrow.h index a42ede46a08..6ee00119857 100644 --- a/src/core/composer/qgscomposerarrow.h +++ b/src/core/composer/qgscomposerarrow.h @@ -54,10 +54,10 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem ~QgsComposerArrow(); - /** Return composer item type. */ + //! Return composer item type. virtual int type() const override { return ComposerArrow; } - /** \brief Reimplementation of QCanvasItem::paint - draw on canvas */ + //! \brief Reimplementation of QCanvasItem::paint - draw on canvas void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; /** Modifies position of start and endpoint and calls QgsComposerItem::setSceneRect @@ -210,17 +210,17 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem QPen mPen; QBrush mBrush; - /** Width of the arrow marker in mm. May be specified by the user. The height is automatically adapted*/ + //! Width of the arrow marker in mm. May be specified by the user. The height is automatically adapted double mArrowHeadWidth; - /** Height of the arrow marker in mm. Is calculated from arrow marker width and apsect ratio of svg*/ + //! Height of the arrow marker in mm. Is calculated from arrow marker width and apsect ratio of svg double mStartArrowHeadHeight; double mStopArrowHeadHeight; - /** Path to the start marker file*/ + //! Path to the start marker file QString mStartMarkerFile; - /** Path to the end marker file*/ + //! Path to the end marker file QString mEndMarkerFile; - /** Default marker, no marker or svg marker*/ + //! Default marker, no marker or svg marker MarkerMode mMarkerMode; double mArrowHeadOutlineWidth; @@ -237,13 +237,13 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem * Needs to be called whenever the arrow width/height, the outline with or the endpoints are changed */ void adaptItemSceneRect(); - /** Computes the margin around the line necessary to include the markers */ + //! Computes the margin around the line necessary to include the markers double computeMarkerMargin() const; - /** Draws the default marker at the line end*/ + //! Draws the default marker at the line end void drawHardcodedMarker( QPainter* p, MarkerType type ); - /** Draws a user-defined marker (must be an svg file)*/ + //! Draws a user-defined marker (must be an svg file) void drawSVGMarker( QPainter* p, MarkerType type, const QString& markerPath ); - /** Apply default graphics settings*/ + //! Apply default graphics settings void init(); /** Creates the default line symbol * @note added in QGIS 2.5 diff --git a/src/core/composer/qgscomposerattributetablemodelv2.h b/src/core/composer/qgscomposerattributetablemodelv2.h index 75004d809f9..f1b6a648710 100644 --- a/src/core/composer/qgscomposerattributetablemodelv2.h +++ b/src/core/composer/qgscomposerattributetablemodelv2.h @@ -39,8 +39,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM */ enum ShiftDirection { - ShiftUp, /*!< shift the row/column up */ - ShiftDown /*!< shift the row/column down */ + ShiftUp, //!< Shift the row/column up + ShiftDown //!< Shift the row/column down }; /** Constructor for QgsComposerAttributeTableColumnModel. @@ -139,8 +139,8 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro */ enum ColumnFilterType { - ShowSortedColumns, /*!< show only sorted columns */ - ShowUnsortedColumns/*!< show only unsorted columns */ + ShowSortedColumns, //!< Show only sorted columns + ShowUnsortedColumns//!< Show only unsorted columns }; /** Constructor for QgsComposerTableSortColumnsProxyModel. diff --git a/src/core/composer/qgscomposerattributetablev2.h b/src/core/composer/qgscomposerattributetablev2.h index f975713d743..fde6a128b34 100644 --- a/src/core/composer/qgscomposerattributetablev2.h +++ b/src/core/composer/qgscomposerattributetablev2.h @@ -61,9 +61,9 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ enum ContentSource { - LayerAttributes = 0, /*!< table shows attributes from features in a vector layer */ - AtlasFeature, /*!< table shows attributes from the current atlas feature */ - RelationChildren /*!< table shows attributes from related child features */ + LayerAttributes = 0, //!< Table shows attributes from features in a vector layer + AtlasFeature, //!< Table shows attributes from the current atlas feature + RelationChildren //!< Table shows attributes from related child features }; QgsComposerAttributeTableV2( QgsComposition* composition, bool createUndoCommands ); @@ -300,33 +300,33 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 private: - /** Attribute source*/ + //! Attribute source ContentSource mSource; - /** Associated vector layer*/ + //! Associated vector layer QgsVectorLayer* mVectorLayer; - /** Relation id, if in relation children mode*/ + //! Relation id, if in relation children mode QString mRelationId; - /** Current vector layer, if in atlas feature mode*/ + //! Current vector layer, if in atlas feature mode QgsVectorLayer* mCurrentAtlasLayer; - /** Associated composer map (used to display the visible features)*/ + //! Associated composer map (used to display the visible features) const QgsComposerMap* mComposerMap; - /** Maximum number of features that is displayed*/ + //! Maximum number of features that is displayed int mMaximumNumberOfFeatures; - /** True if only unique rows should be shown*/ + //! True if only unique rows should be shown bool mShowUniqueRowsOnly; - /** Shows only the features that are visible in the associated composer map (true by default)*/ + //! Shows only the features that are visible in the associated composer map (true by default) bool mShowOnlyVisibleFeatures; - /** Shows only the features that intersect the current atlas feature*/ + //! Shows only the features that intersect the current atlas feature bool mFilterToAtlasIntersection; - /** True if feature filtering enabled*/ + //! True if feature filtering enabled bool mFilterFeatures; - /** Feature filter expression*/ + //! Feature filter expression QString mFeatureFilter; QString mWrapString; @@ -348,7 +348,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 QVariant replaceWrapChar( const QVariant &variant ) const; private slots: - /** Checks if this vector layer will be removed (and sets mVectorLayer to 0 if yes) */ + //! Checks if this vector layer will be removed (and sets mVectorLayer to 0 if yes) void removeLayer( const QString& layerId ); void atlasLayerChanged( QgsVectorLayer* layer ); diff --git a/src/core/composer/qgscomposereffect.h b/src/core/composer/qgscomposereffect.h index 7b8b1fdd8fa..d6069a6d43d 100644 --- a/src/core/composer/qgscomposereffect.h +++ b/src/core/composer/qgscomposereffect.h @@ -35,7 +35,7 @@ class CORE_EXPORT QgsComposerEffect : public QGraphicsEffect void setCompositionMode( QPainter::CompositionMode compositionMode ); protected: - /** Called whenever source needs to be drawn */ + //! Called whenever source needs to be drawn virtual void draw( QPainter *painter ) override; private: diff --git a/src/core/composer/qgscomposerframe.h b/src/core/composer/qgscomposerframe.h index 330b6d0a0e0..323565a59f5 100644 --- a/src/core/composer/qgscomposerframe.h +++ b/src/core/composer/qgscomposerframe.h @@ -108,9 +108,9 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem QgsComposerMultiFrame* mMultiFrame; QRectF mSection; - /** If true, composition will not export page if this frame is empty*/ + //! If true, composition will not export page if this frame is empty bool mHidePageIfEmpty; - /** If true, background and outside frame will not be drawn if frame is empty*/ + //! If true, background and outside frame will not be drawn if frame is empty bool mHideBackgroundIfEmpty; }; diff --git a/src/core/composer/qgscomposerhtml.h b/src/core/composer/qgscomposerhtml.h index f630c267faa..d083c6192f7 100644 --- a/src/core/composer/qgscomposerhtml.h +++ b/src/core/composer/qgscomposerhtml.h @@ -38,8 +38,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ enum ContentMode { - Url, /*!< Using this mode item fetches its content via a url*/ - ManualHtml /*!< HTML content is manually set for the item*/ + Url, //!< Using this mode item fetches its content via a url + ManualHtml //!< HTML content is manually set for the item }; QgsComposerHtml( QgsComposition* c, bool createUndoCommands ); @@ -219,7 +219,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ void loadHtml( const bool useCache = false, const QgsExpressionContext* context = nullptr ); - /** Recalculates the frame sizes for the current viewport dimensions*/ + //! Recalculates the frame sizes for the current viewport dimensions void recalculateFrameSizes() override; void refreshExpressionContext(); @@ -264,10 +264,10 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame //fetches html content from a url and returns it as a string QString fetchHtml( const QUrl& url ); - /** Sets the current feature, the current layer and a list of local variable substitutions for evaluating expressions */ + //! Sets the current feature, the current layer and a list of local variable substitutions for evaluating expressions void setExpressionContext( const QgsFeature& feature, QgsVectorLayer* layer ); - /** Calculates the max width of frames in the html multiframe*/ + //! Calculates the max width of frames in the html multiframe double maxFrameWidth() const; }; diff --git a/src/core/composer/qgscomposeritem.h b/src/core/composer/qgscomposeritem.h index 934f84de054..6a41e3be4fa 100644 --- a/src/core/composer/qgscomposeritem.h +++ b/src/core/composer/qgscomposeritem.h @@ -64,7 +64,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec ComposerFrame }; - /** Describes the action (move or resize in different directon) to be done during mouse move*/ + //! Describes the action (move or resize in different directon) to be done during mouse move enum MouseMoveAction { MoveItem, @@ -98,10 +98,10 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ enum ZoomMode { - Zoom = 0, /*!< Zoom to center of content */ - ZoomRecenter, /*!< Zoom and recenter content to point */ - ZoomToPoint, /*!< Zoom while maintaining relative position of point */ - NoZoom /*!< No zoom */ + Zoom = 0, //!< Zoom to center of content + ZoomRecenter, //!< Zoom and recenter content to point + ZoomToPoint, //!< Zoom while maintaining relative position of point + NoZoom //!< No zoom }; /** Constructor @@ -118,7 +118,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec QgsComposerItem( qreal x, qreal y, qreal width, qreal height, QgsComposition* composition, bool manageZValue = true ); virtual ~QgsComposerItem(); - /** Return correct graphics item type. */ + //! Return correct graphics item type. virtual int type() const override { return ComposerItem; } /** Returns whether this item has been removed from the composition. Items removed @@ -139,13 +139,13 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void setIsRemoved( const bool removed ) { mRemovedFromComposition = removed; } - /** \brief Set selected, selected item should be highlighted */ + //! \brief Set selected, selected item should be highlighted virtual void setSelected( bool s ); - /** \brief Is selected */ + //! \brief Is selected virtual bool selected() const { return QGraphicsRectItem::isSelected(); } - /** Moves item in canvas coordinates*/ + //! Moves item in canvas coordinates void move( double dx, double dy ); /** Move Content of item. Does nothing per default (but implemented in composer map) @@ -216,10 +216,10 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec corresponds to 1 scene size unit*/ virtual void setSceneRect( const QRectF& rectangle ); - /** Writes parameter that are not subclass specific in document. Usually called from writeXml methods of subclasses*/ + //! Writes parameter that are not subclass specific in document. Usually called from writeXml methods of subclasses bool _writeXml( QDomElement& itemElem, QDomDocument& doc ) const; - /** Reads parameter that are not subclass specific in document. Usually called from readXml methods of subclasses*/ + //! Reads parameter that are not subclass specific in document. Usually called from readXml methods of subclasses bool _readXml( const QDomElement& itemElem, const QDomDocument& doc ); /** Whether this item has a frame or not. @@ -389,7 +389,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void setEffectsEnabled( const bool effectsEnabled ); - /** Composite operations for item groups do nothing per default*/ + //! Composite operations for item groups do nothing per default virtual void addItem( QgsComposerItem* item ) { Q_UNUSED( item ); } virtual void removeItems() {} @@ -401,7 +401,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec void beginCommand( const QString& commandText, QgsComposerMergeCommand::Context c = QgsComposerMergeCommand::Unknown ); virtual void endItemCommand() { endCommand(); } - /** Finish current command and push it onto the undo stack */ + //! Finish current command and push it onto the undo stack void endCommand(); void cancelCommand(); @@ -430,7 +430,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ double itemRotation( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue ) const; - /** Updates item, with the possibility to do custom update for subclasses*/ + //! Updates item, with the possibility to do custom update for subclasses virtual void updateItem() { QGraphicsRectItem::update(); } /** Get item's id (which is not necessarly unique) @@ -546,52 +546,52 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec virtual void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext* context = nullptr ) override; protected: - /** True if item has been removed from the composition*/ + //! True if item has been removed from the composition bool mRemovedFromComposition; QgsComposerItem::MouseMoveAction mCurrentMouseMoveAction; - /** Start point of the last mouse move action (in scene coordinates)*/ + //! Start point of the last mouse move action (in scene coordinates) QPointF mMouseMoveStartPos; - /** Position of the last mouse move event (in scene coordinates)*/ + //! Position of the last mouse move event (in scene coordinates) QPointF mLastMouseEventPos; - /** Rectangle used during move and resize actions*/ + //! Rectangle used during move and resize actions QGraphicsRectItem* mBoundingResizeRectangle; QGraphicsLineItem* mHAlignSnapItem; QGraphicsLineItem* mVAlignSnapItem; - /** True if item fram needs to be painted*/ + //! True if item fram needs to be painted bool mFrame; - /** True if item background needs to be painted*/ + //! True if item background needs to be painted bool mBackground; - /** Background color*/ + //! Background color QColor mBackgroundColor; - /** Frame join style*/ + //! Frame join style Qt::PenJoinStyle mFrameJoinStyle; /** True if item position and size cannot be changed with mouse move */ bool mItemPositionLocked; - /** Backup to restore item appearance if no view scale factor is available*/ + //! Backup to restore item appearance if no view scale factor is available mutable double mLastValidViewScaleFactor; - /** Item rotation in degrees, clockwise*/ + //! Item rotation in degrees, clockwise double mItemRotation; /** Temporary evaluated item rotation in degrees, clockwise. Data defined rotation may mean * this value differs from mItemRotation. */ double mEvaluatedItemRotation; - /** Composition blend mode for item*/ + //! Composition blend mode for item QPainter::CompositionMode mBlendMode; bool mEffectsEnabled; QgsComposerEffect *mEffect; - /** Item transparency*/ + //! Item transparency int mTransparency; - /** Whether item should be excluded in exports*/ + //! Whether item should be excluded in exports bool mExcludeFromExports; /** Temporary evaluated item exclusion. Data defined properties may mean @@ -599,10 +599,10 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ bool mEvaluatedExcludeFromExports; - /** The item's position mode */ + //! The item's position mode ItemPositionMode mLastUsedPositionMode; - /** Whether or not this item is part of a group*/ + //! Whether or not this item is part of a group bool mIsGroupMember; /** The layer that needs to be exported @@ -616,10 +616,10 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual void drawSelectionBoxes( QPainter* p ); - /** Draw black frame around item*/ + //! Draw black frame around item virtual void drawFrame( QPainter* p ); - /** Draw background*/ + //! Draw background virtual void drawBackground( QPainter* p ); /** Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the @@ -633,10 +633,10 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //some utility functions - /** Return horizontal align snap item. Creates a new graphics line if 0*/ + //! Return horizontal align snap item. Creates a new graphics line if 0 QGraphicsLineItem* hAlignSnapItem(); void deleteHAlignSnapItem(); - /** Return vertical align snap item. Creates a new graphics line if 0*/ + //! Return vertical align snap item. Creates a new graphics line if 0 QGraphicsLineItem* vAlignSnapItem(); void deleteVAlignSnapItem(); void deleteAlignItems(); @@ -661,9 +661,9 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec bool shouldDrawItem() const; signals: - /** Is emitted on item rotation change*/ + //! Is emitted on item rotation change void itemRotationChanged( double newRotation ); - /** Emitted if the rectangle changes*/ + //! Emitted if the rectangle changes void sizeChanged(); /** Emitted if the item's frame style changes * @note: this function was introduced in version 2.2 diff --git a/src/core/composer/qgscomposeritemcommand.h b/src/core/composer/qgscomposeritemcommand.h index 711e33b8c56..c0675fd4188 100644 --- a/src/core/composer/qgscomposeritemcommand.h +++ b/src/core/composer/qgscomposeritemcommand.h @@ -33,20 +33,20 @@ class CORE_EXPORT QgsComposerItemCommand: public QUndoCommand QgsComposerItemCommand( QgsComposerItem* item, const QString& text, QUndoCommand* parent = nullptr ); virtual ~QgsComposerItemCommand(); - /** Reverses the command*/ + //! Reverses the command void undo() override; - /** Replays the command*/ + //! Replays the command void redo() override; - /** Saves current item state as previous state*/ + //! Saves current item state as previous state void savePreviousState(); - /** Saves current item state as after state*/ + //! Saves current item state as after state void saveAfterState(); QDomDocument previousState() const { return mPreviousState.cloneNode().toDocument(); } QDomDocument afterState() const { return mAfterState.cloneNode().toDocument(); } - /** Returns true if previous state and after state are valid and different*/ + //! Returns true if previous state and after state are valid and different bool containsChange() const; /** Returns the target item the command applies to. @@ -55,19 +55,19 @@ class CORE_EXPORT QgsComposerItemCommand: public QUndoCommand QgsComposerItem *item() const; protected: - /** Target item of the command*/ + //! Target item of the command QgsComposerItem* mItem; - /** XML that saves the state before executing the command*/ + //! XML that saves the state before executing the command QDomDocument mPreviousState; - /** XML containing the state after executing the command*/ + //! XML containing the state after executing the command QDomDocument mAfterState; - /** Parameters for frame items*/ - /** Parent multiframe*/ + //! Parameters for frame items + //! Parent multiframe QgsComposerMultiFrame* mMultiFrame; int mFrameNumber; - /** Flag to prevent the first redo() if the command is pushed to the undo stack*/ + //! Flag to prevent the first redo() if the command is pushed to the undo stack bool mFirstRun; void saveState( QDomDocument& stateDoc ) const; diff --git a/src/core/composer/qgscomposeritemgroup.h b/src/core/composer/qgscomposeritemgroup.h index f89312edc75..50b3a2f3cee 100644 --- a/src/core/composer/qgscomposeritemgroup.h +++ b/src/core/composer/qgscomposeritemgroup.h @@ -30,15 +30,15 @@ class CORE_EXPORT QgsComposerItemGroup: public QgsComposerItem QgsComposerItemGroup( QgsComposition* c ); ~QgsComposerItemGroup(); - /** Return correct graphics item type. */ + //! Return correct graphics item type. virtual int type() const override { return ComposerItemGroup; } /** Adds an item to the group. All the group members are deleted if the group is deleted*/ void addItem( QgsComposerItem* item ) override; - /** Removes the items but does not delete them*/ + //! Removes the items but does not delete them void removeItems() override; - /** Draw outline and ev. selection handles*/ + //! Draw outline and ev. selection handles void paint( QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget = nullptr ) override; /** Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit*/ diff --git a/src/core/composer/qgscomposerlabel.h b/src/core/composer/qgscomposerlabel.h index 66c18c68ef2..01717869cb1 100644 --- a/src/core/composer/qgscomposerlabel.h +++ b/src/core/composer/qgscomposerlabel.h @@ -35,13 +35,13 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem QgsComposerLabel( QgsComposition *composition ); ~QgsComposerLabel(); - /** Return correct graphics item type. */ + //! Return correct graphics item type. virtual int type() const override { return ComposerLabel; } - /** \brief Reimplementation of QCanvasItem::paint*/ + //! \brief Reimplementation of QCanvasItem::paint void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; - /** Resizes the widget such that the text fits to the item. Keeps top left point*/ + //! Resizes the widget such that the text fits to the item. Keeps top left point void adjustSizeToText(); QString text() { return mText; } @@ -50,7 +50,7 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem int htmlState() { return mHtmlState; } void setHtmlState( int state ); - /** Returns the text as it appears on screen (with replaced data field) */ + //! Returns the text as it appears on screen (with replaced data field) QString displayText() const; QFont font() const; @@ -116,9 +116,9 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem */ void setMarginY( const double margin ); - /** Sets text color */ + //! Sets text color void setFontColor( const QColor& c ) { mFontColor = c; } - /** Get font color */ + //! Get font color QColor fontColor() const { return mFontColor; } /** Stores state in Dom element @@ -166,18 +166,18 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem double htmlUnitsToMM(); //calculate scale factor bool mHtmlLoaded; - /** Helper function to calculate x/y shift for adjustSizeToText() depending on rotation, current size and alignment*/ + //! Helper function to calculate x/y shift for adjustSizeToText() depending on rotation, current size and alignment void itemShiftAdjustSize( double newWidth, double newHeight, double& xShift, double& yShift ) const; - /** Called when the content is changed to handle HTML loading */ + //! Called when the content is changed to handle HTML loading void contentChanged(); // Font QFont mFont; - /** Horizontal margin between contents and frame (in mm)*/ + //! Horizontal margin between contents and frame (in mm) double mMarginX; - /** Vertical margin between contents and frame (in mm)*/ + //! Vertical margin between contents and frame (in mm) double mMarginY; // Font color @@ -189,7 +189,7 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem // Vertical Alignment Qt::AlignmentFlag mVAlignment; - /** Replaces replace '$CURRENT_DATE<(FORMAT)>' with the current date (e.g. $CURRENT_DATE(d 'June' yyyy)*/ + //! Replaces replace '$CURRENT_DATE<(FORMAT)>' with the current date (e.g. $CURRENT_DATE(d 'June' yyyy) void replaceDateText( QString& text ) const; //! Creates an encoded stylesheet url using the current font and label appearance settings diff --git a/src/core/composer/qgscomposerlegend.h b/src/core/composer/qgscomposerlegend.h index 3e7a749eb7f..98ce5140159 100644 --- a/src/core/composer/qgscomposerlegend.h +++ b/src/core/composer/qgscomposerlegend.h @@ -60,16 +60,16 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem QgsComposerLegend( QgsComposition* composition ); ~QgsComposerLegend(); - /** Return correct graphics item type. */ + //! Return correct graphics item type. virtual int type() const override { return ComposerLegend; } - /** \brief Reimplementation of QCanvasItem::paint*/ + //! \brief Reimplementation of QCanvasItem::paint void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; - /** Paints the legend and calculates its size. If painter is 0, only size is calculated*/ + //! Paints the legend and calculates its size. If painter is 0, only size is calculated QSizeF paintAndDetermineSize( QPainter* painter ); - /** Sets item box to the whole content*/ + //! Sets item box to the whole content void adjustBoxSize(); /** Sets whether the legend should automatically resize to fit its contents. @@ -135,17 +135,17 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem */ void setTitleAlignment( Qt::AlignmentFlag alignment ); - /** Returns reference to modifiable style */ + //! Returns reference to modifiable style QgsComposerLegendStyle & rstyle( QgsComposerLegendStyle::Style s ); - /** Returns style */ + //! Returns style QgsComposerLegendStyle style( QgsComposerLegendStyle::Style s ) const; void setStyle( QgsComposerLegendStyle::Style s, const QgsComposerLegendStyle& style ); QFont styleFont( QgsComposerLegendStyle::Style s ) const; - /** Set style font */ + //! Set style font void setStyleFont( QgsComposerLegendStyle::Style s, const QFont& f ); - /** Set style margin*/ + //! Set style margin void setStyleMargin( QgsComposerLegendStyle::Style s, double margin ); void setStyleMargin( QgsComposerLegendStyle::Style s, QgsComposerLegendStyle::Side side, double margin ); @@ -240,7 +240,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem void setComposerMap( const QgsComposerMap* map ); const QgsComposerMap* composerMap() const { return mComposerMap;} - /** Updates the model and all legend entries*/ + //! Updates the model and all legend entries void updateLegend(); /** Stores state in Dom node @@ -259,9 +259,9 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem virtual QString displayName() const override; public slots: - /** Data changed*/ + //! Data changed void synchronizeWithModel(); - /** Sets mCompositionMap to 0 if the map is deleted*/ + //! Sets mCompositionMap to 0 if the map is deleted void invalidateCurrentMap(); private slots: diff --git a/src/core/composer/qgscomposerlegenditem.h b/src/core/composer/qgscomposerlegenditem.h index 99d65376d40..ff74c0fdfea 100644 --- a/src/core/composer/qgscomposerlegenditem.h +++ b/src/core/composer/qgscomposerlegenditem.h @@ -88,7 +88,7 @@ class CORE_EXPORT QgsComposerSymbolItem: public QgsComposerLegendItem virtual void writeXml( QDomElement& elem, QDomDocument& doc ) const override; virtual void readXml( const QDomElement& itemElem, bool xServerAvailable = true ) override; - /** Set symbol (takes ownership)*/ + //! Set symbol (takes ownership) void setSymbol( QgsSymbol* s ); QgsSymbol* symbol() {return mSymbol;} diff --git a/src/core/composer/qgscomposerlegendstyle.h b/src/core/composer/qgscomposerlegendstyle.h index 99cb4f77d19..1e963bcb521 100644 --- a/src/core/composer/qgscomposerlegendstyle.h +++ b/src/core/composer/qgscomposerlegendstyle.h @@ -63,13 +63,13 @@ class CORE_EXPORT QgsComposerLegendStyle void readXml( const QDomElement& elem, const QDomDocument& doc ); - /** Get name for style, used in project file */ + //! Get name for style, used in project file static QString styleName( Style s ); - /** Get style from name, used in project file */ + //! Get style from name, used in project file static Style styleFromName( const QString& styleName ); - /** Get style label, translated, used in UI */ + //! Get style label, translated, used in UI static QString styleLabel( Style s ); private: diff --git a/src/core/composer/qgscomposermap.h b/src/core/composer/qgscomposermap.h index a197d47939a..6a847632388 100644 --- a/src/core/composer/qgscomposermap.h +++ b/src/core/composer/qgscomposermap.h @@ -48,16 +48,16 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem Q_OBJECT public: - /** Constructor. */ + //! Constructor. QgsComposerMap( QgsComposition *composition, int x, int y, int width, int height ); - /** Constructor. Settings are read from project. */ + //! Constructor. Settings are read from project. QgsComposerMap( QgsComposition *composition ); virtual ~QgsComposerMap(); - /** Return correct graphics item type. */ + //! Return correct graphics item type. virtual int type() const override { return ComposerMap; } - /** \brief Preview style */ + //! \brief Preview style enum PreviewMode { Cache = 0, // Use raster cache @@ -69,7 +69,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ enum AtlasScalingMode { - Fixed, /*!< The current scale of the map is used for each feature of the atlas */ + Fixed, //!< The current scale of the map is used for each feature of the atlas Predefined, /*!< A scale is chosen from the predefined scales. The smallest scale from the list of scales where the atlas feature is fully visible is chosen. @see QgsAtlasComposition::setPredefinedScales. @@ -89,23 +89,23 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ void draw( QPainter *painter, const QgsRectangle& extent, QSizeF size, double dpi, double* forceWidthScale = nullptr ); - /** \brief Reimplementation of QCanvasItem::paint - draw on canvas */ + //! \brief Reimplementation of QCanvasItem::paint - draw on canvas void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; - /** \brief Create cache image */ + //! \brief Create cache image void cache(); /** Return map settings that would be used for drawing of the map * @note added in 2.6 */ QgsMapSettings mapSettings( const QgsRectangle& extent, QSizeF size, int dpi ) const; - /** \brief Get identification number*/ + //! \brief Get identification number int id() const {return mId;} - /** True if a draw is already in progress*/ + //! True if a draw is already in progress bool isDrawing() const {return mDrawing;} - /** Resizes an item in x- and y direction (canvas coordinates)*/ + //! Resizes an item in x- and y direction (canvas coordinates) void resize( double dx, double dy ); /** Move content of map @@ -122,13 +122,13 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ virtual void zoomContent( const double factor, const QPointF point, const ZoomMode mode = QgsComposerItem::Zoom ) override; - /** Sets new scene rectangle bounds and recalculates hight and extent*/ + //! Sets new scene rectangle bounds and recalculates hight and extent void setSceneRect( const QRectF& rectangle ) override; - /** \brief Scale */ + //! \brief Scale double scale() const; - /** Sets new scale and changes only mExtent*/ + //! Sets new scale and changes only mExtent void setNewScale( double scaleDenominator, bool forceUpdate = true ); /** Sets new extent for the map. This method may change the width or height of the map @@ -168,28 +168,28 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem PreviewMode previewMode() const {return mPreviewMode;} void setPreviewMode( PreviewMode m ); - /** Getter for flag that determines if the stored layer set should be used or the current layer set of the qgis mapcanvas */ + //! Getter for flag that determines if the stored layer set should be used or the current layer set of the qgis mapcanvas bool keepLayerSet() const {return mKeepLayerSet;} - /** Setter for flag that determines if the stored layer set should be used or the current layer set of the qgis mapcanvas */ + //! Setter for flag that determines if the stored layer set should be used or the current layer set of the qgis mapcanvas void setKeepLayerSet( bool enabled ) {mKeepLayerSet = enabled;} - /** Getter for stored layer set that is used if mKeepLayerSet is true */ + //! Getter for stored layer set that is used if mKeepLayerSet is true QStringList layerSet() const {return mLayerSet;} - /** Setter for stored layer set that is used if mKeepLayerSet is true */ + //! Setter for stored layer set that is used if mKeepLayerSet is true void setLayerSet( const QStringList& layerSet ) {mLayerSet = layerSet;} - /** Stores the current layer set of the qgis mapcanvas in mLayerSet*/ + //! Stores the current layer set of the qgis mapcanvas in mLayerSet void storeCurrentLayerSet(); - /** Getter for flag that determines if current styles of layers should be overridden by previously stored styles. @note added in 2.8 */ + //! Getter for flag that determines if current styles of layers should be overridden by previously stored styles. @note added in 2.8 bool keepLayerStyles() const { return mKeepLayerStyles; } - /** Setter for flag that determines if current styles of layers should be overridden by previously stored styles. @note added in 2.8 */ + //! Setter for flag that determines if current styles of layers should be overridden by previously stored styles. @note added in 2.8 void setKeepLayerStyles( bool enabled ) { mKeepLayerStyles = enabled; } - /** Getter for stored overrides of styles for layers. @note added in 2.8 */ + //! Getter for stored overrides of styles for layers. @note added in 2.8 QMap layerStyleOverrides() const { return mLayerStyleOverrides; } - /** Setter for stored overrides of styles for layers. @note added in 2.8 */ + //! Setter for stored overrides of styles for layers. @note added in 2.8 void setLayerStyleOverrides( const QMap& overrides ); - /** Stores the current layer styles into style overrides. @note added in 2.8 */ + //! Stores the current layer styles into style overrides. @note added in 2.8 void storeCurrentLayerStyles(); /** Whether the map should follow a map theme. If true, the layers and layer styles @@ -218,13 +218,13 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem QgsRectangle extent() const {return mExtent;} - /** Sets offset values to shift image (useful for live updates when moving item content)*/ + //! Sets offset values to shift image (useful for live updates when moving item content) void setOffset( double xOffset, double yOffset ); - /** True if composer map renders a WMS layer*/ + //! True if composer map renders a WMS layer bool containsWmsLayer() const; - /** True if composer map contains layers with blend modes or flattened layers for vectors */ + //! True if composer map contains layers with blend modes or flattened layers for vectors bool containsAdvancedEffects() const; /** Stores state in Dom node @@ -269,7 +269,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ QgsComposerMapOverview* overview(); - /** In case of annotations, the bounding rectangle can be larger than the map item rectangle */ + //! In case of annotations, the bounding rectangle can be larger than the map item rectangle QRectF boundingRect() const override; /* reimplement setFrameOutlineWidth, so that updateBoundingRect() is called after setting the frame width */ @@ -291,13 +291,13 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem void updateItem() override; - /** Sets canvas pointer (necessary to query and draw map canvas items)*/ + //! Sets canvas pointer (necessary to query and draw map canvas items) void setMapCanvas( QGraphicsView* canvas ) { mMapCanvas = canvas; } void setDrawCanvasItems( bool b ) { mDrawCanvasItems = b; } bool drawCanvasItems() const { return mDrawCanvasItems; } - /** Returns the conversion factor map units -> mm*/ + //! Returns the conversion factor map units -> mm double mapUnitsToMM() const; /** Sets mId to a number not yet used in the composition. mId is kept if it is not in use. @@ -357,10 +357,10 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ void setAtlasMargin( double margin ) { mAtlasMargin = margin; } - /** Sets whether updates to the composer map are enabled. */ + //! Sets whether updates to the composer map are enabled. void setUpdatesEnabled( bool enabled ) { mUpdatesEnabled = enabled; } - /** Returns whether updates to the composer map are enabled. */ + //! Returns whether updates to the composer map are enabled. bool updatesEnabled() const { return mUpdatesEnabled; } /** Get the number of layers that this item requires for exporting as layers @@ -381,10 +381,10 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //overridden to show "Map 1" type names virtual QString displayName() const override; - /** Returns extent that considers rotation and shift with mOffsetX / mOffsetY*/ + //! Returns extent that considers rotation and shift with mOffsetX / mOffsetY QPolygonF transformedMapPolygon() const; - /** Transforms map coordinates to item coordinates (considering rotation and move offset)*/ + //! Transforms map coordinates to item coordinates (considering rotation and move offset) QPointF mapToItemCoords( QPointF mapCoords ) const; /** Calculates the extent to request and the yShift of the top-left point in case of rotation. @@ -396,10 +396,10 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem signals: void extentChanged(); - /** Is emitted on rotation change to notify north arrow pictures*/ + //! Is emitted on rotation change to notify north arrow pictures void mapRotationChanged( double newRotation ); - /** Is emitted when the map has been prepared for atlas rendering, just before actual rendering*/ + //! Is emitted when the map has been prepared for atlas rendering, just before actual rendering void preparedForAtlas(); /** Emitted when layer style overrides are changed... a means to let @@ -410,7 +410,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem public slots: - /** Forces an update of the cached map image*/ + //! Forces an update of the cached map image void updateCachedImage(); /** Updates the cached map image if the map is set to Render mode @@ -418,7 +418,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ void renderModeUpdateCachedImage(); - /** Updates the bounding rect of this item. Call this function before doing any changes related to annotation out of the map rectangle */ + //! Updates the bounding rect of this item. Call this function before doing any changes related to annotation out of the map rectangle void updateBoundingRect(); virtual void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext* context = nullptr ) override; @@ -433,7 +433,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem private: - /** Unique identifier*/ + //! Unique identifier int mId; QgsComposerMapGridStack* mGridStack; @@ -456,34 +456,34 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem // Is cache up to date bool mCacheUpdated; - /** \brief Preview style */ + //! \brief Preview style PreviewMode mPreviewMode; - /** \brief Number of layers when cache was created */ + //! \brief Number of layers when cache was created int mNumCachedLayers; - /** \brief set to true if in state of drawing. Concurrent requests to draw method are returned if set to true */ + //! \brief set to true if in state of drawing. Concurrent requests to draw method are returned if set to true bool mDrawing; - /** Offset in x direction for showing map cache image*/ + //! Offset in x direction for showing map cache image double mXOffset; - /** Offset in y direction for showing map cache image*/ + //! Offset in y direction for showing map cache image double mYOffset; - /** Map rotation*/ + //! Map rotation double mMapRotation; /** Temporary evaluated map rotation. Data defined rotation may mean this value * differs from mMapRotation*/ double mEvaluatedMapRotation; - /** Flag if layers to be displayed should be read from qgis canvas (true) or from stored list in mLayerSet (false)*/ + //! Flag if layers to be displayed should be read from qgis canvas (true) or from stored list in mLayerSet (false) bool mKeepLayerSet; - /** Stored layer list (used if layer live-link mKeepLayerSet is disabled)*/ + //! Stored layer list (used if layer live-link mKeepLayerSet is disabled) QStringList mLayerSet; bool mKeepLayerStyles; - /** Stored style names (value) to be used with particular layer IDs (key) instead of default style */ + //! Stored style names (value) to be used with particular layer IDs (key) instead of default style QMap mLayerStyleOverrides; /** Whether layers and styles should be used from a preset (preset name is stored @@ -494,53 +494,53 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem * is true. May be overridden by data-defined expression. */ QString mFollowVisibilityPresetName; - /** Whether updates to the map are enabled */ + //! Whether updates to the map are enabled bool mUpdatesEnabled; - /** Establishes signal/slot connection for update in case of layer change*/ + //! Establishes signal/slot connection for update in case of layer change void connectUpdateSlot(); - /** Removes layer ids from mLayerSet that are no longer present in the qgis main map*/ + //! Removes layer ids from mLayerSet that are no longer present in the qgis main map void syncLayerSet(); - /** Returns first map grid or creates an empty one if none*/ + //! Returns first map grid or creates an empty one if none const QgsComposerMapGrid* constFirstMapGrid() const; - /** Returns first map overview or creates an empty one if none*/ + //! Returns first map overview or creates an empty one if none const QgsComposerMapOverview* constFirstMapOverview() const; - /** Current bounding rectangle. This is used to check if notification to the graphics scene is necessary*/ + //! Current bounding rectangle. This is used to check if notification to the graphics scene is necessary QRectF mCurrentRectangle; QGraphicsView* mMapCanvas; - /** True if annotation items, rubber band, etc. from the main canvas should be displayed*/ + //! True if annotation items, rubber band, etc. from the main canvas should be displayed bool mDrawCanvasItems; /** Adjusts an extent rectangle to match the provided item width and height, so that extent * center of extent remains the same */ void adjustExtentToItemShape( double itemWidth, double itemHeight, QgsRectangle& extent ) const; - /** True if map is being controlled by an atlas*/ + //! True if map is being controlled by an atlas bool mAtlasDriven; - /** Current atlas scaling mode*/ + //! Current atlas scaling mode AtlasScalingMode mAtlasScalingMode; - /** Margin size for atlas driven extents (percentage of feature size) - when in auto scaling mode*/ + //! Margin size for atlas driven extents (percentage of feature size) - when in auto scaling mode double mAtlasMargin; void init(); - /** Resets the item tooltip to reflect current map id*/ + //! Resets the item tooltip to reflect current map id void updateToolTip(); - /** Returns a list of the layers to render for this map item*/ + //! Returns a list of the layers to render for this map item QStringList layersToRender( const QgsExpressionContext* context = nullptr ) const; - /** Returns current layer style overrides for this map item*/ + //! Returns current layer style overrides for this map item QMap layerStyleOverridesToRender( const QgsExpressionContext& context ) const; - /** Returns extent that considers mOffsetX / mOffsetY (during content move)*/ + //! Returns extent that considers mOffsetX / mOffsetY (during content move) QgsRectangle transformedExtent() const; - /** MapPolygon variant using a given extent */ + //! MapPolygon variant using a given extent void mapPolygon( const QgsRectangle& extent, QPolygonF& poly ) const; /** Scales a composer map shift (in MM) and rotates it by mRotation @@ -562,7 +562,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem SelectionBoxes }; - /** Test if a part of the copmosermap needs to be drawn, considering mCurrentExportLayer*/ + //! Test if a part of the copmosermap needs to be drawn, considering mCurrentExportLayer bool shouldDrawPart( PartType part ) const; /** Refresh the map's extents, considering data defined extent, scale and rotation diff --git a/src/core/composer/qgscomposermapgrid.h b/src/core/composer/qgscomposermapgrid.h index b65c88f8652..f08fb2020b8 100644 --- a/src/core/composer/qgscomposermapgrid.h +++ b/src/core/composer/qgscomposermapgrid.h @@ -171,9 +171,9 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ enum GridUnit { - MapUnit, /*!< grid units follow map units */ - MM, /*!< grid units in millimeters */ - CM /*!< grid units in centimeters */ + MapUnit, //!< Grid units follow map units + MM, //!< Grid units in millimeters + CM //!< Grid units in centimeters }; /** Grid drawing style @@ -181,52 +181,52 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem enum GridStyle { Solid = 0, - Cross, /*!< draw line crosses at intersections of grid lines */ - Markers, /*!< draw markers at intersections of grid lines */ - FrameAnnotationsOnly /*!< no grid lines over the map, only draw frame and annotations */ + Cross, //!< Draw line crosses at intersections of grid lines + Markers, //!< Draw markers at intersections of grid lines + FrameAnnotationsOnly //!< No grid lines over the map, only draw frame and annotations }; /** Display settings for grid annotations and frames */ enum DisplayMode { - ShowAll = 0, /*!< show both latitude and longitude annotations/divisions */ - LatitudeOnly, /*!< show latitude/y annotations/divisions only */ - LongitudeOnly, /*!< show longitude/x annotations/divisions only */ - HideAll /*!< no annotations */ + ShowAll = 0, //!< Show both latitude and longitude annotations/divisions + LatitudeOnly, //!< Show latitude/y annotations/divisions only + LongitudeOnly, //!< Show longitude/x annotations/divisions only + HideAll //!< No annotations }; /** Position for grid annotations */ enum AnnotationPosition { - InsideMapFrame = 0, /*!< draw annotations inside the map frame */ - OutsideMapFrame, /*!< draw annotations outside the map frame */ + InsideMapFrame = 0, //!< Draw annotations inside the map frame + OutsideMapFrame, //!< Draw annotations outside the map frame }; /** Direction of grid annotations */ enum AnnotationDirection { - Horizontal = 0, /*!< draw annotations horizontally */ - Vertical, /*!< draw annotations vertically, ascending */ - VerticalDescending, /*!< draw annotations vertically, descending */ - BoundaryDirection /*!< annotations follow the boundary direction */ + Horizontal = 0, //!< Draw annotations horizontally + Vertical, //!< Draw annotations vertically, ascending + VerticalDescending, //!< Draw annotations vertically, descending + BoundaryDirection //!< Annotations follow the boundary direction }; /** Format for displaying grid annotations */ enum AnnotationFormat { - Decimal = 0, /*!< decimal degrees, use - for S/W coordinates */ - DegreeMinute, /*!< degree/minutes, use NSEW suffix */ - DegreeMinuteSecond, /*!< degree/minutes/seconds, use NSEW suffix */ - DecimalWithSuffix, /*!< decimal degrees, use NSEW suffix */ - DegreeMinuteNoSuffix, /*!< degree/minutes, use - for S/W coordinates */ - DegreeMinutePadded, /*!< degree/minutes, with minutes using leading zeros where required */ - DegreeMinuteSecondNoSuffix, /*!< degree/minutes/seconds, use - for S/W coordinates */ - DegreeMinuteSecondPadded, /*!< degree/minutes/seconds, with minutes using leading zeros where required */ - CustomFormat /*!< custom expression-based format */ + Decimal = 0, //!< Decimal degrees, use - for S/W coordinates + DegreeMinute, //!< Degree/minutes, use NSEW suffix + DegreeMinuteSecond, //!< Degree/minutes/seconds, use NSEW suffix + DecimalWithSuffix, //!< Decimal degrees, use NSEW suffix + DegreeMinuteNoSuffix, //!< Degree/minutes, use - for S/W coordinates + DegreeMinutePadded, //!< Degree/minutes, with minutes using leading zeros where required + DegreeMinuteSecondNoSuffix, //!< Degree/minutes/seconds, use - for S/W coordinates + DegreeMinuteSecondPadded, //!< Degree/minutes/seconds, with minutes using leading zeros where required + CustomFormat //!< Custom expression-based format }; /** Border sides for annotations @@ -234,31 +234,31 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem enum BorderSide { Left, - Right, /*!< right border */ - Bottom, /*!< bottom border */ - Top /*!< top border */ + Right, //!< Right border + Bottom, //!< Bottom border + Top //!< Top border }; /** Style for grid frame */ enum FrameStyle { - NoFrame = 0, /*!< disable grid frame */ - Zebra, /*!< black/white pattern */ - InteriorTicks, /*!< tick markers drawn inside map frame */ - ExteriorTicks, /*!< tick markers drawn outside map frame */ - InteriorExteriorTicks, /*!< tick markers drawn both inside and outside the map frame */ - LineBorder /*!< simple solid line frame */ + NoFrame = 0, //!< Disable grid frame + Zebra, //!< Black/white pattern + InteriorTicks, //!< Tick markers drawn inside map frame + ExteriorTicks, //!< Tick markers drawn outside map frame + InteriorExteriorTicks, //!< Tick markers drawn both inside and outside the map frame + LineBorder //!< Simple solid line frame }; /** Flags for controlling which side of the map a frame is drawn on */ enum FrameSideFlag { - FrameLeft = 0x01, /*!< left side of map */ - FrameRight = 0x02, /*!< right side of map */ - FrameTop = 0x04, /*!< top side of map */ - FrameBottom = 0x08 /*!< bottom side of map */ + FrameLeft = 0x01, //!< Left side of map + FrameRight = 0x02, //!< Right side of map + FrameTop = 0x04, //!< Top side of map + FrameBottom = 0x08 //!< Bottom side of map }; Q_DECLARE_FLAGS( FrameSideFlags, FrameSideFlag ) @@ -266,8 +266,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ enum AnnotationCoordinate { - Longitude = 0, /*!< coordinate is a longitude value */ - Latitude /*!< coordinate is a latitude value */ + Longitude = 0, //!< Coordinate is a longitude value + Latitude //!< Coordinate is a latitude value }; /** Constructor for QgsComposerMapGrid. @@ -848,53 +848,53 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem /*True if a re-transformation of grid lines is required*/ bool mTransformDirty; - /** Solid or crosses*/ + //! Solid or crosses GridStyle mGridStyle; - /** Grid line interval in x-direction (map units)*/ + //! Grid line interval in x-direction (map units) double mGridIntervalX; - /** Grid line interval in y-direction (map units)*/ + //! Grid line interval in y-direction (map units) double mGridIntervalY; - /** Grid line offset in x-direction*/ + //! Grid line offset in x-direction double mGridOffsetX; - /** Grid line offset in y-direction*/ + //! Grid line offset in y-direction double mGridOffsetY; - /** Font for grid line annotation*/ + //! Font for grid line annotation QFont mGridAnnotationFont; - /** Font color for grid coordinates*/ + //! Font color for grid coordinates QColor mGridAnnotationFontColor; - /** Digits after the dot*/ + //! Digits after the dot int mGridAnnotationPrecision; - /** True if coordinate values should be drawn*/ + //! True if coordinate values should be drawn bool mShowGridAnnotation; - /** Annotation display mode for left map side*/ + //! Annotation display mode for left map side DisplayMode mLeftGridAnnotationDisplay; - /** Annotation display mode for right map side*/ + //! Annotation display mode for right map side DisplayMode mRightGridAnnotationDisplay; - /** Annotation display mode for top map side*/ + //! Annotation display mode for top map side DisplayMode mTopGridAnnotationDisplay; - /** Annotation display mode for bottom map side*/ + //! Annotation display mode for bottom map side DisplayMode mBottomGridAnnotationDisplay; - /** Annotation position for left map side (inside / outside)*/ + //! Annotation position for left map side (inside / outside) AnnotationPosition mLeftGridAnnotationPosition; - /** Annotation position for right map side (inside / outside)*/ + //! Annotation position for right map side (inside / outside) AnnotationPosition mRightGridAnnotationPosition; - /** Annotation position for top map side (inside / outside)*/ + //! Annotation position for top map side (inside / outside) AnnotationPosition mTopGridAnnotationPosition; - /** Annotation position for bottom map side (inside / outside)*/ + //! Annotation position for bottom map side (inside / outside) AnnotationPosition mBottomGridAnnotationPosition; - /** Distance between map frame and annotation*/ + //! Distance between map frame and annotation double mAnnotationFrameDistance; - /** Annotation direction on left side ( horizontal or vertical )*/ + //! Annotation direction on left side ( horizontal or vertical ) AnnotationDirection mLeftGridAnnotationDirection; - /** Annotation direction on right side ( horizontal or vertical )*/ + //! Annotation direction on right side ( horizontal or vertical ) AnnotationDirection mRightGridAnnotationDirection; - /** Annotation direction on top side ( horizontal or vertical )*/ + //! Annotation direction on top side ( horizontal or vertical ) AnnotationDirection mTopGridAnnotationDirection; - /** Annotation direction on bottom side ( horizontal or vertical )*/ + //! Annotation direction on bottom side ( horizontal or vertical ) AnnotationDirection mBottomGridAnnotationDirection; AnnotationFormat mGridAnnotationFormat; @@ -910,13 +910,13 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem QColor mGridFrameFillColor2; double mCrossLength; - /** Divisions for frame on left map side*/ + //! Divisions for frame on left map side DisplayMode mLeftFrameDivisions; - /** Divisions for frame on right map side*/ + //! Divisions for frame on right map side DisplayMode mRightFrameDivisions; - /** Divisions for frame on top map side*/ + //! Divisions for frame on top map side DisplayMode mTopFrameDivisions; - /** Divisions for frame on bottom map side*/ + //! Divisions for frame on bottom map side DisplayMode mBottomFrameDivisions; QgsLineSymbol* mGridLineSymbol; @@ -1004,14 +1004,14 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ BorderSide borderForLineCoord( QPointF p, const AnnotationCoordinate coordinateType ) const; - /** Get parameters for drawing grid in CRS different to map CRS*/ + //! Get parameters for drawing grid in CRS different to map CRS int crsGridParams( QgsRectangle& crsRect, QgsCoordinateTransform& inverseTransform ) const; static QList trimLinesToMap( const QPolygonF &line, const QgsRectangle &rect ); QPolygonF scalePolygon( const QPolygonF &polygon, const double scale ) const; - /** Draws grid if CRS is different to map CRS*/ + //! Draws grid if CRS is different to map CRS void drawGridCrsTransform( QgsRenderContext &context, double dotsPerMM, QList< QPair< double, QLineF > > &horizontalLines, QList< QPair< double, QLineF > > &verticalLines , bool calculateLinesOnly = false ); diff --git a/src/core/composer/qgscomposermapitem.h b/src/core/composer/qgscomposermapitem.h index 5d2d0e1760a..d1c25afc1fc 100644 --- a/src/core/composer/qgscomposermapitem.h +++ b/src/core/composer/qgscomposermapitem.h @@ -106,16 +106,16 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject protected: - /** Friendly display name*/ + //! Friendly display name QString mName; - /** Associated composer map*/ + //! Associated composer map QgsComposerMap* mComposerMap; - /** Unique id*/ + //! Unique id QString mUuid; - /** True if item is to be displayed on map*/ + //! True if item is to be displayed on map bool mEnabled; }; diff --git a/src/core/composer/qgscomposermapoverview.h b/src/core/composer/qgscomposermapoverview.h index 635dd3d9ec8..a2544400c5f 100644 --- a/src/core/composer/qgscomposermapoverview.h +++ b/src/core/composer/qgscomposermapoverview.h @@ -250,22 +250,22 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem QgsComposerMapOverview(); //forbidden - /** Id of map which displays its extent rectangle into this composer map (overview map functionality). -1 if not present*/ + //! Id of map which displays its extent rectangle into this composer map (overview map functionality). -1 if not present int mFrameMapId; - /** Drawing style for overview farme*/ + //! Drawing style for overview farme QgsFillSymbol* mFrameSymbol; - /** Blend mode for overview*/ + //! Blend mode for overview QPainter::CompositionMode mBlendMode; - /** True if overview is inverted*/ + //! True if overview is inverted bool mInverted; - /** True if map is centered on overview*/ + //! True if map is centered on overview bool mCentered; - /** Creates default overview symbol*/ + //! Creates default overview symbol void createDefaultFrameSymbol(); }; diff --git a/src/core/composer/qgscomposermodel.h b/src/core/composer/qgscomposermodel.h index 1bd2da94d9d..6d829725524 100644 --- a/src/core/composer/qgscomposermodel.h +++ b/src/core/composer/qgscomposermodel.h @@ -54,9 +54,9 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel //! Columns returned by the model enum Columns { - Visibility = 0, /*!< Item visibility check box */ - LockStatus, /*!< Item lock status check box */ - ItemId, /*!< Item ID */ + Visibility = 0, //!< Item visibility check box + LockStatus, //!< Item lock status check box + ItemId, //!< Item ID }; /** Constructor @@ -255,15 +255,15 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel protected: - /** Maintains z-Order of items. Starts with item at position 1 (position 0 is always paper item)*/ + //! Maintains z-Order of items. Starts with item at position 1 (position 0 is always paper item) QList mItemZList; - /** Cached list of items from mItemZList which are currently in the scene*/ + //! Cached list of items from mItemZList which are currently in the scene QList mItemsInScene; private: - /** Parent composition*/ + //! Parent composition QgsComposition* mComposition; /** Returns the QgsComposerItem corresponding to a QModelIndex, if possible diff --git a/src/core/composer/qgscomposermousehandles.h b/src/core/composer/qgscomposermousehandles.h index d29fdc31ae1..a0c3a6c2094 100644 --- a/src/core/composer/qgscomposermousehandles.h +++ b/src/core/composer/qgscomposermousehandles.h @@ -34,7 +34,7 @@ class CORE_EXPORT QgsComposerMouseHandles: public QObject, public QGraphicsRectI Q_OBJECT public: - /** Describes the action (move or resize in different directon) to be done during mouse move*/ + //! Describes the action (move or resize in different directon) to be done during mouse move enum MouseAction { MoveItem, @@ -77,13 +77,13 @@ class CORE_EXPORT QgsComposerMouseHandles: public QObject, public QGraphicsRectI void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; - /** Finds out which mouse move action to choose depending on the scene cursor position*/ + //! Finds out which mouse move action to choose depending on the scene cursor position QgsComposerMouseHandles::MouseAction mouseActionForScenePos( QPointF sceneCoordPos ); - /** Returns true is user is currently dragging the handles */ + //! Returns true is user is currently dragging the handles bool isDragging() { return mIsDragging; } - /** Returns true is user is currently resizing with the handles */ + //! Returns true is user is currently resizing with the handles bool isResizing() { return mIsResizing; } protected: @@ -97,13 +97,13 @@ class CORE_EXPORT QgsComposerMouseHandles: public QObject, public QGraphicsRectI public slots: - /** Sets up listeners to sizeChanged signal for all selected items*/ + //! Sets up listeners to sizeChanged signal for all selected items void selectionChanged(); - /** Redraws handles when selected item size changes*/ + //! Redraws handles when selected item size changes void selectedItemSizeChanged(); - /** Redraws handles when selected item rotation changes*/ + //! Redraws handles when selected item rotation changes void selectedItemRotationChanged(); private: @@ -112,15 +112,15 @@ class CORE_EXPORT QgsComposerMouseHandles: public QObject, public QGraphicsRectI QGraphicsView* mGraphicsView; //reference to QGraphicsView QgsComposerMouseHandles::MouseAction mCurrentMouseMoveAction; - /** Start point of the last mouse move action (in scene coordinates)*/ + //! Start point of the last mouse move action (in scene coordinates) QPointF mMouseMoveStartPos; - /** Position of the last mouse move event (in scene coordinates)*/ + //! Position of the last mouse move event (in scene coordinates) QPointF mLastMouseEventPos; - /** Position of the mouse at beginning of move/resize (in scene coordinates)*/ + //! Position of the mouse at beginning of move/resize (in scene coordinates) QPointF mBeginMouseEventPos; - /** Position of composer handles at beginning of move/resize (in scene coordinates)*/ + //! Position of composer handles at beginning of move/resize (in scene coordinates) QPointF mBeginHandlePos; - /** Width and height of composer handles at beginning of resize*/ + //! Width and height of composer handles at beginning of resize double mBeginHandleWidth; double mBeginHandleHeight; @@ -128,62 +128,62 @@ class CORE_EXPORT QgsComposerMouseHandles: public QObject, public QGraphicsRectI double mResizeMoveX; double mResizeMoveY; - /** True if user is currently dragging items*/ + //! True if user is currently dragging items bool mIsDragging; - /** True is user is currently resizing items*/ + //! True is user is currently resizing items bool mIsResizing; - /** Align snap lines*/ + //! Align snap lines QGraphicsLineItem* mHAlignSnapItem; QGraphicsLineItem* mVAlignSnapItem; QSizeF mCursorOffset; - /** Returns the mouse handle bounds of current selection*/ + //! Returns the mouse handle bounds of current selection QRectF selectionBounds() const; - /** Returns true if all selected items have same rotation, and if so, updates passed rotation variable*/ + //! Returns true if all selected items have same rotation, and if so, updates passed rotation variable bool selectionRotation( double & rotation ) const; - /** Redraws or hides the handles based on the current selection*/ + //! Redraws or hides the handles based on the current selection void updateHandles(); - /** Draws the handles*/ + //! Draws the handles void drawHandles( QPainter* painter, double rectHandlerSize ); - /** Draw outlines for selected items*/ + //! Draw outlines for selected items void drawSelectedItemBounds( QPainter* painter ); /** Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing*/ double rectHandlerBorderTolerance(); - /** Finds out the appropriate cursor for the current mouse position in the widget (e.g. move in the middle, resize at border)*/ + //! Finds out the appropriate cursor for the current mouse position in the widget (e.g. move in the middle, resize at border) Qt::CursorShape cursorForPosition( QPointF itemCoordPos ); - /** Finds out which mouse move action to choose depending on the cursor position inside the widget*/ + //! Finds out which mouse move action to choose depending on the cursor position inside the widget QgsComposerMouseHandles::MouseAction mouseActionForPosition( QPointF itemCoordPos ); - /** Handles dragging of items during mouse move*/ + //! Handles dragging of items during mouse move void dragMouseMove( QPointF currentPosition, bool lockMovement, bool preventSnap ); - /** Calculates the distance of the mouse cursor from thed edge of the mouse handles*/ + //! Calculates the distance of the mouse cursor from thed edge of the mouse handles QSizeF calcCursorEdgeOffset( QPointF cursorPos ); - /** Handles resizing of items during mouse move*/ + //! Handles resizing of items during mouse move void resizeMouseMove( QPointF currentPosition, bool lockAspect, bool fromCenter ); - /** Return horizontal align snap item. Creates a new graphics line if 0*/ + //! Return horizontal align snap item. Creates a new graphics line if 0 QGraphicsLineItem* hAlignSnapItem(); void deleteHAlignSnapItem(); - /** Return vertical align snap item. Creates a new graphics line if 0*/ + //! Return vertical align snap item. Creates a new graphics line if 0 QGraphicsLineItem* vAlignSnapItem(); void deleteVAlignSnapItem(); void deleteAlignItems(); - /** Snaps an item or point (depending on mode) originating at originalPoint to the grid or align rulers*/ + //! Snaps an item or point (depending on mode) originating at originalPoint to the grid or align rulers QPointF snapPoint( QPointF originalPoint, QgsComposerMouseHandles::SnapGuideMode mode ); - /** Snaps an item originating at unalignedX, unalignedY to the grid or align rulers*/ + //! Snaps an item originating at unalignedX, unalignedY to the grid or align rulers QPointF alignItem( double& alignX, double& alignY, double unalignedX, double unalignedY ); - /** Snaps a point to to the grid or align rulers*/ + //! Snaps a point to to the grid or align rulers QPointF alignPos( QPointF pos, double& alignX, double& alignY ); //helper functions for item align diff --git a/src/core/composer/qgscomposermultiframe.h b/src/core/composer/qgscomposermultiframe.h index dc32d321a70..6cb22a18161 100644 --- a/src/core/composer/qgscomposermultiframe.h +++ b/src/core/composer/qgscomposermultiframe.h @@ -46,9 +46,9 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ enum ResizeMode { - UseExistingFrames = 0, /*!< don't automatically create new frames, just use existing frames */ - ExtendToNextPage, /*!< creates new full page frames on the following page(s) until the entire multiframe content is visible */ - RepeatOnEveryPage, /*!< repeats the same frame on every page */ + UseExistingFrames = 0, //!< Don't automatically create new frames, just use existing frames + ExtendToNextPage, //!< Creates new full page frames on the following page(s) until the entire multiframe content is visible + RepeatOnEveryPage, //!< Repeats the same frame on every page RepeatUntilFinished /*!< creates new frames with the same position and dimensions as the existing frame on the following page(s), until the entire multiframe content is visible */ }; @@ -270,7 +270,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject ResizeMode mResizeMode; - /** True: creates QgsMultiFrameCommands on internal changes (e.g. changing frames )*/ + //! True: creates QgsMultiFrameCommands on internal changes (e.g. changing frames ) bool mCreateUndoCommands; protected slots: diff --git a/src/core/composer/qgscomposermultiframecommand.h b/src/core/composer/qgscomposermultiframecommand.h index 255c5065fbf..86e01918ea2 100644 --- a/src/core/composer/qgscomposermultiframecommand.h +++ b/src/core/composer/qgscomposermultiframecommand.h @@ -41,7 +41,7 @@ class CORE_EXPORT QgsComposerMultiFrameCommand: public QUndoCommand QDomDocument previousState() const { return mPreviousState.cloneNode().toDocument(); } QDomDocument afterState() const { return mAfterState.cloneNode().toDocument(); } - /** Returns true if previous state and after state are valid and different*/ + //! Returns true if previous state and after state are valid and different bool containsChange() const; const QgsComposerMultiFrame* multiFrame() const { return mMultiFrame; } diff --git a/src/core/composer/qgscomposernodesitem.h b/src/core/composer/qgscomposernodesitem.h index 05a68034ca5..527099be910 100644 --- a/src/core/composer/qgscomposernodesitem.h +++ b/src/core/composer/qgscomposernodesitem.h @@ -45,7 +45,7 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem */ QgsComposerNodesItem( const QString &mTagName, const QPolygonF &polygon, QgsComposition* c ); - /** Destructor */ + //! Destructor ~QgsComposerNodesItem(); /** Add a node in current shape. @@ -68,7 +68,7 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem */ bool moveNode( const int index, QPointF node ); - /** \brief Reimplementation of QCanvasItem::paint - draw on canvas */ + //! \brief Reimplementation of QCanvasItem::paint - draw on canvas void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; /** Search the nearest node in shape within a maximal area. Returns the @@ -98,7 +98,7 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem */ bool removeNode( const int index ); - /** Returns the number of nodes in the shape. */ + //! Returns the number of nodes in the shape. int nodesSize() { return mPolygon.size(); } /** Select a node. @@ -123,46 +123,46 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem protected: - /** Storage meaning for shape's nodes. */ + //! Storage meaning for shape's nodes. QPolygonF mPolygon; - /** Method called in addNode. */ + //! Method called in addNode. virtual bool _addNode( const int nodeIndex, QPointF newNode, const double radius ) = 0; - /** Method called in removeNode. */ + //! Method called in removeNode. virtual bool _removeNode( const int nodeIndex ) = 0; - /** Method called in paint. */ + //! Method called in paint. virtual void _draw( QPainter *painter ) = 0; - /** Method called in readXml. */ + //! Method called in readXml. virtual void _readXmlStyle( const QDomElement &elmt ) = 0; - /** Method called in writeXml. */ + //! Method called in writeXml. virtual void _writeXmlStyle( QDomDocument &doc, QDomElement &elmt ) const = 0; /** Rescale the current shape according to the boudning box. Useful when * the shape is resized thanks to the rubber band. */ void rescaleToFitBoundingBox(); - /** Compute an euclidian distance between 2 nodes. */ + //! Compute an euclidian distance between 2 nodes. double computeDistance( QPointF pt1, QPointF pt2 ) const; - /** Update the current scene rectangle for this item. */ + //! Update the current scene rectangle for this item. void updateSceneRect(); private: - /** This tag is used to write the XML document. */ + //! This tag is used to write the XML document. QString mTagName; - /** The index of the node currently selected. */ + //! The index of the node currently selected. int mSelectedNode; /** This tag is used to indicate if we have to draw nodes or not during * the painting. */ bool mDrawNodes; - /** Draw nodes */ + //! Draw nodes void drawNodes( QPainter *painter ) const; void drawSelectedNode( QPainter *painter ) const; }; diff --git a/src/core/composer/qgscomposerobject.h b/src/core/composer/qgscomposerobject.h index 753128acb2e..70679335258 100644 --- a/src/core/composer/qgscomposerobject.h +++ b/src/core/composer/qgscomposerobject.h @@ -39,39 +39,39 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext */ enum DataDefinedProperty { - NoProperty = 0, /*!< no property */ - AllProperties, /*!< all properties for item */ - TestProperty, /*!< dummy property with no effect on item*/ + NoProperty = 0, //!< No property + AllProperties, //!< All properties for item + TestProperty, //!< Dummy property with no effect on item //composer page properties - PresetPaperSize, /*!< preset paper size for composition */ - PaperWidth, /*!< paper width */ - PaperHeight, /*!< paper height */ - NumPages, /*!< number of pages in composition */ - PaperOrientation, /*!< paper orientation */ + PresetPaperSize, //!< Preset paper size for composition + PaperWidth, //!< Paper width + PaperHeight, //!< Paper height + NumPages, //!< Number of pages in composition + PaperOrientation, //!< Paper orientation //general composer item properties - PageNumber, /*!< page number for item placement */ - PositionX, /*!< x position on page */ - PositionY, /*!< y position on page */ - ItemWidth, /*!< width of item */ - ItemHeight, /*!< height of item */ - ItemRotation, /*!< rotation of item */ - Transparency, /*!< item transparency */ - BlendMode, /*!< item blend mode */ - ExcludeFromExports, /*!< exclude item from exports */ + PageNumber, //!< Page number for item placement + PositionX, //!< X position on page + PositionY, //!< Y position on page + ItemWidth, //!< Width of item + ItemHeight, //!< Height of item + ItemRotation, //!< Rotation of item + Transparency, //!< Item transparency + BlendMode, //!< Item blend mode + ExcludeFromExports, //!< Exclude item from exports //composer map - MapRotation, /*!< map rotation */ - MapScale, /*!< map scale */ - MapXMin, /*!< map extent x minimum */ - MapYMin, /*!< map extent y minimum */ - MapXMax, /*!< map extent x maximum */ - MapYMax, /*!< map extent y maximum */ - MapAtlasMargin, /*!< map atlas margin*/ - MapLayers, /*!< map layer set*/ - MapStylePreset, /*!< layer and style map theme */ + MapRotation, //!< Map rotation + MapScale, //!< Map scale + MapXMin, //!< Map extent x minimum + MapYMin, //!< Map extent y minimum + MapXMax, //!< Map extent x maximum + MapYMax, //!< Map extent y maximum + MapAtlasMargin, //!< Map atlas margin + MapLayers, //!< Map layer set + MapStylePreset, //!< Layer and style map theme //composer picture - PictureSource, /*!< picture source url */ + PictureSource, //!< Picture source url //html item - SourceUrl /*!< html source url */ + SourceUrl //!< Html source url }; /** Specifies whether the value returned by a function should be the original, user @@ -80,8 +80,8 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext */ enum PropertyValueType { - EvaluatedValue = 0, /*!< return the current evaluated value for the property */ - OriginalValue /*!< return the original, user set value */ + EvaluatedValue = 0, //!< Return the current evaluated value for the property + OriginalValue //!< Return the original, user set value }; /** Constructor @@ -172,7 +172,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext public slots: - /** Triggers a redraw for the item*/ + //! Triggers a redraw for the item virtual void repaint(); /** Refreshes a data defined property for the item by reevaluating the property's value @@ -189,10 +189,10 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext QgsComposition* mComposition; - /** Map of data defined properties for the item to string name to use when exporting item to xml*/ + //! Map of data defined properties for the item to string name to use when exporting item to xml QMap< QgsComposerObject::DataDefinedProperty, QString > mDataDefinedNames; - /** Custom properties for object*/ + //! Custom properties for object QgsObjectCustomProperties mCustomProperties; /** Evaluate a data defined property and return the calculated value @@ -219,7 +219,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext private: - /** Map of current data defined properties*/ + //! Map of current data defined properties //mutable since expressions in data defineds need to be preparable mutable QMap< QgsComposerObject::DataDefinedProperty, QgsDataDefined* > mDataDefinedProperties; diff --git a/src/core/composer/qgscomposerpicture.h b/src/core/composer/qgscomposerpicture.h index 17027508ec0..6016ea9e3cd 100644 --- a/src/core/composer/qgscomposerpicture.h +++ b/src/core/composer/qgscomposerpicture.h @@ -37,11 +37,11 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ enum ResizeMode { - Zoom, /*!< enlarges image to fit frame while maintaining aspect ratio of picture */ - Stretch, /*!< stretches image to fit frame, ignores aspect ratio */ - Clip, /*!< draws image at original size and clips any portion which falls outside frame */ - ZoomResizeFrame, /*!< enlarges image to fit frame, then resizes frame to fit resultant image */ - FrameToImageSize /*!< sets size of frame to match original size of image without scaling */ + Zoom, //!< Enlarges image to fit frame while maintaining aspect ratio of picture + Stretch, //!< Stretches image to fit frame, ignores aspect ratio + Clip, //!< Draws image at original size and clips any portion which falls outside frame + ZoomResizeFrame, //!< Enlarges image to fit frame, then resizes frame to fit resultant image + FrameToImageSize //!< Sets size of frame to match original size of image without scaling }; /** Format of source image @@ -56,17 +56,17 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem //! Method for syncing rotation to a map's North direction enum NorthMode { - GridNorth = 0, /*!< Align to grid north */ - TrueNorth, /*!< Align to true north */ + GridNorth = 0, //!< Align to grid north + TrueNorth, //!< Align to true north }; QgsComposerPicture( QgsComposition *composition ); ~QgsComposerPicture(); - /** Return correct graphics item type. */ + //! Return correct graphics item type. virtual int type() const override { return ComposerPicture; } - /** Reimplementation of QCanvasItem::paint*/ + //! Reimplementation of QCanvasItem::paint void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; /** Sets the source path of the image (may be svg or a raster format). Data defined @@ -284,19 +284,19 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem virtual void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext *context = nullptr ) override; signals: - /** Is emitted on picture rotation change*/ + //! Is emitted on picture rotation change void pictureRotationChanged( double newRotation ); private: //default constructor is forbidden QgsComposerPicture(); - /** Calculates bounding rect for svg file (mSourcefile) such that aspect ratio is correct*/ + //! Calculates bounding rect for svg file (mSourcefile) such that aspect ratio is correct QRectF boundedSVGRect( double deviceWidth, double deviceHeight ); - /** Calculates bounding rect for image such that aspect ratio is correct*/ + //! Calculates bounding rect for image such that aspect ratio is correct QRectF boundedImageRect( double deviceWidth, double deviceHeight ); - /** Returns size of current raster or svg picture */ + //! Returns size of current raster or svg picture QSizeF pictureSize(); QImage mImage; @@ -306,9 +306,9 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem QSize mDefaultSvgSize; - /** Image rotation*/ + //! Image rotation double mPictureRotation; - /** Map that sets the rotation (or 0 if this picture uses map independent rotation)*/ + //! Map that sets the rotation (or 0 if this picture uses map independent rotation) const QgsComposerMap* mRotationMap; //! Mode used to align to North @@ -316,9 +316,9 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem //! Offset for north arrow double mNorthOffset; - /** Width of the picture (in mm)*/ + //! Width of the picture (in mm) double mPictureWidth; - /** Height of the picture (in mm)*/ + //! Height of the picture (in mm) double mPictureHeight; ResizeMode mResizeMode; @@ -332,10 +332,10 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem bool mLoaded; bool mLoadingSvg; - /** Loads an image file into the picture item and redraws the item*/ + //! Loads an image file into the picture item and redraws the item void loadPicture( const QString &path ); - /** Sets up the picture item and connects to relevant signals*/ + //! Sets up the picture item and connects to relevant signals void init(); /** Returns part of a raster image which will be shown, given current picture diff --git a/src/core/composer/qgscomposerpolygon.h b/src/core/composer/qgscomposerpolygon.h index e6d02744728..d4e533cfff7 100644 --- a/src/core/composer/qgscomposerpolygon.h +++ b/src/core/composer/qgscomposerpolygon.h @@ -45,24 +45,24 @@ class CORE_EXPORT QgsComposerPolygon: public QgsComposerNodesItem */ QgsComposerPolygon( const QPolygonF &polygon, QgsComposition* c ); - /** Destructor */ + //! Destructor ~QgsComposerPolygon(); - /** Overridden to return shape name */ + //! Overridden to return shape name virtual QString displayName() const override; - /** Returns the QgsSymbol used to draw the shape. */ + //! Returns the QgsSymbol used to draw the shape. QgsFillSymbol* polygonStyleSymbol() { return mPolygonStyleSymbol.data(); } - /** Set the QgsSymbol used to draw the shape. */ + //! Set the QgsSymbol used to draw the shape. void setPolygonStyleSymbol( QgsFillSymbol* symbol ); - /** Return correct graphics item type. */ + //! Return correct graphics item type. virtual int type() const override { return ComposerPolygon; } protected: - /** QgsSymbol use to draw the shape. */ + //! QgsSymbol use to draw the shape. QScopedPointer mPolygonStyleSymbol; /** Add the node newPoint at the given position according to some @@ -71,16 +71,16 @@ class CORE_EXPORT QgsComposerPolygon: public QgsComposerNodesItem bool _removeNode( const int nodeIndex ) override; - /** Draw nodes for the current shape. */ + //! Draw nodes for the current shape. void _draw( QPainter *painter ) override; - /** Read symbol in XML. */ + //! Read symbol in XML. void _readXmlStyle( const QDomElement &elmt ) override; - /** Write the symbol in an XML document. */ + //! Write the symbol in an XML document. void _writeXmlStyle( QDomDocument &doc, QDomElement &elmt ) const override; - /** Create a default symbol. */ + //! Create a default symbol. void createDefaultPolygonStyleSymbol(); }; diff --git a/src/core/composer/qgscomposerpolyline.h b/src/core/composer/qgscomposerpolyline.h index c9c03ea4abd..ba748c868ae 100644 --- a/src/core/composer/qgscomposerpolyline.h +++ b/src/core/composer/qgscomposerpolyline.h @@ -44,24 +44,24 @@ class CORE_EXPORT QgsComposerPolyline: public QgsComposerNodesItem */ QgsComposerPolyline( const QPolygonF &polyline, QgsComposition* c ); - /** Destructor */ + //! Destructor ~QgsComposerPolyline(); - /** Overridden to return shape name */ + //! Overridden to return shape name virtual QString displayName() const override; - /** Returns the QgsSymbol used to draw the shape. */ + //! Returns the QgsSymbol used to draw the shape. QgsLineSymbol* polylineStyleSymbol() { return mPolylineStyleSymbol.data(); } - /** Set the QgsSymbol used to draw the shape. */ + //! Set the QgsSymbol used to draw the shape. void setPolylineStyleSymbol( QgsLineSymbol* symbol ); - /** Overridden to return shape type */ + //! Overridden to return shape type virtual int type() const override { return ComposerPolyline; } protected: - /** QgsSymbol use to draw the shape. */ + //! QgsSymbol use to draw the shape. QScopedPointer mPolylineStyleSymbol; /** Add the node newPoint at the given position according to some @@ -70,16 +70,16 @@ class CORE_EXPORT QgsComposerPolyline: public QgsComposerNodesItem bool _removeNode( const int nodeIndex ) override; - /** Draw nodes for the current shape. */ + //! Draw nodes for the current shape. void _draw( QPainter *painter ) override; - /** Read symbol in XML. */ + //! Read symbol in XML. void _readXmlStyle( const QDomElement &elmt ) override; - /** Write the symbol in an XML document. */ + //! Write the symbol in an XML document. void _writeXmlStyle( QDomDocument &doc, QDomElement &elmt ) const override; - /** Create a default symbol. */ + //! Create a default symbol. void createDefaultPolylineStyleSymbol(); }; diff --git a/src/core/composer/qgscomposerscalebar.h b/src/core/composer/qgscomposerscalebar.h index 4b4bf8840ce..f22c5df9341 100644 --- a/src/core/composer/qgscomposerscalebar.h +++ b/src/core/composer/qgscomposerscalebar.h @@ -52,17 +52,17 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ enum SegmentSizeMode { - SegmentSizeFixed = 0, /*!< Scale bar segment size is fixed to a map unit*/ - SegmentSizeFitWidth = 1 /*!< Scale bar segment size is calculated to fit a size range*/ + SegmentSizeFixed = 0, //!< Scale bar segment size is fixed to a map unit + SegmentSizeFitWidth = 1 //!< Scale bar segment size is calculated to fit a size range }; QgsComposerScaleBar( QgsComposition* composition ); ~QgsComposerScaleBar(); - /** Return correct graphics item type. */ + //! Return correct graphics item type. virtual int type() const override { return ComposerScaleBar; } - /** \brief Reimplementation of QCanvasItem::paint*/ + //! \brief Reimplementation of QCanvasItem::paint void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; //getters and setters @@ -217,7 +217,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem double segmentMillimeters() const {return mSegmentMillimeters;} - /** Left / Middle/ Right */ + //! Left / Middle/ Right Alignment alignment() const { return mAlignment; } void setAlignment( Alignment a ); @@ -254,16 +254,16 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ void setLineCapStyle( Qt::PenCapStyle style ); - /** Apply default settings*/ + //! Apply default settings void applyDefaultSettings(); - /** Apply default size (scale bar 1/5 of map item width) */ + //! Apply default size (scale bar 1/5 of map item width) void applyDefaultSize( ScaleBarUnits u = Meters ); /** Sets style by name @param styleName (untranslated) style name. Possibilities are: 'Single Box', 'Double Box', 'Line Ticks Middle', 'Line Ticks Down', 'Line Ticks Up', 'Numeric'*/ void setStyle( const QString& styleName ); - /** Returns style name*/ + //! Returns style name QString style() const; /** Returns the x - positions of the segment borders (in item coordinates) and the width @@ -272,13 +272,13 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ void segmentPositions( QList >& posWidthList ) const; - /** Sets box size suitable to content*/ + //! Sets box size suitable to content void adjustBoxSize(); - /** Adjusts box size and calls QgsComposerItem::update()*/ + //! Adjusts box size and calls QgsComposerItem::update() void update(); - /** Returns string of first label (important for drawing, labeling, size calculation*/ + //! Returns string of first label (important for drawing, labeling, size calculation QString firstLabelString() const; /** Stores state in Dom element @@ -293,7 +293,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ bool readXml( const QDomElement& itemElem, const QDomDocument& doc ) override; - /** Moves scalebar position to the left / right depending on alignment and change in item width*/ + //! Moves scalebar position to the left / right depending on alignment and change in item width void correctXPositionAlignment( double width, double widthAfter ); //overridden to apply minimum size @@ -301,51 +301,51 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem public slots: void updateSegmentSize(); - /** Sets mCompositionMap to 0 if the map is deleted*/ + //! Sets mCompositionMap to 0 if the map is deleted void invalidateCurrentMap(); protected: - /** Reference to composer map object*/ + //! Reference to composer map object const QgsComposerMap* mComposerMap; - /** Number of segments on right side*/ + //! Number of segments on right side int mNumSegments; - /** Number of segments on left side*/ + //! Number of segments on left side int mNumSegmentsLeft; - /** Size of a segment (in map units)*/ + //! Size of a segment (in map units) double mNumUnitsPerSegment; - /** Number of map units per scale bar units (e.g. 1000 to have km for a map with m units)*/ + //! Number of map units per scale bar units (e.g. 1000 to have km for a map with m units) double mNumMapUnitsPerScaleBarUnit; - /** Either fixed (i.e. mNumUnitsPerSegment) or try to best fit scale bar width (mMinBarWidth, mMaxBarWidth)*/ + //! Either fixed (i.e. mNumUnitsPerSegment) or try to best fit scale bar width (mMinBarWidth, mMaxBarWidth) SegmentSizeMode mSegmentSizeMode; - /** Minimum allowed bar width, when mSegmentSizeMode is FitWidth*/ + //! Minimum allowed bar width, when mSegmentSizeMode is FitWidth double mMinBarWidth; - /** Maximum allowed bar width, when mSegmentSizeMode is FitWidth*/ + //! Maximum allowed bar width, when mSegmentSizeMode is FitWidth double mMaxBarWidth; - /** Labeling of map units*/ + //! Labeling of map units QString mUnitLabeling; - /** Font*/ + //! Font QFont mFont; QColor mFontColor; - /** Outline*/ + //! Outline QPen mPen; - /** Fill*/ + //! Fill QBrush mBrush; - /** Secondary fill*/ + //! Secondary fill QBrush mBrush2; - /** Height of bars/lines*/ + //! Height of bars/lines double mHeight; - /** Scalebar style*/ + //! Scalebar style QgsScaleBarStyle* mStyle; - /** Space between bar and Text labels*/ + //! Space between bar and Text labels double mLabelBarSpace; - /** Space between content and item box*/ + //! Space between content and item box double mBoxContentSpace; - /** Width of a segment (in mm)*/ + //! Width of a segment (in mm) double mSegmentMillimeters; Alignment mAlignment; @@ -355,10 +355,10 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem Qt::PenJoinStyle mLineJoinStyle; Qt::PenCapStyle mLineCapStyle; - /** Calculates with of a segment in mm and stores it in mSegmentMillimeters*/ + //! Calculates with of a segment in mm and stores it in mSegmentMillimeters void refreshSegmentMillimeters(); - /** Returns diagonal of composer map in selected units (map units / meters / feet / nautical miles)*/ + //! Returns diagonal of composer map in selected units (map units / meters / feet / nautical miles) double mapWidth() const; }; diff --git a/src/core/composer/qgscomposershape.h b/src/core/composer/qgscomposershape.h index 0705fd0c509..b1a24a95380 100644 --- a/src/core/composer/qgscomposershape.h +++ b/src/core/composer/qgscomposershape.h @@ -42,10 +42,10 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem QgsComposerShape( qreal x, qreal y, qreal width, qreal height, QgsComposition* composition ); ~QgsComposerShape(); - /** Return correct graphics item type. */ + //! Return correct graphics item type. virtual int type() const override { return ComposerShape; } - /** \brief Reimplementation of QCanvasItem::paint - draw on canvas */ + //! \brief Reimplementation of QCanvasItem::paint - draw on canvas void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; /** Stores state in Dom element @@ -64,9 +64,9 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem QgsComposerShape::Shape shapeType() const { return mShape; } void setShapeType( QgsComposerShape::Shape s ); - /** Sets radius for rounded rectangle corners. Added in v2.1 */ + //! Sets radius for rounded rectangle corners. Added in v2.1 void setCornerRadius( double radius ); - /** Returns the radius for rounded rectangle corners*/ + //! Returns the radius for rounded rectangle corners double cornerRadius() const { return mCornerRadius; } /** Sets the QgsFillSymbol used to draw the shape. Must also call setUseSymbol( true ) to @@ -109,7 +109,7 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem void refreshSymbol(); private: - /** Ellipse, rectangle or triangle*/ + //! Ellipse, rectangle or triangle Shape mShape; double mCornerRadius; @@ -118,7 +118,7 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem QgsFillSymbol* mShapeStyleSymbol; double mMaxSymbolBleed; - /** Current bounding rectangle of shape*/ + //! Current bounding rectangle of shape QRectF mCurrentRectangle; /* draws the custom shape */ @@ -130,10 +130,10 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem /* creates the default shape symbol */ void createDefaultShapeStyleSymbol(); - /** Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point*/ + //! Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point QPointF pointOnLineWithDistance( const QPointF& startPoint, const QPointF& directionPoint, double distance ) const; - /** Updates the bounding rect of this item*/ + //! Updates the bounding rect of this item void updateBoundingRect(); }; diff --git a/src/core/composer/qgscomposertablev2.h b/src/core/composer/qgscomposertablev2.h index e2c7af55184..7c10788c7f6 100644 --- a/src/core/composer/qgscomposertablev2.h +++ b/src/core/composer/qgscomposertablev2.h @@ -97,51 +97,51 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ enum HeaderHAlignment { - FollowColumn, /*!< header uses the same alignment as the column */ - HeaderLeft, /*!< align headers left */ - HeaderCenter, /*!< align headers to center */ - HeaderRight /*!< align headers right */ + FollowColumn, //!< Header uses the same alignment as the column + HeaderLeft, //!< Align headers left + HeaderCenter, //!< Align headers to center + HeaderRight //!< Align headers right }; /** Controls where headers are shown in the table */ enum HeaderMode { - FirstFrame = 0, /*!< header shown on first frame only */ - AllFrames, /*!< headers shown on all frames */ - NoHeaders /*!< no headers shown for table */ + FirstFrame = 0, //!< Header shown on first frame only + AllFrames, //!< Headers shown on all frames + NoHeaders //!< No headers shown for table }; /** Controls how empty tables are displayed */ enum EmptyTableMode { - HeadersOnly = 0, /*!< show header rows only */ - HideTable, /*!< hides entire table if empty */ - ShowMessage /*!< shows preset message instead of table contents*/ + HeadersOnly = 0, //!< Show header rows only + HideTable, //!< Hides entire table if empty + ShowMessage //!< Shows preset message instead of table contents }; /** Controls how long strings in the table are handled */ enum WrapBehaviour { - TruncateText = 0, /*!< text which doesn't fit inside the cell is truncated */ - WrapText /*!< text which doesn't fit inside the cell is wrapped. Note that this only applies to text in columns with a fixed width. */ + TruncateText = 0, //!< Text which doesn't fit inside the cell is truncated + WrapText //!< Text which doesn't fit inside the cell is wrapped. Note that this only applies to text in columns with a fixed width. }; /** Row or column groups for cell styling */ enum CellStyleGroup { - OddColumns, /*!< Style odd numbered columns */ - EvenColumns, /*!< Style even numbered columns */ - OddRows, /*!< Style odd numbered rows */ - EvenRows, /*!< Style even numbered rows */ - FirstColumn, /*!< Style first column only */ - LastColumn, /*!< Style last column only */ - HeaderRow, /*!< Style header row */ - FirstRow, /*!< Style first row only */ - LastRow /*!< Style last row only */ + OddColumns, //!< Style odd numbered columns + EvenColumns, //!< Style even numbered columns + OddRows, //!< Style odd numbered rows + EvenRows, //!< Style even numbered rows + FirstColumn, //!< Style first column only + LastColumn, //!< Style last column only + HeaderRow, //!< Style header row + FirstRow, //!< Style first row only + LastRow //!< Style last row only }; QgsComposerTableV2( QgsComposition* composition, bool createUndoCommands ); @@ -478,64 +478,64 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame void recalculateFrameSizes() override; protected: - /** Margin between cell borders and cell text*/ + //! Margin between cell borders and cell text double mCellMargin; - /** Behaviour for empty tables*/ + //! Behaviour for empty tables EmptyTableMode mEmptyTableMode; - /** String to show in empty tables*/ + //! String to show in empty tables QString mEmptyTableMessage; - /** True if empty rows should be shown in the table*/ + //! True if empty rows should be shown in the table bool mShowEmptyRows; - /** Header font*/ + //! Header font QFont mHeaderFont; - /** Header font color*/ + //! Header font color QColor mHeaderFontColor; - /** Alignment for table headers*/ + //! Alignment for table headers HeaderHAlignment mHeaderHAlignment; - /** Header display mode*/ + //! Header display mode HeaderMode mHeaderMode; - /** Table contents font*/ + //! Table contents font QFont mContentFont; - /** Table contents font color*/ + //! Table contents font color QColor mContentFontColor; - /** True if grid should be shown*/ + //! True if grid should be shown bool mShowGrid; - /** Width of grid lines*/ + //! Width of grid lines double mGridStrokeWidth; - /** Color for grid lines*/ + //! Color for grid lines QColor mGridColor; - /** True if grid should be shown*/ + //! True if grid should be shown bool mHorizontalGrid; - /** True if grid should be shown*/ + //! True if grid should be shown bool mVerticalGrid; - /** Color for table background*/ + //! Color for table background QColor mBackgroundColor; - /** Columns to show in table*/ + //! Columns to show in table QgsComposerTableColumns mColumns; - /** Contents to show in table*/ + //! Contents to show in table QgsComposerTableContents mTableContents; - /** Map of maximum width for each column*/ + //! Map of maximum width for each column QMap mMaxColumnWidthMap; - /** Map of maximum height for each row*/ + //! Map of maximum height for each row QMap mMaxRowHeightMap; QSizeF mTableSize; @@ -641,7 +641,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame QMap< CellStyleGroup, QString > mCellStyleNames; - /** Initializes cell style map */ + //! Initializes cell style map void initStyles(); bool textRequiresWrapping( const QString& text, double columnWidth , const QFont &font ) const; diff --git a/src/core/composer/qgscomposertexttable.h b/src/core/composer/qgscomposertexttable.h index 1931de2a73b..e4df33df7d2 100644 --- a/src/core/composer/qgscomposertexttable.h +++ b/src/core/composer/qgscomposertexttable.h @@ -53,7 +53,7 @@ class CORE_EXPORT QgsComposerTextTableV2 : public QgsComposerTableV2 virtual void addFrame( QgsComposerFrame* frame, bool recalcFrameSizes = true ) override; private: - /** One stringlist per row*/ + //! One stringlist per row QList< QStringList > mRowText; }; diff --git a/src/core/composer/qgscomposition.h b/src/core/composer/qgscomposition.h index becad079f81..c05cf7fec19 100644 --- a/src/core/composer/qgscomposition.h +++ b/src/core/composer/qgscomposition.h @@ -76,7 +76,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo Q_OBJECT public: - /** \brief Plot type */ + //! \brief Plot type enum PlotStyle { Preview = 0, // Use cache etc @@ -84,7 +84,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo Postscript // Fonts need different scaling! }; - /** Style to draw the snapping grid*/ + //! Style to draw the snapping grid enum GridStyle { Solid, @@ -106,7 +106,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo explicit QgsComposition( const QgsMapSettings& mapSettings ); - /** Composition atlas modes*/ + //! Composition atlas modes enum AtlasMode { AtlasOff, // Composition is not being controlled by an atlas @@ -220,9 +220,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ bool shouldExportPage( const int page ) const; - /** Note: added in version 2.1*/ + //! Note: added in version 2.1 void setPageStyleSymbol( QgsFillSymbol* symbol ); - /** Note: added in version 2.1*/ + //! Note: added in version 2.1 QgsFillSymbol* pageStyleSymbol() { return mPageStyleSymbol; } /** Returns the position within a page of a point in the composition @@ -251,7 +251,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void setGridVisible( const bool b ); bool gridVisible() const {return mGridVisible;} - /** Hides / shows custom snap lines*/ + //! Hides / shows custom snap lines void setSnapLinesVisible( const bool visible ); bool snapLinesVisible() const {return mGuidesVisible;} @@ -278,7 +278,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ bool pagesVisible() const { return mPagesVisible; } - /** Removes all snap lines*/ + //! Removes all snap lines void clearSnapLines(); void setSnapGridResolution( const double r ); @@ -326,7 +326,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ bool boundingBoxesVisible() const { return mBoundingBoxesVisible; } - /** Returns pointer to undo/redo command storage*/ + //! Returns pointer to undo/redo command storage QUndoStack* undoStack() { return mUndoStack; } /** Returns the topmost composer item at a specified position. Ignores paper items. @@ -344,10 +344,10 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ QgsComposerItem* composerItemAt( QPointF position, const QgsComposerItem* belowItem, const bool ignoreLocked = false ) const; - /** Returns the page number (0-based) given a coordinate */ + //! Returns the page number (0-based) given a coordinate int pageNumberAt( QPointF position ) const; - /** Returns on which page number (0-based) is displayed an item */ + //! Returns on which page number (0-based) is displayed an item int itemPageNumber( const QgsComposerItem* ) const; /** Returns list of selected composer items @@ -428,9 +428,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void setWorldFileMap( QgsComposerMap* map ); - /** Returns true if a composition should use advanced effects such as blend modes */ + //! Returns true if a composition should use advanced effects such as blend modes bool useAdvancedEffects() const {return mUseAdvancedEffects;} - /** Used to enable or disable advanced effects such as blend modes in a composition */ + //! Used to enable or disable advanced effects such as blend modes in a composition void setUseAdvancedEffects( const bool effectsEnabled ); //! Return setting of QGIS map canvas @@ -440,10 +440,10 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QgsComposition::PlotStyle plotStyle() const { return mPlotStyle; } void setPlotStyle( const QgsComposition::PlotStyle style ) { mPlotStyle = style; } - /** Writes settings to xml (paper dimension)*/ + //! Writes settings to xml (paper dimension) bool writeXml( QDomElement& composerElem, QDomDocument& doc ); - /** Reads settings from xml file*/ + //! Reads settings from xml file bool readXml( const QDomElement& compositionElem, const QDomDocument& doc ); /** Load a template document @@ -469,9 +469,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void addItemsFromXml( const QDomElement& elem, const QDomDocument& doc, QMap< QgsComposerMap*, int >* mapsToRestore = nullptr, bool addUndoCommands = false, QPointF* pos = nullptr, bool pasteInPlace = false ); - /** Adds item to z list. Usually called from constructor of QgsComposerItem*/ + //! Adds item to z list. Usually called from constructor of QgsComposerItem void addItemToZList( QgsComposerItem* item ); - /** Removes item from z list. Usually called from destructor of QgsComposerItem*/ + //! Removes item from z list. Usually called from destructor of QgsComposerItem void removeItemFromZList( QgsComposerItem* item ); //functions to move selected items in hierarchy @@ -503,9 +503,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void alignSelectedItemsBottom(); //functions to lock and unlock items - /** Lock the selected items*/ + //! Lock the selected items void lockSelectedItems(); - /** Unlock all items*/ + //! Unlock all items void unlockAllItems(); /** Creates a new group from a list of composer items and adds it to the composition. @@ -529,10 +529,10 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void refreshZList(); - /** Snaps a scene coordinate point to grid*/ + //! Snaps a scene coordinate point to grid QPointF snapPointToGrid( QPointF scenePoint ) const; - /** Returns pointer to snap lines collection*/ + //! Returns pointer to snap lines collection QList< QGraphicsLineItem* >* snapLines() {return &mSnapLines;} /** Returns pointer to selection handles @@ -540,9 +540,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ QgsComposerMouseHandles* selectionHandles() {return mSelectionHandles;} - /** Add a custom snap line (can be horizontal or vertical)*/ + //! Add a custom snap line (can be horizontal or vertical) QGraphicsLineItem* addSnapLine(); - /** Remove custom snap line (and delete the object)*/ + //! Remove custom snap line (and delete the object) void removeSnapLine( QGraphicsLineItem* line ); /** Get nearest snap line * @note not available in python bindings @@ -556,48 +556,48 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void beginCommand( QgsComposerItem* item, const QString& commandText, const QgsComposerMergeCommand::Context c = QgsComposerMergeCommand::Unknown ); - /** Saves end state of item and pushes command to the undo history*/ + //! Saves end state of item and pushes command to the undo history void endCommand(); - /** Deletes current command*/ + //! Deletes current command void cancelCommand(); void beginMultiFrameCommand( QgsComposerMultiFrame* multiFrame, const QString& text, const QgsComposerMultiFrameMergeCommand::Context c = QgsComposerMultiFrameMergeCommand::Unknown ); void endMultiFrameCommand(); - /** Deletes current multi frame command*/ + //! Deletes current multi frame command void cancelMultiFrameCommand(); - /** Adds multiframe. The object is owned by QgsComposition until removeMultiFrame is called*/ + //! Adds multiframe. The object is owned by QgsComposition until removeMultiFrame is called void addMultiFrame( QgsComposerMultiFrame* multiFrame ); - /** Removes multi frame (but does not delete it)*/ + //! Removes multi frame (but does not delete it) void removeMultiFrame( QgsComposerMultiFrame* multiFrame ); /** Adds an arrow item to the graphics scene and advises composer to create a widget for it (through signal) @note not available in python bindings*/ void addComposerArrow( QgsComposerArrow* arrow ); - /** Adds label to the graphics scene and advises composer to create a widget for it (through signal)*/ + //! Adds label to the graphics scene and advises composer to create a widget for it (through signal) void addComposerLabel( QgsComposerLabel* label ); - /** Adds map to the graphics scene and advises composer to create a widget for it (through signal)*/ + //! Adds map to the graphics scene and advises composer to create a widget for it (through signal) void addComposerMap( QgsComposerMap* map, const bool setDefaultPreviewStyle = true ); - /** Adds scale bar to the graphics scene and advises composer to create a widget for it (through signal)*/ + //! Adds scale bar to the graphics scene and advises composer to create a widget for it (through signal) void addComposerScaleBar( QgsComposerScaleBar* scaleBar ); - /** Adds legend to the graphics scene and advises composer to create a widget for it (through signal)*/ + //! Adds legend to the graphics scene and advises composer to create a widget for it (through signal) void addComposerLegend( QgsComposerLegend* legend ); - /** Adds picture to the graphics scene and advises composer to create a widget for it (through signal)*/ + //! Adds picture to the graphics scene and advises composer to create a widget for it (through signal) void addComposerPicture( QgsComposerPicture* picture ); - /** Adds a composer shape to the graphics scene and advises composer to create a widget for it (through signal)*/ + //! Adds a composer shape to the graphics scene and advises composer to create a widget for it (through signal) void addComposerShape( QgsComposerShape* shape ); - /** Adds a composer polygon and advises composer to create a widget for it (through signal)*/ + //! Adds a composer polygon and advises composer to create a widget for it (through signal) void addComposerPolygon( QgsComposerPolygon* polygon ); - /** Adds a composer polyline and advises composer to create a widget for it (through signal)*/ + //! Adds a composer polyline and advises composer to create a widget for it (through signal) void addComposerPolyline( QgsComposerPolyline* polyline ); - /** Adds composer html frame and advises composer to create a widget for it (through signal)*/ + //! Adds composer html frame and advises composer to create a widget for it (through signal) void addComposerHtmlFrame( QgsComposerHtml* html, QgsComposerFrame* frame ); - /** Adds composer tablev2 frame and advises composer to create a widget for it (through signal)*/ + //! Adds composer tablev2 frame and advises composer to create a widget for it (through signal) void addComposerTableFrame( QgsComposerAttributeTableV2* table, QgsComposerFrame* frame ); - /** Remove item from the graphics scene. Additionally to QGraphicsScene::removeItem, this function considers undo/redo command*/ + //! Remove item from the graphics scene. Additionally to QGraphicsScene::removeItem, this function considers undo/redo command void removeComposerItem( QgsComposerItem* item, const bool createCommand = true, const bool removeGroupItems = true ); - /** Convenience function to create a QgsAddRemoveItemCommand, connect its signals and push it to the undo stack*/ + //! Convenience function to create a QgsAddRemoveItemCommand, connect its signals and push it to the undo stack void pushAddRemoveCommand( QgsComposerItem* item, const QString& text, const QgsAddRemoveItemCommand::State state = QgsAddRemoveItemCommand::Added ); /** If true, prevents any mouse cursor changes by the composition or by any composer items @@ -608,9 +608,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //printing - /** Prepare the printer for printing */ + //! Prepare the printer for printing void beginPrint( QPrinter& printer, const bool evaluateDDPageSize = false ); - /** Prepare the printer for printing in a PDF */ + //! Prepare the printer for printing in a PDF void beginPrintAsPDF( QPrinter& printer, const QString& file ); /** Print on a preconfigured printer @@ -800,7 +800,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QRectF compositionBounds( bool ignorePages = false, double margin = 0.0 ) const; public slots: - /** Casts object to the proper subclass type and calls corresponding itemAdded signal*/ + //! Casts object to the proper subclass type and calls corresponding itemAdded signal void sendItemAddedSignal( QgsComposerItem* item ); /** Updates the scene bounds of the composition @@ -846,7 +846,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo private: - /** Reference to map settings of QGIS main map*/ + //! Reference to map settings of QGIS main map const QgsMapSettings& mMapSettings; QgsComposition::PlotStyle mPlotStyle; @@ -855,29 +855,29 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QList< QgsPaperItem* > mPages; double mSpaceBetweenPages; //space in preview between pages - /** Drawing style for page*/ + //! Drawing style for page QgsFillSymbol* mPageStyleSymbol; void createDefaultPageStyleSymbol(); - /** List multiframe objects*/ + //! List multiframe objects QSet mMultiFrames; - /** Dpi for printout*/ + //! Dpi for printout int mPrintResolution; - /** Flag if map should be printed as a raster (via QImage). False by default*/ + //! Flag if map should be printed as a raster (via QImage). False by default bool mPrintAsRaster; - /** Flag if a world file should be generated on raster export */ + //! Flag if a world file should be generated on raster export bool mGenerateWorldFile; - /** Item ID for composer map to use for the world file generation */ + //! Item ID for composer map to use for the world file generation QString mWorldFileMapId; - /** Flag if advanced visual effects such as blend modes should be used. True by default*/ + //! Flag if advanced visual effects such as blend modes should be used. True by default bool mUseAdvancedEffects; - /** Parameters for snap to grid function*/ + //! Parameters for snap to grid function bool mSnapToGrid; bool mGridVisible; double mSnapGridResolution; @@ -886,13 +886,13 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QPen mGridPen; GridStyle mGridStyle; - /** Parameters for alignment snap*/ + //! Parameters for alignment snap bool mAlignmentSnap; bool mGuidesVisible; bool mSmartGuides; int mSnapTolerance; - /** Arbitraty snap lines (horizontal and vertical)*/ + //! Arbitraty snap lines (horizontal and vertical) QList< QGraphicsLineItem* > mSnapLines; double mResizeToContentsMarginTop; @@ -909,7 +909,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QgsComposerItemCommand* mActiveItemCommand; QgsComposerMultiFrameCommand* mActiveMultiFrameCommand; - /** The atlas composition object. It is held by the QgsComposition */ + //! The atlas composition object. It is held by the QgsComposition QgsAtlasComposition mAtlasComposition; QgsComposition::AtlasMode mAtlasMode; @@ -918,29 +918,29 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QgsComposerModel * mItemsModel; - /** Map of data defined properties for the composition to string name to use when exporting composition to xml*/ + //! Map of data defined properties for the composition to string name to use when exporting composition to xml QMap< QgsComposerObject::DataDefinedProperty, QString > mDataDefinedNames; - /** Map of current data defined properties to QgsDataDefined for the composition*/ + //! Map of current data defined properties to QgsDataDefined for the composition QMap< QgsComposerObject::DataDefinedProperty, QgsDataDefined* > mDataDefinedProperties; QgsObjectCustomProperties mCustomProperties; QgsComposition(); //default constructor is forbidden - /** Reset z-values of items based on position in z list*/ + //! Reset z-values of items based on position in z list void updateZValues( const bool addUndoCommands = true ); /** Returns the bounding rectangle of the selected items in scene coordinates @return 0 in case of success*/ int boundingRectOfSelectedItems( QRectF& bRect ); - /** Loads default composer settings*/ + //! Loads default composer settings void loadDefaults(); - /** Loads composer settings which may change, eg grid color*/ + //! Loads composer settings which may change, eg grid color void loadSettings(); - /** Calculates the item minimum position from an xml string*/ + //! Calculates the item minimum position from an xml string QPointF minPointFromXml( const QDomElement& elem ) const; void connectAddRemoveCommandSignals( QgsAddRemoveItemCommand* c ); @@ -1028,42 +1028,42 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void paperSizeChanged(); void nPagesChanged(); - /** Is emitted when the compositions print resolution changes*/ + //! Is emitted when the compositions print resolution changes void printResolutionChanged(); - /** Is emitted when selected item changed. If 0, no item is selected*/ + //! Is emitted when selected item changed. If 0, no item is selected void selectedItemChanged( QgsComposerItem* selected ); - /** Is emitted when new composer arrow has been added to the view*/ + //! Is emitted when new composer arrow has been added to the view void composerArrowAdded( QgsComposerArrow* arrow ); - /** Is emitted when new composer polygon has been added to the view*/ + //! Is emitted when new composer polygon has been added to the view void composerPolygonAdded( QgsComposerPolygon* polygon ); - /** Is emitted when new composer polyline has been added to the view*/ + //! Is emitted when new composer polyline has been added to the view void composerPolylineAdded( QgsComposerPolyline* polyline ); - /** Is emitted when a new composer html has been added to the view*/ + //! Is emitted when a new composer html has been added to the view void composerHtmlFrameAdded( QgsComposerHtml* html, QgsComposerFrame* frame ); - /** Is emitted when a new item group has been added to the view*/ + //! Is emitted when a new item group has been added to the view void composerItemGroupAdded( QgsComposerItemGroup* group ); - /** Is emitted when new composer label has been added to the view*/ + //! Is emitted when new composer label has been added to the view void composerLabelAdded( QgsComposerLabel* label ); - /** Is emitted when new composer map has been added to the view*/ + //! Is emitted when new composer map has been added to the view void composerMapAdded( QgsComposerMap* map ); - /** Is emitted when new composer scale bar has been added*/ + //! Is emitted when new composer scale bar has been added void composerScaleBarAdded( QgsComposerScaleBar* scalebar ); - /** Is emitted when a new composer legend has been added*/ + //! Is emitted when a new composer legend has been added void composerLegendAdded( QgsComposerLegend* legend ); - /** Is emitted when a new composer picture has been added*/ + //! Is emitted when a new composer picture has been added void composerPictureAdded( QgsComposerPicture* picture ); - /** Is emitted when a new composer shape has been added*/ + //! Is emitted when a new composer shape has been added void composerShapeAdded( QgsComposerShape* shape ); - /** Is emitted when a new composer table frame has been added to the view*/ + //! Is emitted when a new composer table frame has been added to the view void composerTableFrameAdded( QgsComposerAttributeTableV2* table, QgsComposerFrame* frame ); - /** Is emitted when a composer item has been removed from the scene*/ + //! Is emitted when a composer item has been removed from the scene void itemRemoved( QgsComposerItem* ); - /** Is emitted when item in the composition must be refreshed*/ + //! Is emitted when item in the composition must be refreshed void refreshItemsTriggered(); - /** Is emitted when the composition has an updated status bar message for the composer window*/ + //! Is emitted when the composition has an updated status bar message for the composer window void statusMsgChanged( const QString& message ); /** Emitted whenever the expression variables stored in the composition have been changed. diff --git a/src/core/composer/qgsgroupungroupitemscommand.h b/src/core/composer/qgsgroupungroupitemscommand.h index 28af8d02ac1..847a0313541 100644 --- a/src/core/composer/qgsgroupungroupitemscommand.h +++ b/src/core/composer/qgsgroupungroupitemscommand.h @@ -35,7 +35,7 @@ class CORE_EXPORT QgsGroupUngroupItemsCommand: public QObject, public QUndoComma public: - /** Command kind, and state */ + //! Command kind, and state enum State { Grouped = 0, @@ -58,9 +58,9 @@ class CORE_EXPORT QgsGroupUngroupItemsCommand: public QObject, public QUndoComma void undo() override; signals: - /** Signals addition of an item (the group) */ + //! Signals addition of an item (the group) void itemAdded( QgsComposerItem* item ); - /** Signals removal of an item (the group) */ + //! Signals removal of an item (the group) void itemRemoved( QgsComposerItem* item ); private: diff --git a/src/core/composer/qgsnumericscalebarstyle.h b/src/core/composer/qgsnumericscalebarstyle.h index 20d7327f0b9..b915b86d8e3 100644 --- a/src/core/composer/qgsnumericscalebarstyle.h +++ b/src/core/composer/qgsnumericscalebarstyle.h @@ -37,10 +37,10 @@ class CORE_EXPORT QgsNumericScaleBarStyle: public QgsScaleBarStyle private: QgsNumericScaleBarStyle(); //forbidden - /** Returns the text for the scale bar or an empty string in case of error*/ + //! Returns the text for the scale bar or an empty string in case of error QString scaleText() const; - /** Store last width (in mm) to keep alignment to left/middle/right side*/ + //! Store last width (in mm) to keep alignment to left/middle/right side mutable double mLastScaleBarWidth; }; diff --git a/src/core/composer/qgspaperitem.h b/src/core/composer/qgspaperitem.h index 7d0f8fb1dee..275e53acdb3 100644 --- a/src/core/composer/qgspaperitem.h +++ b/src/core/composer/qgspaperitem.h @@ -30,7 +30,7 @@ class CORE_EXPORT QgsPaperGrid: public QGraphicsRectItem QgsPaperGrid( double x, double y, double width, double height, QgsComposition* composition ); ~QgsPaperGrid(); - /** \brief Reimplementation of QCanvasItem::paint*/ + //! \brief Reimplementation of QCanvasItem::paint void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; private: @@ -48,10 +48,10 @@ class CORE_EXPORT QgsPaperItem : public QgsComposerItem QgsPaperItem( qreal x, qreal y, qreal width, qreal height, QgsComposition* composition ); ~QgsPaperItem(); - /** Return correct graphics item type. */ + //! Return correct graphics item type. virtual int type() const override { return ComposerPaper; } - /** \brief Reimplementation of QCanvasItem::paint*/ + //! \brief Reimplementation of QCanvasItem::paint void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; /** Stores state in Dom element @@ -70,7 +70,7 @@ class CORE_EXPORT QgsPaperItem : public QgsComposerItem private: QgsPaperItem(); - /** Set flags and z-value*/ + //! Set flags and z-value void initialize(); void calculatePageMargin(); diff --git a/src/core/diagram/qgsdiagram.h b/src/core/diagram/qgsdiagram.h index c53394101e0..756fb1ef504 100644 --- a/src/core/diagram/qgsdiagram.h +++ b/src/core/diagram/qgsdiagram.h @@ -49,16 +49,16 @@ class CORE_EXPORT QgsDiagram */ QgsExpression* getExpression( const QString& expression, const QgsExpressionContext& context ); - /** Draws the diagram at the given position (in pixel coordinates)*/ + //! Draws the diagram at the given position (in pixel coordinates) virtual void renderDiagram( const QgsFeature& feature, QgsRenderContext& c, const QgsDiagramSettings& s, QPointF position ) = 0; /** * Get a descriptive name for this diagram type. */ virtual QString diagramName() const = 0; - /** Returns the size in map units the diagram will use to render.*/ + //! Returns the size in map units the diagram will use to render. virtual QSizeF diagramSize( const QgsAttributes& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s ) = 0; - /** Returns the size in map units the diagram will use to render. Interpolate size*/ + //! Returns the size in map units the diagram will use to render. Interpolate size virtual QSizeF diagramSize( const QgsFeature& feature, const QgsRenderContext& c, const QgsDiagramSettings& s, const QgsDiagramInterpolationSettings& is ) = 0; /** Returns the size of the legend item for the diagram corresponding to a specified value. diff --git a/src/core/dxf/qgsdxfexport.h b/src/core/dxf/qgsdxfexport.h index 77004fd3012..4f096621925 100644 --- a/src/core/dxf/qgsdxfexport.h +++ b/src/core/dxf/qgsdxfexport.h @@ -330,9 +330,9 @@ class CORE_EXPORT QgsDxfExport private: QList< QPair > mLayers; - /** Extent for export, only intersecting features are exported. If the extent is an empty rectangle, all features are exported*/ + //! Extent for export, only intersecting features are exported. If the extent is an empty rectangle, all features are exported QgsRectangle mExtent; - /** Scale for symbology export (used if symbols units are mm)*/ + //! Scale for symbology export (used if symbols units are mm) double mSymbologyScaleDenominator; SymbologyExport mSymbologyExport; QgsUnitTypes::DistanceUnit mMapUnits; diff --git a/src/core/dxf/qgsdxfpaintdevice.h b/src/core/dxf/qgsdxfpaintdevice.h index 2b30896d436..08a3790df03 100644 --- a/src/core/dxf/qgsdxfpaintdevice.h +++ b/src/core/dxf/qgsdxfpaintdevice.h @@ -40,10 +40,10 @@ class CORE_EXPORT QgsDxfPaintDevice: public QPaintDevice void setDrawingSize( QSizeF size ) { mDrawingSize = size; } void setOutputSize( const QRectF& r ) { mRectangle = r; } - /** Returns scale factor for line width*/ + //! Returns scale factor for line width double widthScaleFactor() const; - /** Converts a point from device coordinates to dxf coordinates*/ + //! Converts a point from device coordinates to dxf coordinates QPointF dxfCoordinates( QPointF pt ) const; /*int height() const { return mDrawingSize.height(); } diff --git a/src/core/effects/qgsblureffect.h b/src/core/effects/qgsblureffect.h index b05094692eb..b3d68ec206a 100644 --- a/src/core/effects/qgsblureffect.h +++ b/src/core/effects/qgsblureffect.h @@ -34,11 +34,11 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect public: - /** Available blur methods (algorithms) */ + //! Available blur methods (algorithms) enum BlurMethod { - StackBlur, /*!< stack blur, a fast but low quality blur. Valid blur level values are between 0 - 16.*/ - GaussianBlur /*!< Gaussian blur, a slower but high quality blur. Blur level values are the distance in pixels for the blur operation. */ + StackBlur, //!< Stack blur, a fast but low quality blur. Valid blur level values are between 0 - 16. + GaussianBlur //!< Gaussian blur, a slower but high quality blur. Blur level values are the distance in pixels for the blur operation. }; /** Creates a new QgsBlurEffect effect from a properties string map. diff --git a/src/core/effects/qgsgloweffect.h b/src/core/effects/qgsgloweffect.h index 779196d589b..fc238a27bf9 100644 --- a/src/core/effects/qgsgloweffect.h +++ b/src/core/effects/qgsgloweffect.h @@ -36,11 +36,11 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect public: - /** Color sources for the glow */ + //! Color sources for the glow enum GlowColorType { - SingleColor, /*!< use a single color and fade the color to totally transparent */ - ColorRamp /*!< use colors from a color ramp */ + SingleColor, //!< Use a single color and fade the color to totally transparent + ColorRamp //!< Use colors from a color ramp }; QgsGlowEffect(); diff --git a/src/core/effects/qgsimageoperation.h b/src/core/effects/qgsimageoperation.h index 43752a17745..c5d94e6cb2a 100644 --- a/src/core/effects/qgsimageoperation.h +++ b/src/core/effects/qgsimageoperation.h @@ -47,18 +47,18 @@ class CORE_EXPORT QgsImageOperation */ enum GrayscaleMode { - GrayscaleLightness, /*!< keep the lightness of the color, drops the saturation */ - GrayscaleLuminosity, /*!< grayscale by perceptual luminosity (weighted sum of color RGB components) */ - GrayscaleAverage, /*!< grayscale by taking average of color RGB components */ - GrayscaleOff /*!< no change */ + GrayscaleLightness, //!< Keep the lightness of the color, drops the saturation + GrayscaleLuminosity, //!< Grayscale by perceptual luminosity (weighted sum of color RGB components) + GrayscaleAverage, //!< Grayscale by taking average of color RGB components + GrayscaleOff //!< No change }; /** Flip operation types */ enum FlipType { - FlipHorizontal, /*!< flip the image horizontally */ - FlipVertical /*!< flip the image vertically */ + FlipHorizontal, //!< Flip the image horizontally + FlipVertical //!< Flip the image vertically }; /** Convert a QImage to a grayscale image. Alpha channel is preserved. @@ -101,7 +101,7 @@ class CORE_EXPORT QgsImageOperation */ static void overlayColor( QImage &image, const QColor& color ); - /** Struct for storing properties of a distance transform operation*/ + //! Struct for storing properties of a distance transform operation struct DistanceTransformProperties { DistanceTransformProperties() diff --git a/src/core/effects/qgspainteffect.h b/src/core/effects/qgspainteffect.h index 60674195d93..050c0985f6b 100644 --- a/src/core/effects/qgspainteffect.h +++ b/src/core/effects/qgspainteffect.h @@ -58,9 +58,9 @@ class CORE_EXPORT QgsPaintEffect */ enum DrawMode { - Modifier, /*!< the result of the effect is not rendered, but is passed on to following effects in the stack */ - Render, /*!< the result of the effect is rendered on the destination, but does not affect subsequent effects in the stack */ - ModifyAndRender /*!< the result of the effect is both rendered and passed on to subsequent effects in the stack */ + Modifier, //!< The result of the effect is not rendered, but is passed on to following effects in the stack + Render, //!< The result of the effect is rendered on the destination, but does not affect subsequent effects in the stack + ModifyAndRender //!< The result of the effect is both rendered and passed on to subsequent effects in the stack }; QgsPaintEffect(); diff --git a/src/core/geometry/qgsabstractgeometry.h b/src/core/geometry/qgsabstractgeometry.h index 9db4b2f440d..37636a42975 100644 --- a/src/core/geometry/qgsabstractgeometry.h +++ b/src/core/geometry/qgsabstractgeometry.h @@ -45,7 +45,7 @@ class CORE_EXPORT QgsAbstractGeometry { public: - /** Segmentation tolerance as maximum angle or maximum difference between approximation and circle*/ + //! Segmentation tolerance as maximum angle or maximum difference between approximation and circle enum SegmentationToleranceType { MaximumAngle = 0, @@ -296,7 +296,7 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual double area() const { return 0.0; } - /** Returns the centroid of the geometry */ + //! Returns the centroid of the geometry virtual QgsPointV2 centroid() const; /** Returns true if the geometry is empty diff --git a/src/core/geometry/qgscompoundcurve.h b/src/core/geometry/qgscompoundcurve.h index fcc03d4de4d..939c9145cb4 100644 --- a/src/core/geometry/qgscompoundcurve.h +++ b/src/core/geometry/qgscompoundcurve.h @@ -101,7 +101,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve void sumUpArea( double& sum ) const override; - /** Appends first point if not already closed.*/ + //! Appends first point if not already closed. void close(); bool hasCurvedSegments() const override; diff --git a/src/core/geometry/qgscurvepolygon.h b/src/core/geometry/qgscurvepolygon.h index 0dc0f84cc53..79e60eff5c3 100644 --- a/src/core/geometry/qgscurvepolygon.h +++ b/src/core/geometry/qgscurvepolygon.h @@ -76,11 +76,11 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface */ virtual void setExteriorRing( QgsCurve* ring ); - /** Sets all interior rings (takes ownership)*/ + //! Sets all interior rings (takes ownership) void setInteriorRings( const QList& rings ); - /** Adds an interior ring to the geometry (takes ownership)*/ + //! Adds an interior ring to the geometry (takes ownership) virtual void addInteriorRing( QgsCurve* ring ); - /** Removes ring. Exterior ring is 0, first interior ring 1, ...*/ + //! Removes ring. Exterior ring is 0, first interior ring 1, ... bool removeInteriorRing( int nr ); virtual void draw( QPainter& p ) const override; diff --git a/src/core/geometry/qgsgeometry.cpp b/src/core/geometry/qgsgeometry.cpp index 70e70af2102..d15e8b5402a 100644 --- a/src/core/geometry/qgsgeometry.cpp +++ b/src/core/geometry/qgsgeometry.cpp @@ -815,7 +815,7 @@ int QgsGeometry::splitGeometry( const QList& splitLine, QList& reshapeWithLine ) { if ( !d->geometry ) diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h index cce70ca030e..08c946e7dfb 100644 --- a/src/core/geometry/qgsgeometry.h +++ b/src/core/geometry/qgsgeometry.h @@ -45,19 +45,19 @@ class QPainter; class QgsPolygonV2; class QgsLineString; -/** Polyline is represented as a vector of points */ +//! Polyline is represented as a vector of points typedef QVector QgsPolyline; -/** Polygon: first item of the list is outer ring, inner rings (if any) start from second item */ +//! Polygon: first item of the list is outer ring, inner rings (if any) start from second item typedef QVector QgsPolygon; -/** A collection of QgsPoints that share a common collection of attributes */ +//! A collection of QgsPoints that share a common collection of attributes typedef QVector QgsMultiPoint; -/** A collection of QgsPolylines that share a common collection of attributes */ +//! A collection of QgsPolylines that share a common collection of attributes typedef QVector QgsMultiPolyline; -/** A collection of QgsPolygons that share a common collection of attributes */ +//! A collection of QgsPolygons that share a common collection of attributes typedef QVector QgsMultiPolygon; class QgsRectangle; @@ -81,7 +81,7 @@ class CORE_EXPORT QgsGeometry //! Constructor QgsGeometry(); - /** Copy constructor will prompt a deep copy of the object */ + //! Copy constructor will prompt a deep copy of the object QgsGeometry( const QgsGeometry & ); /** Assignments will prompt a deep copy of the object @@ -117,23 +117,23 @@ class CORE_EXPORT QgsGeometry */ bool isEmpty() const; - /** Creates a new geometry from a WKT string */ + //! Creates a new geometry from a WKT string static QgsGeometry fromWkt( const QString& wkt ); - /** Creates a new geometry from a QgsPoint object*/ + //! Creates a new geometry from a QgsPoint object static QgsGeometry fromPoint( const QgsPoint& point ); - /** Creates a new geometry from a QgsMultiPoint object */ + //! Creates a new geometry from a QgsMultiPoint object static QgsGeometry fromMultiPoint( const QgsMultiPoint& multipoint ); - /** Creates a new geometry from a QgsPolyline object */ + //! Creates a new geometry from a QgsPolyline object static QgsGeometry fromPolyline( const QgsPolyline& polyline ); - /** Creates a new geometry from a QgsMultiPolyline object*/ + //! Creates a new geometry from a QgsMultiPolyline object static QgsGeometry fromMultiPolyline( const QgsMultiPolyline& multiline ); - /** Creates a new geometry from a QgsPolygon */ + //! Creates a new geometry from a QgsPolygon static QgsGeometry fromPolygon( const QgsPolygon& polygon ); - /** Creates a new geometry from a QgsMultiPolygon */ + //! Creates a new geometry from a QgsMultiPolygon static QgsGeometry fromMultiPolygon( const QgsMultiPolygon& multipoly ); - /** Creates a new geometry from a QgsRectangle */ + //! Creates a new geometry from a QgsRectangle static QgsGeometry fromRect( const QgsRectangle& rect ); - /** Creates a new multipart geometry from a list of QgsGeometry objects*/ + //! Creates a new multipart geometry from a list of QgsGeometry objects static QgsGeometry collectGeometry( const QList< QgsGeometry >& geometries ); /** @@ -179,7 +179,7 @@ class CORE_EXPORT QgsGeometry */ QgsWkbTypes::GeometryType type() const; - /** Returns true if WKB of the geometry is of WKBMulti* type */ + //! Returns true if WKB of the geometry is of WKBMulti* type bool isMultipart() const; /** Compares the geometry with another geometry using GEOS @@ -456,16 +456,16 @@ class CORE_EXPORT QgsGeometry */ QgsGeometry makeDifference( const QgsGeometry& other ) const; - /** Returns the bounding box of this feature*/ + //! Returns the bounding box of this feature QgsRectangle boundingBox() const; - /** Test for intersection with a rectangle (uses GEOS) */ + //! Test for intersection with a rectangle (uses GEOS) bool intersects( const QgsRectangle& r ) const; - /** Test for intersection with a geometry (uses GEOS) */ + //! Test for intersection with a geometry (uses GEOS) bool intersects( const QgsGeometry& geometry ) const; - /** Test for containment of a point (uses GEOS) */ + //! Test for containment of a point (uses GEOS) bool contains( const QgsPoint* p ) const; /** Test for if geometry is contained in another (uses GEOS) @@ -558,7 +558,7 @@ class CORE_EXPORT QgsGeometry JoinStyle joinStyle = JoinStyleRound, double mitreLimit = 2.0 ) const; - /** Returns a simplified version of this geometry using a specified tolerance value */ + //! Returns a simplified version of this geometry using a specified tolerance value QgsGeometry simplify( double tolerance ) const; /** Returns the center of mass of a geometry @@ -567,10 +567,10 @@ class CORE_EXPORT QgsGeometry */ QgsGeometry centroid() const; - /** Returns a point within a geometry */ + //! Returns a point within a geometry QgsGeometry pointOnSurface() const; - /** Returns the smallest convex polygon that contains all the points in the geometry. */ + //! Returns the smallest convex polygon that contains all the points in the geometry. QgsGeometry convexHull() const; /** @@ -602,7 +602,7 @@ class CORE_EXPORT QgsGeometry */ double interpolateAngle( double distance ) const; - /** Returns a geometry representing the points shared by this geometry and other. */ + //! Returns a geometry representing the points shared by this geometry and other. QgsGeometry intersection( const QgsGeometry& geometry ) const; /** Returns a geometry representing all the points in this geometry and other (a @@ -620,13 +620,13 @@ class CORE_EXPORT QgsGeometry */ QgsGeometry mergeLines() const; - /** Returns a geometry representing the points making up this geometry that do not make up other. */ + //! Returns a geometry representing the points making up this geometry that do not make up other. QgsGeometry difference( const QgsGeometry& geometry ) const; - /** Returns a geometry representing the points making up this geometry that do not make up other. */ + //! Returns a geometry representing the points making up this geometry that do not make up other. QgsGeometry symDifference( const QgsGeometry& geometry ) const; - /** Returns an extruded version of this geometry. */ + //! Returns an extruded version of this geometry. QgsGeometry extrude( double x, double y ); /** Exports the geometry to WKT @@ -934,11 +934,11 @@ class CORE_EXPORT QgsGeometry static void convertToPolyline( const QgsPointSequence &input, QgsPolyline& output ); static void convertPolygon( const QgsPolygonV2& input, QgsPolygon& output ); - /** Try to convert the geometry to a point */ + //! Try to convert the geometry to a point QgsGeometry convertToPoint( bool destMultipart ) const; - /** Try to convert the geometry to a line */ + //! Try to convert the geometry to a line QgsGeometry convertToLine( bool destMultipart ) const; - /** Try to convert the geometry to a polygon */ + //! Try to convert the geometry to a polygon QgsGeometry convertToPolygon( bool destMultipart ) const; /** Smooths a polyline using the Chaikin algorithm @@ -972,9 +972,9 @@ class CORE_EXPORT QgsGeometry Q_DECLARE_METATYPE( QgsGeometry ) -/** Writes the geometry to stream out. QGIS version compatibility is not guaranteed. */ +//! Writes the geometry to stream out. QGIS version compatibility is not guaranteed. CORE_EXPORT QDataStream& operator<<( QDataStream& out, const QgsGeometry& geometry ); -/** Reads a geometry from stream in into geometry. QGIS version compatibility is not guaranteed. */ +//! Reads a geometry from stream in into geometry. QGIS version compatibility is not guaranteed. CORE_EXPORT QDataStream& operator>>( QDataStream& in, QgsGeometry& geometry ); #endif diff --git a/src/core/geometry/qgsgeometrycollection.h b/src/core/geometry/qgsgeometrycollection.h index d644b967de7..34a79a748e5 100644 --- a/src/core/geometry/qgsgeometrycollection.h +++ b/src/core/geometry/qgsgeometrycollection.h @@ -56,7 +56,7 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry virtual void clear() override; virtual QgsAbstractGeometry* boundary() const override; - /** Adds a geometry and takes ownership. Returns true in case of success.*/ + //! Adds a geometry and takes ownership. Returns true in case of success. virtual bool addGeometry( QgsAbstractGeometry* g ); /** Inserts a geometry before a specified index and takes ownership. Returns true in case of success. diff --git a/src/core/geometry/qgsgeometryfactory.h b/src/core/geometry/qgsgeometryfactory.h index 22ff4313d0e..da020f44d21 100644 --- a/src/core/geometry/qgsgeometryfactory.h +++ b/src/core/geometry/qgsgeometryfactory.h @@ -51,21 +51,21 @@ class CORE_EXPORT QgsGeometryFactory */ static QgsAbstractGeometry* geomFromWkt( const QString& text ); - /** Construct geometry from a point */ + //! Construct geometry from a point static QgsAbstractGeometry* fromPoint( const QgsPoint& point ); - /** Construct geometry from a multipoint */ + //! Construct geometry from a multipoint static QgsAbstractGeometry* fromMultiPoint( const QgsMultiPoint& multipoint ); - /** Construct geometry from a polyline */ + //! Construct geometry from a polyline static QgsAbstractGeometry* fromPolyline( const QgsPolyline& polyline ); - /** Construct geometry from a multipolyline*/ + //! Construct geometry from a multipolyline static QgsAbstractGeometry* fromMultiPolyline( const QgsMultiPolyline& multiline ); - /** Construct geometry from a polygon */ + //! Construct geometry from a polygon static QgsAbstractGeometry* fromPolygon( const QgsPolygon& polygon ); - /** Construct geometry from a multipolygon */ + //! Construct geometry from a multipolygon static QgsAbstractGeometry* fromMultiPolygon( const QgsMultiPolygon& multipoly ); - /** Construct geometry from a rectangle */ + //! Construct geometry from a rectangle static QgsAbstractGeometry* fromRect( const QgsRectangle& rect ); - /** Return empty geometry from wkb type*/ + //! Return empty geometry from wkb type static QgsAbstractGeometry* geomFromWkbType( QgsWkbTypes::Type t ); private: diff --git a/src/core/geometry/qgsgeometryutils.h b/src/core/geometry/qgsgeometryutils.h index 412b790add0..1f59e2f1ed3 100644 --- a/src/core/geometry/qgsgeometryutils.h +++ b/src/core/geometry/qgsgeometryutils.h @@ -132,24 +132,24 @@ class CORE_EXPORT QgsGeometryUtils */ static QList getSelfIntersections( const QgsAbstractGeometry* geom, int part, int ring, double tolerance ); - /** Returns < 0 if point(x/y) is left of the line x1,y1 -> x2,y2*/ + //! Returns < 0 if point(x/y) is left of the line x1,y1 -> x2,y2 static double leftOfLine( double x, double y, double x1, double y1, double x2, double y2 ); /** Returns a point a specified distance toward a second point. */ static QgsPointV2 pointOnLineWithDistance( const QgsPointV2& startPoint, const QgsPointV2& directionPoint, double distance ); - /** Returns the counter clockwise angle between a line with components dx, dy and the line with dx > 0 and dy = 0*/ + //! Returns the counter clockwise angle between a line with components dx, dy and the line with dx > 0 and dy = 0 static double ccwAngle( double dy, double dx ); - /** Returns radius and center of the circle through pt1, pt2, pt3*/ + //! Returns radius and center of the circle through pt1, pt2, pt3 static void circleCenterRadius( const QgsPointV2& pt1, const QgsPointV2& pt2, const QgsPointV2& pt3, double& radius, double& centerX, double& centerY ); - /** Returns true if circle is ordered clockwise*/ + //! Returns true if circle is ordered clockwise static bool circleClockwise( double angle1, double angle2, double angle3 ); - /** Returns true if, in a circle, angle is between angle1 and angle2*/ + //! Returns true if, in a circle, angle is between angle1 and angle2 static bool circleAngleBetween( double angle, double angle1, double angle2, bool clockwise ); /** Returns true if an angle is between angle1 and angle3 on a circle described by @@ -157,30 +157,30 @@ class CORE_EXPORT QgsGeometryUtils */ static bool angleOnCircle( double angle, double angle1, double angle2, double angle3 ); - /** Length of a circular string segment defined by pt1, pt2, pt3*/ + //! Length of a circular string segment defined by pt1, pt2, pt3 static double circleLength( double x1, double y1, double x2, double y2, double x3, double y3 ); - /** Calculates angle of a circular string part defined by pt1, pt2, pt3*/ + //! Calculates angle of a circular string part defined by pt1, pt2, pt3 static double sweepAngle( double centerX, double centerY, double x1, double y1, double x2, double y2, double x3, double y3 ); - /** Calculates midpoint on circle passing through p1 and p2, closest to given coordinate*/ + //! Calculates midpoint on circle passing through p1 and p2, closest to given coordinate static bool segmentMidPoint( const QgsPointV2& p1, const QgsPointV2& p2, QgsPointV2& result, double radius, const QgsPointV2& mousePos ); - /** Calculates the direction angle of a circle tangent (clockwise from north in radians)*/ + //! Calculates the direction angle of a circle tangent (clockwise from north in radians) static double circleTangentDirection( const QgsPointV2& tangentPoint, const QgsPointV2& cp1, const QgsPointV2& cp2, const QgsPointV2& cp3 ); /** Returns a list of points contained in a WKT string. */ static QgsPointSequence pointsFromWKT( const QString& wktCoordinateList, bool is3D, bool isMeasure ); - /** Returns a LinearRing { uint32 numPoints; Point points[numPoints]; } */ + //! Returns a LinearRing { uint32 numPoints; Point points[numPoints]; } static void pointsToWKB( QgsWkbPtr &wkb, const QgsPointSequence &points, bool is3D, bool isMeasure ); - /** Returns a WKT coordinate list */ + //! Returns a WKT coordinate list static QString pointsToWKT( const QgsPointSequence &points, int precision, bool is3D, bool isMeasure ); - /** Returns a gml::coordinates DOM element */ + //! Returns a gml::coordinates DOM element static QDomElement pointsToGML2( const QgsPointSequence &points, QDomDocument &doc, int precision, const QString& ns ); - /** Returns a gml::posList DOM element */ + //! Returns a gml::posList DOM element static QDomElement pointsToGML3( const QgsPointSequence &points, QDomDocument &doc, int precision, const QString& ns, bool is3D ); - /** Returns a geoJSON coordinates string */ + //! Returns a geoJSON coordinates string static QString pointsToJSON( const QgsPointSequence &points, int precision ); /** Ensures that an angle is in the range 0 <= angle < 2 pi. @@ -221,7 +221,7 @@ class CORE_EXPORT QgsGeometryUtils */ static double linePerpendicularAngle( double x1, double y1, double x2, double y2 ); - /** Angle between two linear segments*/ + //! Angle between two linear segments static double averageAngle( double x1, double y1, double x2, double y2, double x3, double y3 ); /** Averages two angles, correctly handling negative angles and ensuring the result is between 0 and 2 pi. diff --git a/src/core/geometry/qgsgeos.cpp b/src/core/geometry/qgsgeos.cpp index 55de0a18424..adb28f565ce 100644 --- a/src/core/geometry/qgsgeos.cpp +++ b/src/core/geometry/qgsgeos.cpp @@ -1942,7 +1942,7 @@ double QgsGeos::lineLocatePoint( const QgsPointV2& point, QString* errorMsg ) co } -/** Extract coordinates of linestring's endpoints. Returns false on error. */ +//! Extract coordinates of linestring's endpoints. Returns false on error. static bool _linestringEndpoints( const GEOSGeometry* linestring, double& x1, double& y1, double& x2, double& y2 ) { const GEOSCoordSequence* coordSeq = GEOSGeom_getCoordSeq_r( geosinit.ctxt, linestring ); @@ -1964,7 +1964,7 @@ static bool _linestringEndpoints( const GEOSGeometry* linestring, double& x1, do } -/** Merge two linestrings if they meet at the given intersection point, return new geometry or null on error. */ +//! Merge two linestrings if they meet at the given intersection point, return new geometry or null on error. static GEOSGeometry* _mergeLinestrings( const GEOSGeometry* line1, const GEOSGeometry* line2, const QgsPoint& interesectionPoint ) { double x1, y1, x2, y2; diff --git a/src/core/geometry/qgsgeos.h b/src/core/geometry/qgsgeos.h index edba090eaf0..d870d8ddffa 100644 --- a/src/core/geometry/qgsgeos.h +++ b/src/core/geometry/qgsgeos.h @@ -38,7 +38,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine QgsGeos( const QgsAbstractGeometry* geometry, double precision = 0 ); ~QgsGeos(); - /** Removes caches*/ + //! Removes caches void geometryChanged() override; void prepareGeometry() override; diff --git a/src/core/geometry/qgslinestring.h b/src/core/geometry/qgslinestring.h index 1485904a33b..e487e41cf56 100644 --- a/src/core/geometry/qgslinestring.h +++ b/src/core/geometry/qgslinestring.h @@ -113,7 +113,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve */ void addVertex( const QgsPointV2& pt ); - /** Closes the line string by appending the first point to the end of the line, if it is not already closed.*/ + //! Closes the line string by appending the first point to the end of the line, if it is not already closed. void close(); /** Returns the geometry converted to the more generic curve type QgsCompoundCurve diff --git a/src/core/geometry/qgsmulticurve.h b/src/core/geometry/qgsmulticurve.h index 853fce2a9aa..dd23fb7c32b 100644 --- a/src/core/geometry/qgsmulticurve.h +++ b/src/core/geometry/qgsmulticurve.h @@ -40,7 +40,7 @@ class CORE_EXPORT QgsMultiCurve: public QgsGeometryCollection QDomElement asGML3( QDomDocument& doc, int precision = 17, const QString& ns = "gml" ) const override; QString asJSON( int precision = 17 ) const override; - /** Adds a geometry and takes ownership. Returns true in case of success*/ + //! Adds a geometry and takes ownership. Returns true in case of success virtual bool addGeometry( QgsAbstractGeometry* g ) override; /** Returns a copy of the multi curve, where each component curve has had its line direction reversed. diff --git a/src/core/geometry/qgsmultilinestring.h b/src/core/geometry/qgsmultilinestring.h index ddbda4d9b82..2d2b894875c 100644 --- a/src/core/geometry/qgsmultilinestring.h +++ b/src/core/geometry/qgsmultilinestring.h @@ -40,7 +40,7 @@ class CORE_EXPORT QgsMultiLineString: public QgsMultiCurve QDomElement asGML3( QDomDocument& doc, int precision = 17, const QString& ns = "gml" ) const override; QString asJSON( int precision = 17 ) const override; - /** Adds a geometry and takes ownership. Returns true in case of success*/ + //! Adds a geometry and takes ownership. Returns true in case of success virtual bool addGeometry( QgsAbstractGeometry* g ) override; /** Returns the geometry converted to the more generic curve type QgsMultiCurve diff --git a/src/core/geometry/qgsmultipoint.h b/src/core/geometry/qgsmultipoint.h index c3b793ad763..f6977a3eea4 100644 --- a/src/core/geometry/qgsmultipoint.h +++ b/src/core/geometry/qgsmultipoint.h @@ -41,7 +41,7 @@ class CORE_EXPORT QgsMultiPointV2: public QgsGeometryCollection QString asJSON( int precision = 17 ) const override; - /** Adds a geometry and takes ownership. Returns true in case of success*/ + //! Adds a geometry and takes ownership. Returns true in case of success virtual bool addGeometry( QgsAbstractGeometry* g ) override; virtual QgsAbstractGeometry* boundary() const override; diff --git a/src/core/geometry/qgsmultipolygon.h b/src/core/geometry/qgsmultipolygon.h index faeda2128df..8aae2f52d54 100644 --- a/src/core/geometry/qgsmultipolygon.h +++ b/src/core/geometry/qgsmultipolygon.h @@ -40,7 +40,7 @@ class CORE_EXPORT QgsMultiPolygonV2: public QgsMultiSurface QDomElement asGML3( QDomDocument& doc, int precision = 17, const QString& ns = "gml" ) const override; QString asJSON( int precision = 17 ) const override; - /** Adds a geometry and takes ownership. Returns true in case of success*/ + //! Adds a geometry and takes ownership. Returns true in case of success virtual bool addGeometry( QgsAbstractGeometry* g ) override; /** Returns the geometry converted to the more generic curve type QgsMultiSurface diff --git a/src/core/geometry/qgsmultisurface.h b/src/core/geometry/qgsmultisurface.h index 6a198b70d00..04f982a70a5 100644 --- a/src/core/geometry/qgsmultisurface.h +++ b/src/core/geometry/qgsmultisurface.h @@ -41,7 +41,7 @@ class CORE_EXPORT QgsMultiSurface: public QgsGeometryCollection QString asJSON( int precision = 17 ) const override; - /** Adds a geometry and takes ownership. Returns true in case of success*/ + //! Adds a geometry and takes ownership. Returns true in case of success virtual bool addGeometry( QgsAbstractGeometry* g ) override; virtual QgsAbstractGeometry* boundary() const override; diff --git a/src/core/geometry/qgswkbtypes.h b/src/core/geometry/qgswkbtypes.h index fd2d0df103a..a4d4f89ccaf 100644 --- a/src/core/geometry/qgswkbtypes.h +++ b/src/core/geometry/qgswkbtypes.h @@ -455,7 +455,7 @@ class CORE_EXPORT QgsWkbTypes return Unknown; } - /** Returns the modified input geometry type according to hasZ / hasM */ + //! Returns the modified input geometry type according to hasZ / hasM static Type zmType( Type type, bool hasZ, bool hasM ) { type = flatType( type ); diff --git a/src/core/gps/gmath.c b/src/core/gps/gmath.c index ad24b9f5464..b02640350a8 100644 --- a/src/core/gps/gmath.c +++ b/src/core/gps/gmath.c @@ -24,7 +24,7 @@ * */ -/** \file gmath.h */ +//! \file gmath.h #include "gmath.h" @@ -100,8 +100,8 @@ double nmea_meters2dop( double meters ) * \return Distance in meters */ double nmea_distance( - const nmeaPOS *from_pos, /**< From position in radians */ - const nmeaPOS *to_pos /**< To position in radians */ + const nmeaPOS *from_pos, //!< From position in radians + const nmeaPOS *to_pos //!< To position in radians ) { double dist = (( double )NMEA_EARTHRADIUS_M ) * acos( @@ -119,10 +119,10 @@ double nmea_distance( * \return Distance in meters */ double nmea_distance_ellipsoid( - const nmeaPOS *from_pos, /**< From position in radians */ - const nmeaPOS *to_pos, /**< To position in radians */ - double *from_azimuth, /**< (O) azimuth at "from" position in radians */ - double *to_azimuth /**< (O) azimuth at "to" position in radians */ + const nmeaPOS *from_pos, //!< From position in radians + const nmeaPOS *to_pos, //!< To position in radians + double *from_azimuth, //!< (O) azimuth at "from" position in radians + double *to_azimuth //!< (O) azimuth at "to" position in radians ) { /* All variables */ @@ -233,10 +233,10 @@ double nmea_distance_ellipsoid( * \brief Horizontal move of point position */ int nmea_move_horz( - const nmeaPOS *start_pos, /**< Start position in radians */ - nmeaPOS *end_pos, /**< Result position in radians */ - double azimuth, /**< Azimuth (degree) [0, 359] */ - double distance /**< Distance (km) */ + const nmeaPOS *start_pos, //!< Start position in radians + nmeaPOS *end_pos, //!< Result position in radians + double azimuth, //!< Azimuth (degree) [0, 359] + double distance //!< Distance (km) ) { nmeaPOS p1 = *start_pos; @@ -267,11 +267,11 @@ int nmea_move_horz( * http://www.ngs.noaa.gov/PUBS_LIB/inverse.pdf */ int nmea_move_horz_ellipsoid( - const nmeaPOS *start_pos, /**< Start position in radians */ - nmeaPOS *end_pos, /**< (O) Result position in radians */ - double azimuth, /**< Azimuth in radians */ - double distance, /**< Distance (km) */ - double *end_azimuth /**< (O) Azimuth at end position in radians */ + const nmeaPOS *start_pos, //!< Start position in radians + nmeaPOS *end_pos, //!< (O) Result position in radians + double azimuth, //!< Azimuth in radians + double distance, //!< Distance (km) + double *end_azimuth //!< (O) Azimuth at end position in radians ) { /* Variables */ diff --git a/src/core/gps/gmath.h b/src/core/gps/gmath.h index 2eac197624b..dcf062e40ed 100644 --- a/src/core/gps/gmath.h +++ b/src/core/gps/gmath.h @@ -29,14 +29,14 @@ #include "info.h" -#define NMEA_PI (3.141592653589793) /**< PI value */ -#define NMEA_PI180 (NMEA_PI / 180) /**< PI division by 180 */ -#define NMEA_EARTHRADIUS_KM (6378) /**< Earth's mean radius in km */ -#define NMEA_EARTHRADIUS_M (NMEA_EARTHRADIUS_KM * 1000) /**< Earth's mean radius in m */ -#define NMEA_EARTH_SEMIMAJORAXIS_M (6378137.0) /**< Earth's semi-major axis in m according WGS84 */ -#define NMEA_EARTH_SEMIMAJORAXIS_KM (NMEA_EARTHMAJORAXIS_KM / 1000) /**< Earth's semi-major axis in km according WGS 84 */ -#define NMEA_EARTH_FLATTENING (1 / 298.257223563) /**< Earth's flattening according WGS 84 */ -#define NMEA_DOP_FACTOR (5) /**< Factor for translating DOP to meters */ +#define NMEA_PI (3.141592653589793) //!< PI value +#define NMEA_PI180 (NMEA_PI / 180) //!< PI division by 180 +#define NMEA_EARTHRADIUS_KM (6378) //!< Earth's mean radius in km +#define NMEA_EARTHRADIUS_M (NMEA_EARTHRADIUS_KM * 1000) //!< Earth's mean radius in m +#define NMEA_EARTH_SEMIMAJORAXIS_M (6378137.0) //!< Earth's semi-major axis in m according WGS84 +#define NMEA_EARTH_SEMIMAJORAXIS_KM (NMEA_EARTHMAJORAXIS_KM / 1000) //!< Earth's semi-major axis in km according WGS 84 +#define NMEA_EARTH_FLATTENING (1 / 298.257223563) //!< Earth's flattening according WGS 84 +#define NMEA_DOP_FACTOR (5) //!< Factor for translating DOP to meters #ifdef __cplusplus extern "C" diff --git a/src/core/gps/info.h b/src/core/gps/info.h index 2e4fdfbd83e..c04d4e1b290 100644 --- a/src/core/gps/info.h +++ b/src/core/gps/info.h @@ -24,7 +24,7 @@ * */ -/** \file */ +//! \file #ifndef NMEA_INFO_H #define NMEA_INFO_H @@ -57,8 +57,8 @@ extern "C" */ typedef struct _nmeaPOS { - double lat; /**< Latitude */ - double lon; /**< Longitude */ + double lat; //!< Latitude + double lon; //!< Longitude } nmeaPOS; @@ -69,11 +69,11 @@ extern "C" */ typedef struct _nmeaSATELLITE { - int id; /**< Satellite PRN number */ - int in_use; /**< Used in position fix */ - int elv; /**< Elevation in degrees, 90 maximum */ - int azimuth; /**< Azimuth, degrees from true north, 000 to 359 */ - int sig; /**< Signal, 00-99 dB */ + int id; //!< Satellite PRN number + int in_use; //!< Used in position fix + int elv; //!< Elevation in degrees, 90 maximum + int azimuth; //!< Azimuth, degrees from true north, 000 to 359 + int sig; //!< Signal, 00-99 dB } nmeaSATELLITE; @@ -84,9 +84,9 @@ extern "C" */ typedef struct _nmeaSATINFO { - int inuse; /**< Number of satellites in use (not those in view) */ - int inview; /**< Total number of satellites in view */ - nmeaSATELLITE sat[NMEA_MAXSAT]; /**< Satellites information */ + int inuse; //!< Number of satellites in use (not those in view) + int inview; //!< Total number of satellites in view + nmeaSATELLITE sat[NMEA_MAXSAT]; //!< Satellites information } nmeaSATINFO; @@ -98,25 +98,25 @@ extern "C" */ typedef struct _nmeaINFO { - int smask; /**< Mask specifying types of packages from which data have been obtained */ + int smask; //!< Mask specifying types of packages from which data have been obtained - nmeaTIME utc; /**< UTC of position */ + nmeaTIME utc; //!< UTC of position - int sig; /**< GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive) */ - int fix; /**< Operating mode, used for navigation (1 = Fix not available; 2 = 2D; 3 = 3D) */ + int sig; //!< GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive) + int fix; //!< Operating mode, used for navigation (1 = Fix not available; 2 = 2D; 3 = 3D) - double PDOP; /**< Position Dilution Of Precision */ - double HDOP; /**< Horizontal Dilution Of Precision */ - double VDOP; /**< Vertical Dilution Of Precision */ + double PDOP; //!< Position Dilution Of Precision + double HDOP; //!< Horizontal Dilution Of Precision + double VDOP; //!< Vertical Dilution Of Precision - double lat; /**< Latitude in NDEG - +/-[degree][min].[sec/60] */ - double lon; /**< Longitude in NDEG - +/-[degree][min].[sec/60] */ - double elv; /**< Antenna altitude above/below mean sea level (geoid) in meters */ - double speed; /**< Speed over the ground in kilometers/hour */ - double direction; /**< Track angle in degrees True */ - double declination; /**< Magnetic variation degrees (Easterly var. subtracts from true course) */ + double lat; //!< Latitude in NDEG - +/-[degree][min].[sec/60] + double lon; //!< Longitude in NDEG - +/-[degree][min].[sec/60] + double elv; //!< Antenna altitude above/below mean sea level (geoid) in meters + double speed; //!< Speed over the ground in kilometers/hour + double direction; //!< Track angle in degrees True + double declination; //!< Magnetic variation degrees (Easterly var. subtracts from true course) - nmeaSATINFO satinfo; /**< Satellites information */ + nmeaSATINFO satinfo; //!< Satellites information } nmeaINFO; diff --git a/src/core/gps/nmeatime.h b/src/core/gps/nmeatime.h index 14f0ae5dd57..dbd5207301e 100644 --- a/src/core/gps/nmeatime.h +++ b/src/core/gps/nmeatime.h @@ -24,7 +24,7 @@ * */ -/** \file */ +//! \file #ifndef NMEA_TIME_H #define NMEA_TIME_H @@ -42,13 +42,13 @@ extern "C" */ typedef struct _nmeaTIME { - int year; /**< Years since 1900 */ - int mon; /**< Months since January - [0,11] */ - int day; /**< Day of the month - [1,31] */ - int hour; /**< Hours since midnight - [0,23] */ - int min; /**< Minutes after the hour - [0,59] */ - int sec; /**< Seconds after the minute - [0,59] */ - int msec; /**< Thousandths part of second - [0,999] */ + int year; //!< Years since 1900 + int mon; //!< Months since January - [0,11] + int day; //!< Day of the month - [1,31] + int hour; //!< Hours since midnight - [0,23] + int min; //!< Minutes after the hour - [0,59] + int sec; //!< Seconds after the minute - [0,59] + int msec; //!< Thousandths part of second - [0,999] } nmeaTIME; diff --git a/src/core/gps/qgsgpsconnection.h b/src/core/gps/qgsgpsconnection.h index 625520b6ac4..d333e78eb84 100644 --- a/src/core/gps/qgsgpsconnection.h +++ b/src/core/gps/qgsgpsconnection.h @@ -76,18 +76,18 @@ class CORE_EXPORT QgsGPSConnection : public QObject */ QgsGPSConnection( QIODevice* dev ); virtual ~QgsGPSConnection(); - /** Opens connection to device*/ + //! Opens connection to device bool connect(); - /** Closes connection to device*/ + //! Closes connection to device bool close(); - /** Sets the GPS source. The class takes ownership of the device class*/ + //! Sets the GPS source. The class takes ownership of the device class void setSource( QIODevice* source ); - /** Returns the status. Possible state are not connected, connected, data received*/ + //! Returns the status. Possible state are not connected, connected, data received Status status() const { return mStatus; } - /** Returns the current gps information (lat, lon, etc.)*/ + //! Returns the current gps information (lat, lon, etc.) QgsGPSInformation currentGPSInformation() const { return mLastGPSInformation; } signals: @@ -95,20 +95,20 @@ class CORE_EXPORT QgsGPSConnection : public QObject void nmeaSentenceReceived( const QString& substring ); // added to capture 'raw' data protected: - /** Data source (e.g. serial device, socket, file,...)*/ + //! Data source (e.g. serial device, socket, file,...) QIODevice* mSource; - /** Last state of the gps related variables (e.g. position, time, ...)*/ + //! Last state of the gps related variables (e.g. position, time, ...) QgsGPSInformation mLastGPSInformation; - /** Connection status*/ + //! Connection status Status mStatus; private: - /** Closes and deletes mSource*/ + //! Closes and deletes mSource void cleanupSource(); void clearLastGPSInformation(); protected slots: - /** Parse available data source content*/ + //! Parse available data source content virtual void parseData() = 0; }; diff --git a/src/core/gps/qgsgpsconnectionregistry.h b/src/core/gps/qgsgpsconnectionregistry.h index 6f8384f5842..c9abd7e3369 100644 --- a/src/core/gps/qgsgpsconnectionregistry.h +++ b/src/core/gps/qgsgpsconnectionregistry.h @@ -32,9 +32,9 @@ class CORE_EXPORT QgsGPSConnectionRegistry static QgsGPSConnectionRegistry* instance(); ~QgsGPSConnectionRegistry(); - /** Inserts a connection into the registry. The connection is owned by the registry class until it is unregistered again*/ + //! Inserts a connection into the registry. The connection is owned by the registry class until it is unregistered again void registerConnection( QgsGPSConnection* c ); - /** Unregisters connection. The registry does no longer own the connection*/ + //! Unregisters connection. The registry does no longer own the connection void unregisterConnection( QgsGPSConnection* c ); QList< QgsGPSConnection *> connectionList() const; diff --git a/src/core/gps/qgsnmeaconnection.h b/src/core/gps/qgsnmeaconnection.h index ef8523aa8e6..5fdbef80489 100644 --- a/src/core/gps/qgsnmeaconnection.h +++ b/src/core/gps/qgsnmeaconnection.h @@ -31,13 +31,13 @@ class CORE_EXPORT QgsNMEAConnection: public QgsGPSConnection ~QgsNMEAConnection(); protected slots: - /** Parse available data source content*/ + //! Parse available data source content void parseData() override; protected: - /** Store data from the device before it is processed*/ + //! Store data from the device before it is processed QString mStringBuffer; - /** Splits mStringBuffer into sentences and calls libnmea*/ + //! Splits mStringBuffer into sentences and calls libnmea void processStringBuffer(); //handle the different sentence type void processGGASentence( const char* data, int len ); diff --git a/src/core/gps/qgsqtlocationconnection.h b/src/core/gps/qgsqtlocationconnection.h index 5fb03002c15..13855fbf913 100644 --- a/src/core/gps/qgsqtlocationconnection.h +++ b/src/core/gps/qgsqtlocationconnection.h @@ -47,10 +47,10 @@ class CORE_EXPORT QgsQtLocationConnection: public QgsGPSConnection ~QgsQtLocationConnection(); protected slots: - /** Needed to make QtLocation detected*/ + //! Needed to make QtLocation detected void broadcastConnectionAvailable(); - /** Parse available data source content*/ + //! Parse available data source content void parseData(); /** Called when the position updated. diff --git a/src/core/gps/sentence.h b/src/core/gps/sentence.h index 6471c3352bb..a7e783d5a8d 100644 --- a/src/core/gps/sentence.h +++ b/src/core/gps/sentence.h @@ -8,7 +8,7 @@ * */ -/** \file */ +//! \file #ifndef NMEA_SENTENCE_H #define NMEA_SENTENCE_H @@ -25,12 +25,12 @@ extern "C" */ enum nmeaPACKTYPE { - GPNON = 0x0000, /**< Unknown packet type. */ - GPGGA = 0x0001, /**< GGA - Essential fix data which provide 3D location and accuracy data. */ - GPGSA = 0x0002, /**< GSA - GPS receiver operating mode, SVs used for navigation, and DOP values. */ - GPGSV = 0x0004, /**< GSV - Number of SVs in view, PRN numbers, elevation, azimuth & SNR values. */ - GPRMC = 0x0008, /**< RMC - Recommended Minimum Specific GPS/TRANSIT Data. */ - GPVTG = 0x0010 /**< VTG - Actual track made good and speed over ground. */ + GPNON = 0x0000, //!< Unknown packet type. + GPGGA = 0x0001, //!< GGA - Essential fix data which provide 3D location and accuracy data. + GPGSA = 0x0002, //!< GSA - GPS receiver operating mode, SVs used for navigation, and DOP values. + GPGSV = 0x0004, //!< GSV - Number of SVs in view, PRN numbers, elevation, azimuth & SNR values. + GPRMC = 0x0008, //!< RMC - Recommended Minimum Specific GPS/TRANSIT Data. + GPVTG = 0x0010 //!< VTG - Actual track made good and speed over ground. }; /** @@ -38,20 +38,20 @@ extern "C" */ typedef struct _nmeaGPGGA { - nmeaTIME utc; /**< UTC of position (just time) */ - double lat; /**< Latitude in NDEG - [degree][min].[sec/60] */ - char ns; /**< [N]orth or [S]outh */ - double lon; /**< Longitude in NDEG - [degree][min].[sec/60] */ - char ew; /**< [E]ast or [W]est */ - int sig; /**< GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive) */ - int satinuse; /**< Number of satellites in use (not those in view) */ - double HDOP; /**< Horizontal dilution of precision */ - double elv; /**< Antenna altitude above/below mean sea level (geoid) */ - char elv_units; /**< [M]eters (Antenna height unit) */ - double diff; /**< Geoidal separation (Diff. between WGS-84 earth ellipsoid and mean sea level. '-' = geoid is below WGS-84 ellipsoid) */ - char diff_units; /**< [M]eters (Units of geoidal separation) */ - double dgps_age; /**< Time in seconds since last DGPS update */ - int dgps_sid; /**< DGPS station ID number */ + nmeaTIME utc; //!< UTC of position (just time) + double lat; //!< Latitude in NDEG - [degree][min].[sec/60] + char ns; //!< [N]orth or [S]outh + double lon; //!< Longitude in NDEG - [degree][min].[sec/60] + char ew; //!< [E]ast or [W]est + int sig; //!< GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive) + int satinuse; //!< Number of satellites in use (not those in view) + double HDOP; //!< Horizontal dilution of precision + double elv; //!< Antenna altitude above/below mean sea level (geoid) + char elv_units; //!< [M]eters (Antenna height unit) + double diff; //!< Geoidal separation (Diff. between WGS-84 earth ellipsoid and mean sea level. '-' = geoid is below WGS-84 ellipsoid) + char diff_units; //!< [M]eters (Units of geoidal separation) + double dgps_age; //!< Time in seconds since last DGPS update + int dgps_sid; //!< DGPS station ID number } nmeaGPGGA; @@ -60,12 +60,12 @@ extern "C" */ typedef struct _nmeaGPGSA { - char fix_mode; /**< Mode (M = Manual, forced to operate in 2D or 3D; A = Automatic, 3D/2D) */ - int fix_type; /**< Type, used for navigation (1 = Fix not available; 2 = 2D; 3 = 3D) */ - int sat_prn[NMEA_MAXSAT]; /**< PRNs of satellites used in position fix (null for unused fields) */ - double PDOP; /**< Dilution of precision */ - double HDOP; /**< Horizontal dilution of precision */ - double VDOP; /**< Vertical dilution of precision */ + char fix_mode; //!< Mode (M = Manual, forced to operate in 2D or 3D; A = Automatic, 3D/2D) + int fix_type; //!< Type, used for navigation (1 = Fix not available; 2 = 2D; 3 = 3D) + int sat_prn[NMEA_MAXSAT]; //!< PRNs of satellites used in position fix (null for unused fields) + double PDOP; //!< Dilution of precision + double HDOP; //!< Horizontal dilution of precision + double VDOP; //!< Vertical dilution of precision } nmeaGPGSA; @@ -74,9 +74,9 @@ extern "C" */ typedef struct _nmeaGPGSV { - int pack_count; /**< Total number of messages of this type in this cycle */ - int pack_index; /**< Message number */ - int sat_count; /**< Total number of satellites in view */ + int pack_count; //!< Total number of messages of this type in this cycle + int pack_index; //!< Message number + int sat_count; //!< Total number of satellites in view nmeaSATELLITE sat_data[NMEA_SATINPACK]; } nmeaGPGSV; @@ -86,17 +86,17 @@ extern "C" */ typedef struct _nmeaGPRMC { - nmeaTIME utc; /**< UTC of position */ - char status; /**< Status (A = active or V = void) */ - double lat; /**< Latitude in NDEG - [degree][min].[sec/60] */ - char ns; /**< [N]orth or [S]outh */ - double lon; /**< Longitude in NDEG - [degree][min].[sec/60] */ - char ew; /**< [E]ast or [W]est */ - double speed; /**< Speed over the ground in knots */ - double direction; /**< Track angle in degrees True */ - double declination; /**< Magnetic variation degrees (Easterly var. subtracts from true course) */ - char declin_ew; /**< [E]ast or [W]est */ - char mode; /**< Mode indicator of fix type (A = autonomous, D = differential, E = estimated, N = not valid, S = simulator) */ + nmeaTIME utc; //!< UTC of position + char status; //!< Status (A = active or V = void) + double lat; //!< Latitude in NDEG - [degree][min].[sec/60] + char ns; //!< [N]orth or [S]outh + double lon; //!< Longitude in NDEG - [degree][min].[sec/60] + char ew; //!< [E]ast or [W]est + double speed; //!< Speed over the ground in knots + double direction; //!< Track angle in degrees True + double declination; //!< Magnetic variation degrees (Easterly var. subtracts from true course) + char declin_ew; //!< [E]ast or [W]est + char mode; //!< Mode indicator of fix type (A = autonomous, D = differential, E = estimated, N = not valid, S = simulator) } nmeaGPRMC; @@ -105,14 +105,14 @@ extern "C" */ typedef struct _nmeaGPVTG { - double dir; /**< True track made good (degrees) */ - char dir_t; /**< Fixed text 'T' indicates that track made good is relative to true north */ - double dec; /**< Magnetic track made good */ - char dec_m; /**< Fixed text 'M' */ - double spn; /**< Ground speed, knots */ - char spn_n; /**< Fixed text 'N' indicates that speed over ground is in knots */ - double spk; /**< Ground speed, kilometers per hour */ - char spk_k; /**< Fixed text 'K' indicates that speed over ground is in kilometers/hour */ + double dir; //!< True track made good (degrees) + char dir_t; //!< Fixed text 'T' indicates that track made good is relative to true north + double dec; //!< Magnetic track made good + char dec_m; //!< Fixed text 'M' + double spn; //!< Ground speed, knots + char spn_n; //!< Fixed text 'N' indicates that speed over ground is in knots + double spk; //!< Ground speed, kilometers per hour + char spk_k; //!< Fixed text 'K' indicates that speed over ground is in kilometers/hour } nmeaGPVTG; diff --git a/src/core/gps/time.c b/src/core/gps/time.c index 0b0b1d57466..518e0a6ae4b 100644 --- a/src/core/gps/time.c +++ b/src/core/gps/time.c @@ -24,7 +24,7 @@ * */ -/** \file nmeatime.h */ +//! \file nmeatime.h #include "nmeatime.h" diff --git a/src/core/gps/tok.c b/src/core/gps/tok.c index 8a6d31dd3c8..ed34278ec2a 100644 --- a/src/core/gps/tok.c +++ b/src/core/gps/tok.c @@ -24,7 +24,7 @@ * */ -/** \file tok.h */ +//! \file tok.h #include "tok.h" diff --git a/src/core/gps/units.h b/src/core/gps/units.h index 454465a1437..1f728f2b789 100644 --- a/src/core/gps/units.h +++ b/src/core/gps/units.h @@ -33,14 +33,14 @@ * Distance units */ -#define NMEA_TUD_YARDS (1.0936) /**< Yeards, meter * NMEA_TUD_YARDS = yard */ -#define NMEA_TUD_KNOTS (1.852) /**< Knots, kilometer / NMEA_TUD_KNOTS = knot */ -#define NMEA_TUD_MILES (1.609) /**< Miles, kilometer / NMEA_TUD_MILES = mile */ +#define NMEA_TUD_YARDS (1.0936) //!< Yeards, meter * NMEA_TUD_YARDS = yard +#define NMEA_TUD_KNOTS (1.852) //!< Knots, kilometer / NMEA_TUD_KNOTS = knot +#define NMEA_TUD_MILES (1.609) //!< Miles, kilometer / NMEA_TUD_MILES = mile /* * Speed units */ -#define NMEA_TUS_MS (3.6) /**< Meters per seconds, (k/h) / NMEA_TUS_MS= (m/s) */ +#define NMEA_TUS_MS (3.6) //!< Meters per seconds, (k/h) / NMEA_TUS_MS= (m/s) #endif /* __NMEA_UNITS_H__ */ diff --git a/src/core/layertree/qgslayertreemodel.h b/src/core/layertree/qgslayertreemodel.h index 575e1875a47..fcd4b3847a6 100644 --- a/src/core/layertree/qgslayertreemodel.h +++ b/src/core/layertree/qgslayertreemodel.h @@ -79,7 +79,7 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel ShowLegend = 0x0001, //!< Add legend nodes for layer nodes ShowRasterPreviewIcon = 0x0002, //!< Will use real preview of raster layer as icon (may be slow) ShowLegendAsTree = 0x0004, //!< For legends that support it, will show them in a tree instead of a list (needs also ShowLegend). Added in 2.8 - DeferredLegendInvalidation = 0x0008, //!< defer legend model invalidation + DeferredLegendInvalidation = 0x0008, //!< Defer legend model invalidation UseEmbeddedWidgets = 0x0010, //!< Layer nodes may optionally include extra embedded widgets (if used in QgsLayerTreeView). Added in 2.16 // behavioral flags @@ -259,7 +259,7 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel QVariant legendNodeData( QgsLayerTreeModelLegendNode* node, int role ) const; Qt::ItemFlags legendNodeFlags( QgsLayerTreeModelLegendNode* node ) const; bool legendEmbeddedInParent( QgsLayerTreeLayer* nodeLayer ) const; - /** Return legend node that may be embbeded in parent (i.e. its icon will be used for layer's icon). */ + //! Return legend node that may be embbeded in parent (i.e. its icon will be used for layer's icon). QgsLayerTreeModelLegendNode* legendNodeEmbeddedInParent( QgsLayerTreeLayer* nodeLayer ) const; QIcon legendIconEmbeddedInParent( QgsLayerTreeLayer* nodeLayer ) const; void legendCleanup(); diff --git a/src/core/layertree/qgslayertreemodellegendnode.h b/src/core/layertree/qgslayertreemodellegendnode.h index 138574f8ec3..69c863fd032 100644 --- a/src/core/layertree/qgslayertreemodellegendnode.h +++ b/src/core/layertree/qgslayertreemodellegendnode.h @@ -48,24 +48,24 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject enum LegendNodeRoles { - RuleKeyRole = Qt::UserRole, //!< rule key of the node (QString) - SymbolLegacyRuleKeyRole, //!< for QgsSymbolLegendNode only - legacy rule key (void ptr, to be cast to QgsSymbol ptr) - ParentRuleKeyRole //!< rule key of the parent legend node - for legends with tree hierarchy (QString). Added in 2.8 + RuleKeyRole = Qt::UserRole, //!< Rule key of the node (QString) + SymbolLegacyRuleKeyRole, //!< For QgsSymbolLegendNode only - legacy rule key (void ptr, to be cast to QgsSymbol ptr) + ParentRuleKeyRole //!< Rule key of the parent legend node - for legends with tree hierarchy (QString). Added in 2.8 }; - /** Return pointer to the parent layer node */ + //! Return pointer to the parent layer node QgsLayerTreeLayer* layerNode() const { return mLayerNode; } - /** Return pointer to model owning this legend node */ + //! Return pointer to model owning this legend node QgsLayerTreeModel* model() const; - /** Return item flags associated with the item. Default implementation returns Qt::ItemIsEnabled. */ + //! Return item flags associated with the item. Default implementation returns Qt::ItemIsEnabled. virtual Qt::ItemFlags flags() const; - /** Return data associated with the item. Must be implemented in derived class. */ + //! Return data associated with the item. Must be implemented in derived class. virtual QVariant data( int role ) const = 0; - /** Set some data associated with the item. Default implementation does nothing and returns false. */ + //! Set some data associated with the item. Default implementation does nothing and returns false. virtual bool setData( const QVariant& value, int role ); virtual bool isEmbeddedInParent() const { return mEmbeddedInParent; } @@ -126,7 +126,7 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject void dataChanged(); protected: - /** Construct the node with pointer to its parent layer node */ + //! Construct the node with pointer to its parent layer node explicit QgsLayerTreeModelLegendNode( QgsLayerTreeLayer* nodeL, QObject* parent = nullptr ); protected: diff --git a/src/core/layertree/qgslayertreenode.h b/src/core/layertree/qgslayertreenode.h index f8bf074a6e2..ac2f848f67c 100644 --- a/src/core/layertree/qgslayertreenode.h +++ b/src/core/layertree/qgslayertreenode.h @@ -70,8 +70,8 @@ class CORE_EXPORT QgsLayerTreeNode : public QObject //! Enumeration of possible tree node types enum NodeType { - NodeGroup, //!< container of other groups and layers - NodeLayer //!< leaf node pointing to a layer + NodeGroup, //!< Container of other groups and layers + NodeLayer //!< Leaf node pointing to a layer }; ~QgsLayerTreeNode(); @@ -99,15 +99,15 @@ class CORE_EXPORT QgsLayerTreeNode : public QObject //! Set whether the node should be shown as expanded or collapsed in GUI void setExpanded( bool expanded ); - /** Set a custom property for the node. Properties are stored in a map and saved in project file. */ + //! Set a custom property for the node. Properties are stored in a map and saved in project file. void setCustomProperty( const QString &key, const QVariant &value ); - /** Read a custom property from layer. Properties are stored in a map and saved in project file. */ + //! Read a custom property from layer. Properties are stored in a map and saved in project file. QVariant customProperty( const QString &key, const QVariant &defaultValue = QVariant() ) const; - /** Remove a custom property from layer. Properties are stored in a map and saved in project file. */ + //! Remove a custom property from layer. Properties are stored in a map and saved in project file. void removeCustomProperty( const QString &key ); - /** Return list of keys stored in custom properties */ + //! Return list of keys stored in custom properties QStringList customProperties() const; - /** Remove a child from a node */ + //! Remove a child from a node bool takeChild( QgsLayerTreeNode *node ); signals: diff --git a/src/core/pal/costcalculator.h b/src/core/pal/costcalculator.h index 9a29b8316e8..834de08a31b 100644 --- a/src/core/pal/costcalculator.h +++ b/src/core/pal/costcalculator.h @@ -32,15 +32,15 @@ namespace pal class CostCalculator { public: - /** Increase candidate's cost according to its collision with passed feature */ + //! Increase candidate's cost according to its collision with passed feature static void addObstacleCostPenalty( LabelPosition* lp, pal::FeaturePart *obstacle ); static void setPolygonCandidatesCost( int nblp, QList< LabelPosition* >& lPos, RTree *obstacles, double bbx[4], double bby[4] ); - /** Set cost to the smallest distance between lPos's centroid and a polygon stored in geoetry field */ + //! Set cost to the smallest distance between lPos's centroid and a polygon stored in geoetry field static void setCandidateCostFromPolygon( LabelPosition* lp, RTree *obstacles, double bbx[4], double bby[4] ); - /** Sort candidates by costs, skip the worse ones, evaluate polygon candidates */ + //! Sort candidates by costs, skip the worse ones, evaluate polygon candidates static int finalizeCandidatesCosts( Feats* feat, int max_p, RTree *obstacles, double bbx[4], double bby[4] ); /** Sorts label candidates in ascending order of cost diff --git a/src/core/pal/feature.h b/src/core/pal/feature.h index 5df362e73a4..36b181f5deb 100644 --- a/src/core/pal/feature.h +++ b/src/core/pal/feature.h @@ -46,7 +46,7 @@ namespace pal { - /** Optional additional info about label (for curved labels) */ + //! Optional additional info about label (for curved labels) class CORE_EXPORT LabelInfo { public: @@ -251,7 +251,7 @@ namespace pal //! Get hole (inner ring) - considered as obstacle FeaturePart* getSelfObstacle( int i ) { return mHoles.at( i ); } - /** Check whether this part is connected with some other part */ + //! Check whether this part is connected with some other part bool isConnected( FeaturePart* p2 ); /** Merge other (connected) part with this one and save the result in this part (other is unchanged). @@ -279,7 +279,7 @@ namespace pal QgsLabelFeature* mLF; QList mHoles; - /** \brief read coordinates from a GEOS geom */ + //! \brief read coordinates from a GEOS geom void extractCoords( const GEOSGeometry* geom ); private: diff --git a/src/core/pal/labelposition.h b/src/core/pal/labelposition.h index 41a820d8289..7a17211f29d 100644 --- a/src/core/pal/labelposition.h +++ b/src/core/pal/labelposition.h @@ -90,7 +90,7 @@ namespace pal double alpha, double cost, FeaturePart *feature, bool isReversed = false, Quadrant quadrant = QuadrantOver ); - /** Copy constructor */ + //! Copy constructor LabelPosition( const LabelPosition& other ); ~LabelPosition() { delete nextPart; } @@ -124,16 +124,16 @@ namespace pal */ bool isInConflict( LabelPosition *ls ); - /** Return bounding box - amin: xmin,ymin - amax: xmax,ymax */ + //! Return bounding box - amin: xmin,ymin - amax: xmax,ymax void getBoundingBox( double amin[2], double amax[2] ) const; - /** Get distance from this label to a point. If point lies inside, returns negative number. */ + //! Get distance from this label to a point. If point lies inside, returns negative number. double getDistanceToPoint( double xp, double yp ) const; - /** Returns true if this label crosses the specified line */ + //! Returns true if this label crosses the specified line bool crossesLine( PointSet* line ) const; - /** Returns true if this label crosses the boundary of the specified polygon */ + //! Returns true if this label crosses the boundary of the specified polygon bool crossesBoundary( PointSet* polygon ) const; /** Returns cost of position intersection with polygon (testing area of intersection and center). @@ -145,7 +145,7 @@ namespace pal */ bool intersectsWithPolygon( PointSet* polygon ) const; - /** Shift the label by specified offset */ + //! Shift the label by specified offset void offsetPosition( double xOffset, double yOffset ); /** \brief return id @@ -195,7 +195,7 @@ namespace pal */ bool conflictsWithObstacle() const { return mHasObstacleConflict; } - /** Make sure the cost is less than 1 */ + //! Make sure the cost is less than 1 void validateCost(); /** @@ -243,7 +243,7 @@ namespace pal FeaturePart *obstacle; } PruneCtx; - /** Check whether the candidate in ctx overlap with obstacle feat */ + //! Check whether the candidate in ctx overlap with obstacle feat static bool pruneCallback( LabelPosition *candidatePosition, void *ctx ); // for counting number of overlaps diff --git a/src/core/pal/layer.h b/src/core/pal/layer.h index b3a7105fa8d..222990d28af 100644 --- a/src/core/pal/layer.h +++ b/src/core/pal/layer.h @@ -82,7 +82,7 @@ namespace pal */ int featureCount() { return mHashtable.size(); } - /** Returns pointer to the associated provider */ + //! Returns pointer to the associated provider QgsAbstractLabelProvider* provider() const { return mProvider; } /** Returns the layer's name. @@ -228,7 +228,7 @@ namespace pal */ bool registerFeature( QgsLabelFeature* label ); - /** Join connected features with the same label text */ + //! Join connected features with the same label text void joinConnectedFeatures(); /** Returns the connected feature ID for a label feature ID, which is unique for all features @@ -237,17 +237,17 @@ namespace pal */ int connectedFeatureId( QgsFeatureId featureId ) const; - /** Chop layer features at the repeat distance **/ + //! Chop layer features at the repeat distance * void chopFeaturesAtRepeatDistance(); protected: QgsAbstractLabelProvider* mProvider; // not owned QString mName; - /** List of feature parts */ + //! List of feature parts QLinkedList mFeatureParts; - /** List of obstacle parts */ + //! List of obstacle parts QList mObstacleParts; Pal *pal; @@ -260,7 +260,7 @@ namespace pal bool mDisplayAll; bool mCentroidInside; - /** Optional flags used for some placement methods */ + //! Optional flags used for some placement methods QgsPalLayerSettings::Placement mArrangement; LineArrangementFlags mArrangementFlags; LabelMode mMode; @@ -297,10 +297,10 @@ namespace pal */ Layer( QgsAbstractLabelProvider* provider, const QString& name, QgsPalLayerSettings::Placement arrangement, double defaultPriority, bool active, bool toLabel, Pal *pal, bool displayAll = false ); - /** Add newly created feature part into r tree and to the list */ + //! Add newly created feature part into r tree and to the list void addFeaturePart( FeaturePart* fpart, const QString &labelText = QString() ); - /** Add newly created obstacle part into r tree and to the list */ + //! Add newly created obstacle part into r tree and to the list void addObstaclePart( FeaturePart* fpart ); }; diff --git a/src/core/pal/pal.h b/src/core/pal/pal.h index efaf8787b02..ec79bfcaeb3 100644 --- a/src/core/pal/pal.h +++ b/src/core/pal/pal.h @@ -44,7 +44,7 @@ class QgsAbstractLabelProvider; namespace pal { - /** Get GEOS context handle to be used in all GEOS library calls with reentrant API */ + //! Get GEOS context handle to be used in all GEOS library calls with reentrant API GEOSContextHandle_t geosContext(); class Layer; @@ -53,17 +53,17 @@ namespace pal class Problem; class PointSet; - /** Search method to use */ + //! Search method to use enum SearchMethod { - CHAIN = 0, /**< is the worst but fastest method */ - POPMUSIC_TABU_CHAIN = 1, /**< is the best but slowest */ - POPMUSIC_TABU = 2, /**< is a little bit better than CHAIN but slower*/ - POPMUSIC_CHAIN = 3, /**< is slower and best than TABU, worse and faster than TABU_CHAIN */ - FALP = 4 /** only initial solution */ + CHAIN = 0, //!< Is the worst but fastest method + POPMUSIC_TABU_CHAIN = 1, //!< Is the best but slowest + POPMUSIC_TABU = 2, //!< Is a little bit better than CHAIN but slower + POPMUSIC_CHAIN = 3, //!< Is slower and best than TABU, worse and faster than TABU_CHAIN + FALP = 4 //! only initial solution }; - /** Enumeration line arrangement flags. Flags can be combined. */ + //! Enumeration line arrangement flags. Flags can be combined. enum LineArrangementFlag { FLAG_ON_LINE = 1, @@ -137,10 +137,10 @@ namespace pal typedef bool ( *FnIsCancelled )( void* ctx ); - /** Register a function that returns whether this job has been cancelled - PAL calls it during the computation */ + //! Register a function that returns whether this job has been cancelled - PAL calls it during the computation void registerCancellationCallback( FnIsCancelled fnCancelled, void* context ); - /** Check whether the job has been cancelled */ + //! Check whether the job has been cancelled inline bool isCancelled() { return fnIsCancelled ? fnIsCancelled( fnIsCancelledContext ) : false; } Problem* extractProblem( double bbox[4] ); @@ -257,9 +257,9 @@ namespace pal */ bool showPartial; - /** Callback that may be called from PAL to check whether the job has not been cancelled in meanwhile */ + //! Callback that may be called from PAL to check whether the job has not been cancelled in meanwhile FnIsCancelled fnIsCancelled; - /** Application-specific context for the cancellation check function */ + //! Application-specific context for the cancellation check function void* fnIsCancelledContext; /** diff --git a/src/core/pal/pointset.h b/src/core/pal/pointset.h index 4d7c8977466..19f1df6e96e 100644 --- a/src/core/pal/pointset.h +++ b/src/core/pal/pointset.h @@ -122,7 +122,7 @@ namespace pal max[1] = ymax; } - /** Returns NULL if this isn't a hole. Otherwise returns pointer to parent pointset. */ + //! Returns NULL if this isn't a hole. Otherwise returns pointer to parent pointset. PointSet* getHoleOf() { return holeOf; } int getNumPoints() const { return nbPoints; } diff --git a/src/core/qgis.h b/src/core/qgis.h index 3024ff86145..d2d45d6c607 100644 --- a/src/core/qgis.h +++ b/src/core/qgis.h @@ -290,21 +290,21 @@ void CORE_EXPORT qgsFree( void *ptr ); extern CORE_EXPORT const QString GEOWKT; extern CORE_EXPORT const QString PROJECT_SCALES; -/** PROJ4 string that represents a geographic coord sys */ +//! PROJ4 string that represents a geographic coord sys extern CORE_EXPORT const QString GEOPROJ4; -/** Magic number for a geographic coord sys in POSTGIS SRID */ +//! Magic number for a geographic coord sys in POSTGIS SRID const long GEOSRID = 4326; -/** Magic number for a geographic coord sys in QGIS srs.db tbl_srs.srs_id */ +//! Magic number for a geographic coord sys in QGIS srs.db tbl_srs.srs_id const long GEOCRS_ID = 3452; -/** Magic number for a geographic coord sys in EpsgCrsId ID format */ +//! Magic number for a geographic coord sys in EpsgCrsId ID format const long GEO_EPSG_CRS_ID = 4326; -/** Geographic coord sys from EPSG authority */ +//! Geographic coord sys from EPSG authority extern CORE_EXPORT const QString GEO_EPSG_CRS_AUTHID; -/** The length of the string "+proj=" */ +//! The length of the string "+proj=" const int PROJ_PREFIX_LEN = 6; -/** The length of the string "+ellps=" */ +//! The length of the string "+ellps=" const int ELLPS_PREFIX_LEN = 7; -/** The length of the string "+lat_1=" */ +//! The length of the string "+lat_1=" const int LAT_PREFIX_LEN = 7; /** Magick number that determines whether a projection crsid is a system (srs.db) * or user (~/.qgis.qgis.db) defined projection. */ @@ -317,11 +317,11 @@ extern CORE_EXPORT const QString GEO_NONE; // Constants for point symbols // -/** Magic number that determines the default point size for point symbols */ +//! Magic number that determines the default point size for point symbols const double DEFAULT_POINT_SIZE = 2.0; const double DEFAULT_LINE_WIDTH = 0.26; -/** Default snapping tolerance for segments */ +//! Default snapping tolerance for segments const double DEFAULT_SEGMENT_EPSILON = 1e-8; typedef QMap QgsStringMap; diff --git a/src/core/qgsapplication.cpp b/src/core/qgsapplication.cpp index 1502c107cc2..0fca3df2926 100644 --- a/src/core/qgsapplication.cpp +++ b/src/core/qgsapplication.cpp @@ -583,13 +583,13 @@ QString QgsApplication::donorsFilePath() return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/DONORS" ); } -/** Returns the path to the sponsors file. */ +//! Returns the path to the sponsors file. QString QgsApplication::translatorsFilePath() { return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/TRANSLATORS" ); } -/** Returns the path to the licence file. */ +//! Returns the path to the licence file. QString QgsApplication::licenceFilePath() { return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/LICENSE" ); diff --git a/src/core/qgsapplication.h b/src/core/qgsapplication.h index cb468852a3f..064060ae45d 100644 --- a/src/core/qgsapplication.h +++ b/src/core/qgsapplication.h @@ -108,10 +108,10 @@ class CORE_EXPORT QgsApplication : public QApplication * @note this function was added in version 2.7 */ static QString developersMapFilePath(); - /** Returns the path to the sponsors file. */ + //! Returns the path to the sponsors file. static QString sponsorsFilePath(); - /** Returns the path to the donors file. */ + //! Returns the path to the donors file. static QString donorsFilePath(); /** @@ -262,7 +262,7 @@ class CORE_EXPORT QgsApplication : public QApplication //! get application icon static QString appIconPath(); - /** Constants for endian-ness */ + //! Constants for endian-ness enum endian_t { XDR = 0, // network, or big-endian, byte order @@ -308,19 +308,19 @@ class CORE_EXPORT QgsApplication : public QApplication */ static void registerOgrDrivers(); - /** Converts absolute path to path relative to target */ + //! Converts absolute path to path relative to target static QString absolutePathToRelativePath( const QString& apath, const QString& targetPath ); - /** Converts path relative to target to an absolute path */ + //! Converts path relative to target to an absolute path static QString relativePathToAbsolutePath( const QString& rpath, const QString& targetPath ); - /** Indicates whether running from build directory (not installed) */ + //! Indicates whether running from build directory (not installed) static bool isRunningFromBuildDir() { return ABISYM( mRunningFromBuildDir ); } #ifdef _MSC_VER static QString cfgIntDir() { return ABISYM( mCfgIntDir ); } #endif - /** Returns path to the source directory. Valid only when running from build directory */ + //! Returns path to the source directory. Valid only when running from build directory static QString buildSourcePath() { return ABISYM( mBuildSourcePath ); } - /** Returns path to the build output directory. Valid only when running from build directory */ + //! Returns path to the build output directory. Valid only when running from build directory static QString buildOutputPath() { return ABISYM( mBuildOutputPath ); } /** Sets the GDAL_SKIP environment variable to include the specified driver @@ -401,15 +401,15 @@ class CORE_EXPORT QgsApplication : public QApplication static QString ABISYM( mConfigPath ); - /** True when running from build directory, i.e. without 'make install' */ + //! True when running from build directory, i.e. without 'make install' static bool ABISYM( mRunningFromBuildDir ); - /** Path to the source directory. valid only when running from build directory. */ + //! Path to the source directory. valid only when running from build directory. static QString ABISYM( mBuildSourcePath ); #ifdef _MSC_VER - /** Configuration internal dir */ + //! Configuration internal dir static QString ABISYM( mCfgIntDir ); #endif - /** Path to the output directory of the build. valid only when running from build directory */ + //! Path to the output directory of the build. valid only when running from build directory static QString ABISYM( mBuildOutputPath ); /** List of gdal drivers to be skipped. Uses GDAL_SKIP to exclude them. * @see skipGdalDriver, restoreGdalDriver */ diff --git a/src/core/qgsbrowsermodel.h b/src/core/qgsbrowsermodel.h index 2a5ff098570..3d4a2eb3d01 100644 --- a/src/core/qgsbrowsermodel.h +++ b/src/core/qgsbrowsermodel.h @@ -58,8 +58,8 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel enum ItemDataRole { - PathRole = Qt::UserRole, /*!< Item path used to access path in the tree, see QgsDataItem::mPath */ - CommentRole = Qt::UserRole + 1, /*!< Item comment */ + PathRole = Qt::UserRole, //!< Item path used to access path in the tree, see QgsDataItem::mPath + CommentRole = Qt::UserRole + 1, //!< Item comment }; // implemented methods from QAbstractItemModel for read-only access @@ -77,14 +77,14 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel by views that can display header information. */ virtual QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override; - /** Provides the number of rows of data exposed by the model. */ + //! Provides the number of rows of data exposed by the model. virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const override; /** Provides the number of columns of data exposed by the model. List models do not provide this function because it is already implemented in QAbstractListModel. */ virtual int columnCount( const QModelIndex &parent = QModelIndex() ) const override; - /** Returns the index of the item in the model specified by the given row, column and parent index. */ + //! Returns the index of the item in the model specified by the given row, column and parent index. virtual QModelIndex index( int row, int column, const QModelIndex & parent = QModelIndex() ) const override; QModelIndex findItem( QgsDataItem *item, QgsDataItem *parent = nullptr ) const; @@ -94,13 +94,13 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel */ virtual QModelIndex parent( const QModelIndex &index ) const override; - /** Returns a list of mime that can describe model indexes */ + //! Returns a list of mime that can describe model indexes virtual QStringList mimeTypes() const override; - /** Returns an object that contains serialized items of data corresponding to the list of indexes specified */ + //! Returns an object that contains serialized items of data corresponding to the list of indexes specified virtual QMimeData * mimeData( const QModelIndexList &indexes ) const override; - /** Handles the data supplied by a drag and drop operation that ended with the given action */ + //! Handles the data supplied by a drag and drop operation that ended with the given action virtual bool dropMimeData( const QMimeData * data, Qt::DropAction action, int row, int column, const QModelIndex & parent ) override; QgsDataItem *dataItem( const QModelIndex &idx ) const; @@ -130,7 +130,7 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel void fetchMore( const QModelIndex & parent ) override; signals: - /** Emitted when item children fetch was finished */ + //! Emitted when item children fetch was finished void stateChanged( const QModelIndex & index, QgsDataItem::State oldState ); public slots: @@ -147,7 +147,7 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel void removeFavourite( const QModelIndex &index ); void updateProjectHome(); - /** Hide the given path in the browser model */ + //! Hide the given path in the browser model void hidePath( QgsDataItem *item ); protected: diff --git a/src/core/qgscolorscheme.h b/src/core/qgscolorscheme.h index b5261c8056e..fedd159cde5 100644 --- a/src/core/qgscolorscheme.h +++ b/src/core/qgscolorscheme.h @@ -46,9 +46,9 @@ class CORE_EXPORT QgsColorScheme */ enum SchemeFlag { - ShowInColorDialog = 0x01, /*!< show scheme in color picker dialog */ - ShowInColorButtonMenu = 0x02, /*!< show scheme in color button drop down menu */ - ShowInAllContexts = ShowInColorDialog | ShowInColorButtonMenu /*!< show scheme in all contexts */ + ShowInColorDialog = 0x01, //!< Show scheme in color picker dialog + ShowInColorButtonMenu = 0x02, //!< Show scheme in color button drop down menu + ShowInAllContexts = ShowInColorDialog | ShowInColorButtonMenu //!< Show scheme in all contexts }; Q_DECLARE_FLAGS( SchemeFlags, SchemeFlag ) diff --git a/src/core/qgscoordinatereferencesystem.h b/src/core/qgscoordinatereferencesystem.h index 330ad0e9e1c..0be1c0217f1 100644 --- a/src/core/qgscoordinatereferencesystem.h +++ b/src/core/qgscoordinatereferencesystem.h @@ -198,7 +198,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem EpsgCrsId //!< EPSG code }; - /** Constructs an invalid CRS object */ + //! Constructs an invalid CRS object QgsCoordinateReferenceSystem(); ~QgsCoordinateReferenceSystem(); @@ -398,7 +398,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ static void setupESRIWktFix(); - /** Returns whether this CRS is correctly initialized and usable */ + //! Returns whether this CRS is correctly initialized and usable bool isValid() const; /** Perform some validation on this CRS. If the CRS doesn't validate the @@ -559,7 +559,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ bool saveAsUserCrs( const QString& name ); - /** Returns auth id of related geographic CRS*/ + //! Returns auth id of related geographic CRS QString geographicCrsAuthId() const; /** Returns a list of recently used projections @@ -637,7 +637,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ void debugPrint(); - /** A string based associative array used for passing records around */ + //! A string based associative array used for passing records around typedef QMap RecordMap; /** Get a record from the srs.db or qgis.db backends, given an sql statment. * @note only handles queries that return a single record. diff --git a/src/core/qgscoordinatetransform.h b/src/core/qgscoordinatetransform.h index 0ebfb86a2c4..f7ef285c721 100644 --- a/src/core/qgscoordinatetransform.h +++ b/src/core/qgscoordinatetransform.h @@ -47,11 +47,11 @@ class CORE_EXPORT QgsCoordinateTransform //! Enum used to indicate the direction (forward or inverse) of the transform enum TransformDirection { - ForwardTransform, /*!< Transform from source to destination CRS. */ - ReverseTransform /*!< Transform from destination to source CRS. */ + ForwardTransform, //!< Transform from source to destination CRS. + ReverseTransform //!< Transform from destination to source CRS. }; - /** Default constructor, creates an invalid QgsCoordinateTransform. */ + //! Default constructor, creates an invalid QgsCoordinateTransform. QgsCoordinateTransform(); /** Constructs a QgsCoordinateTransform using QgsCoordinateReferenceSystem objects. diff --git a/src/core/qgscoordinatetransform_p.h b/src/core/qgscoordinatetransform_p.h index 4c98d1dfbe4..0f25b70726b 100644 --- a/src/core/qgscoordinatetransform_p.h +++ b/src/core/qgscoordinatetransform_p.h @@ -209,7 +209,7 @@ class QgsCoordinateTransformPrivate : public QSharedData return mIsValid; } - /** Removes +nadgrids and +towgs84 from proj4 string*/ + //! Removes +nadgrids and +towgs84 from proj4 string QString stripDatumTransform( const QString& proj4 ) const { QStringList parameterSplit = proj4.split( '+', QString::SkipEmptyParts ); @@ -286,7 +286,7 @@ class QgsCoordinateTransformPrivate : public QSharedData return transformString; } - /** In certain situations, null grid shifts have to be added to src / dst proj string*/ + //! In certain situations, null grid shifts have to be added to src / dst proj string void addNullGridShifts( QString& srcProjString, QString& destProjString ) const { //if one transformation uses ntv2, the other one needs to be null grid shift diff --git a/src/core/qgscrscache.h b/src/core/qgscrscache.h index e12fbb17e92..74059fd715a 100644 --- a/src/core/qgscrscache.h +++ b/src/core/qgscrscache.h @@ -43,7 +43,7 @@ class CORE_EXPORT QgsCoordinateTransformCache */ QgsCoordinateTransform transform( const QString& srcAuthId, const QString& destAuthId, int srcDatumTransform = -1, int destDatumTransform = -1 ); - /** Removes transformations where a changed crs is involved from the cache*/ + //! Removes transformations where a changed crs is involved from the cache void invalidateCrs( const QString& crsAuthId ); private: diff --git a/src/core/qgsdataitem.h b/src/core/qgsdataitem.h index 8e2deba7b62..3898d8d219f 100644 --- a/src/core/qgsdataitem.h +++ b/src/core/qgsdataitem.h @@ -53,16 +53,16 @@ class CORE_EXPORT QgsAnimatedIcon : public QObject void setIconPath( const QString & iconPath ); QIcon icon() const { return mIcon; } - /** Connect listener to frameChanged() signal */ + //! Connect listener to frameChanged() signal void connectFrameChanged( const QObject * receiver, const char * method ); - /** Disconnect listener from frameChanged() signal */ + //! Disconnect listener from frameChanged() signal void disconnectFrameChanged( const QObject * receiver, const char * method ); public slots: void onFrameChanged(); signals: - /** Emitted when icon changed */ + //! Emitted when icon changed void frameChanged(); private: @@ -92,7 +92,7 @@ class CORE_EXPORT QgsDataItem : public QObject Project //! Represents a QGIS project }; - /** Create new data item. */ + //! Create new data item. QgsDataItem( QgsDataItem::Type type, QgsDataItem* parent, const QString& name, const QString& path ); virtual ~QgsDataItem(); @@ -108,7 +108,7 @@ class CORE_EXPORT QgsDataItem : public QObject { NotPopulated, //!< Children not yet created Populating, //!< Creating children in separate thread (populating or refreshing) - Populated //!< children created + Populated //!< Children created }; //! @note added in 2.8 @@ -182,7 +182,7 @@ class CORE_EXPORT QgsDataItem : public QObject NoCapabilities = 0, SetCrs = 1 << 0, //!< Can set CRS on layer or group of layers Fertile = 1 << 1, //!< Can create children. Even items without this capability may have children, but cannot create them, it means that children are created by item ancestors. - Fast = 1 << 2 //!< createChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres...) are considered fast because they are reading data only from QSettings + Fast = 1 << 2 //!< CreateChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres...) are considered fast because they are reading data only from QSettings }; Q_DECLARE_FLAGS( Capabilities, Capability ) @@ -236,7 +236,7 @@ class CORE_EXPORT QgsDataItem : public QObject // deleteLater() items anc clear the vector static void deleteLater( QVector &items ); - /** Move object and all its descendants to thread */ + //! Move object and all its descendants to thread void moveToThread( QThread * targetThread ); protected: @@ -285,7 +285,7 @@ class CORE_EXPORT QgsDataItem : public QObject // @param foreground run createChildren in foreground virtual void populate( bool foreground = false ); - /** Remove children recursively and set as not populated. This is used when refreshing collapsed items. */ + //! Remove children recursively and set as not populated. This is used when refreshing collapsed items. virtual void depopulate(); virtual void refresh(); @@ -331,7 +331,7 @@ class CORE_EXPORT QgsLayerItem : public QgsDataItem TableLayer, Database, Table, - Plugin //!< added in 2.10 + Plugin //!< Added in 2.10 }; QgsLayerItem( QgsDataItem* parent, const QString& name, const QString& path, const QString& uri, LayerType layerType, const QString& providerKey ); @@ -346,13 +346,13 @@ class CORE_EXPORT QgsLayerItem : public QgsDataItem // --- New virtual methods for layer item derived classes --- - /** Returns QgsMapLayer::LayerType */ + //! Returns QgsMapLayer::LayerType QgsMapLayer::LayerType mapLayerType() const; - /** Returns layer uri or empty string if layer cannot be created */ + //! Returns layer uri or empty string if layer cannot be created QString uri() const { return mUri; } - /** Returns provider key */ + //! Returns provider key QString providerKey() const { return mProviderKey; } /** Returns the supported CRS @@ -372,15 +372,15 @@ class CORE_EXPORT QgsLayerItem : public QgsDataItem protected: - /** The provider key */ + //! The provider key QString mProviderKey; - /** The URI */ + //! The URI QString mUri; - /** The layer type */ + //! The layer type LayerType mLayerType; - /** The list of supported CRS */ + //! The list of supported CRS QStringList mSupportedCRS; - /** The list of supported formats */ + //! The list of supported formats QStringList mSupportFormats; public: @@ -391,7 +391,7 @@ class CORE_EXPORT QgsLayerItem : public QgsDataItem static const QIcon &iconRaster(); static const QIcon &iconDefault(); - /** @return the layer name */ + //! @return the layer name virtual QString layerName() const { return name(); } }; @@ -449,7 +449,7 @@ class CORE_EXPORT QgsDirectoryItem : public QgsDataCollectionItem virtual QIcon icon() override; virtual QWidget *paramWidget() override; - /** Check if the given path is hidden from the browser model */ + //! Check if the given path is hidden from the browser model static bool hiddenPath( const QString &path ); public slots: diff --git a/src/core/qgsdataprovider.h b/src/core/qgsdataprovider.h index ba32bba08d3..ea37a5d54cf 100644 --- a/src/core/qgsdataprovider.h +++ b/src/core/qgsdataprovider.h @@ -307,10 +307,10 @@ class CORE_EXPORT QgsDataProvider : public QObject */ virtual void reloadData() {} - /** Time stamp of data source in the moment when data/metadata were loaded by provider */ + //! Time stamp of data source in the moment when data/metadata were loaded by provider virtual QDateTime timestamp() const { return mTimestamp; } - /** Current time stamp of data source */ + //! Current time stamp of data source virtual QDateTime dataTimestamp() const { return QDateTime(); } /** Get current status error. This error describes some principal problem @@ -427,13 +427,13 @@ class CORE_EXPORT QgsDataProvider : public QObject */ QDateTime mTimestamp; - /** \brief Error */ + //! \brief Error QgsError mError; - /** Add error message */ + //! Add error message void appendError( const QgsErrorMessage & theMessage ) { mError.append( theMessage );} - /** Set error message */ + //! Set error message void setError( const QgsError & theError ) { mError = theError;} private: diff --git a/src/core/qgsdbfilterproxymodel.h b/src/core/qgsdbfilterproxymodel.h index 539b1ead51a..73c970e5fea 100644 --- a/src/core/qgsdbfilterproxymodel.h +++ b/src/core/qgsdbfilterproxymodel.h @@ -30,9 +30,9 @@ class CORE_EXPORT QgsDbFilterProxyModel: public QSortFilterProxyModel public: QgsDbFilterProxyModel( QObject* parent = nullptr ); ~QgsDbFilterProxyModel(); - /** Calls QSortFilterProxyModel::setFilterWildcard and triggers update*/ + //! Calls QSortFilterProxyModel::setFilterWildcard and triggers update void _setFilterWildcard( const QString& pattern ); - /** Calls QSortFilterProxyModel::setFilterRegExp and triggers update*/ + //! Calls QSortFilterProxyModel::setFilterRegExp and triggers update void _setFilterRegExp( const QString& pattern ); protected: diff --git a/src/core/qgsdiagramrenderer.h b/src/core/qgsdiagramrenderer.h index b93b67ebcb9..63615c1a0e1 100644 --- a/src/core/qgsdiagramrenderer.h +++ b/src/core/qgsdiagramrenderer.h @@ -390,7 +390,7 @@ class CORE_EXPORT QgsDiagramInterpolationSettings double lowerValue; double upperValue; - /** Index of the classification attribute*/ + //! Index of the classification attribute //TODO QGIS 3.0 - don't store index, store field name int classificationAttribute; @@ -415,12 +415,12 @@ class CORE_EXPORT QgsDiagramRenderer * @note added in 2.4 */ virtual QgsDiagramRenderer* clone() const = 0; - /** Returns size of the diagram for a feature in map units. Returns an invalid QSizeF in case of error*/ + //! Returns size of the diagram for a feature in map units. Returns an invalid QSizeF in case of error virtual QSizeF sizeMapUnits( const QgsFeature& feature, const QgsRenderContext& c ) const; virtual QString rendererName() const = 0; - /** Returns attribute indices needed for diagram rendering*/ + //! Returns attribute indices needed for diagram rendering virtual QList diagramAttributes() const = 0; /** Returns the set of any fields required for diagram rendering @@ -436,7 +436,7 @@ class CORE_EXPORT QgsDiagramRenderer void setDiagram( QgsDiagram* d ); QgsDiagram* diagram() const { return mDiagram; } - /** Returns list with all diagram settings in the renderer*/ + //! Returns list with all diagram settings in the renderer virtual QList diagramSettings() const = 0; virtual void readXml( const QDomElement& elem, const QgsVectorLayer* layer ) = 0; @@ -506,20 +506,20 @@ class CORE_EXPORT QgsDiagramRenderer */ virtual bool diagramSettings( const QgsFeature &feature, const QgsRenderContext& c, QgsDiagramSettings& s ) const = 0; - /** Returns size of the diagram (in painter units) or an invalid size in case of error*/ + //! Returns size of the diagram (in painter units) or an invalid size in case of error virtual QSizeF diagramSize( const QgsFeature& features, const QgsRenderContext& c ) const = 0; - /** Converts size from mm to map units*/ + //! Converts size from mm to map units void convertSizeToMapUnits( QSizeF& size, const QgsRenderContext& context ) const; - /** Returns the paint device dpi (or -1 in case of error*/ + //! Returns the paint device dpi (or -1 in case of error static int dpiPaintDevice( const QPainter* ); //read / write diagram void _readXml( const QDomElement& elem, const QgsVectorLayer* layer ); void _writeXml( QDomElement& rendererElem, QDomDocument& doc, const QgsVectorLayer* layer ) const; - /** Reference to the object that does the real diagram rendering*/ + //! Reference to the object that does the real diagram rendering QgsDiagram* mDiagram; //! Whether to show an attribute legend for the diagrams @@ -576,7 +576,7 @@ class CORE_EXPORT QgsLinearlyInterpolatedDiagramRenderer : public QgsDiagramRend QgsLinearlyInterpolatedDiagramRenderer* clone() const override; - /** Returns list with all diagram settings in the renderer*/ + //! Returns list with all diagram settings in the renderer QList diagramSettings() const override; void setDiagramSettings( const QgsDiagramSettings& s ) { mSettings = s; } diff --git a/src/core/qgseditformconfig.h b/src/core/qgseditformconfig.h index 31a284ec3df..e04f0f7e306 100644 --- a/src/core/qgseditformconfig.h +++ b/src/core/qgseditformconfig.h @@ -35,7 +35,7 @@ class CORE_EXPORT QgsEditFormConfig { public: - /** The different types to layout the attribute editor. */ + //! The different types to layout the attribute editor. enum EditorLayout { GeneratedLayout = 0, //!< Autogenerate a simple tabular layout for the form @@ -125,13 +125,13 @@ class CORE_EXPORT QgsEditFormConfig */ QgsAttributeEditorContainer* invisibleRootContainer(); - /** Get the active layout style for the attribute editor for this layer */ + //! Get the active layout style for the attribute editor for this layer EditorLayout layout() const; - /** Set the active layout style for the attribute editor for this layer */ + //! Set the active layout style for the attribute editor for this layer void setLayout( EditorLayout editorLayout ); - /** Get path to the .ui form. Only meaningful with EditorLayout::UiFileLayout. */ + //! Get path to the .ui form. Only meaningful with EditorLayout::UiFileLayout. QString uiForm() const; /** @@ -351,12 +351,12 @@ class CORE_EXPORT QgsEditFormConfig */ PythonInitCodeSource initCodeSource() const; - /** Set if python code shall be used for edit form initialization and its origin */ + //! Set if python code shall be used for edit form initialization and its origin void setInitCodeSource( PythonInitCodeSource initCodeSource ); - /** Type of feature form pop-up suppression after feature creation (overrides app setting) */ + //! Type of feature form pop-up suppression after feature creation (overrides app setting) FeatureFormSuppress suppress() const; - /** Set type of feature form pop-up suppression after feature creation (overrides app setting) */ + //! Set type of feature form pop-up suppression after feature creation (overrides app setting) void setSuppress( FeatureFormSuppress s ); // Serialization diff --git a/src/core/qgseditformconfig_p.h b/src/core/qgseditformconfig_p.h index 91e05064704..6637af0ae81 100644 --- a/src/core/qgseditformconfig_p.h +++ b/src/core/qgseditformconfig_p.h @@ -59,10 +59,10 @@ class QgsEditFormConfigPrivate : public QSharedData delete mInvisibleRootContainer; } - /** The invisible root container for attribute editors in the drag and drop designer */ + //! The invisible root container for attribute editors in the drag and drop designer QgsAttributeEditorContainer* mInvisibleRootContainer; - /** This flag is set if the root container was configured by the user */ + //! This flag is set if the root container was configured by the user bool mConfiguredRootContainer; QMap< QString, QString> mConstraints; @@ -74,21 +74,21 @@ class QgsEditFormConfigPrivate : public QSharedData QMap mEditorWidgetTypes; QMap mWidgetConfigs; - /** Defines the default layout to use for the attribute editor (Drag and drop, UI File, Generated) */ + //! Defines the default layout to use for the attribute editor (Drag and drop, UI File, Generated) QgsEditFormConfig::EditorLayout mEditorLayout; - /** Init form instance */ + //! Init form instance QString mUiFormPath; - /** Name of the python form init function */ + //! Name of the python form init function QString mInitFunction; - /** Path of the python external file to be loaded */ + //! Path of the python external file to be loaded QString mInitFilePath; - /** Choose the source of the init founction */ + //! Choose the source of the init founction QgsEditFormConfig::PythonInitCodeSource mInitCodeSource; - /** Python init code provided in the dialog */ + //! Python init code provided in the dialog QString mInitCode; - /** Type of feature form suppression after feature creation */ + //! Type of feature form suppression after feature creation QgsEditFormConfig::FeatureFormSuppress mSuppressForm; QgsFields mFields; diff --git a/src/core/qgserror.h b/src/core/qgserror.h index 41ddd93fac7..a0aae0cbd5d 100644 --- a/src/core/qgserror.h +++ b/src/core/qgserror.h @@ -29,7 +29,7 @@ class CORE_EXPORT QgsErrorMessage { public: - /** Format */ + //! Format enum Format { Text, // Plain text @@ -57,18 +57,18 @@ class CORE_EXPORT QgsErrorMessage int line() const { return mLine; } private: - /** Error messages */ + //! Error messages QString mMessage; - /** Short description */ + //! Short description QString mTag; - /** Detailed debug info */ + //! Detailed debug info QString mFile; QString mFunction; int mLine; - /** Message format */ + //! Message format Format mFormat; }; @@ -116,11 +116,11 @@ class CORE_EXPORT QgsError */ QString summary() const; - /** Clear error messages */ + //! Clear error messages void clear() { mMessageList.clear(); } private: - /** List of messages */ + //! List of messages QList mMessageList; }; diff --git a/src/core/qgsexpression.h b/src/core/qgsexpression.h index d81600210ea..97b1c8b3e20 100644 --- a/src/core/qgsexpression.h +++ b/src/core/qgsexpression.h @@ -541,13 +541,13 @@ class CORE_EXPORT QgsExpression virtual ~Function() {} - /** The name of the function. */ + //! The name of the function. QString name() const { return mName; } - /** The number of parameters this function takes. */ + //! The number of parameters this function takes. int params() const { return mParameterList.isEmpty() ? mParams : mParameterList.count(); } - /** The mininum number of parameters this function takes. */ + //! The mininum number of parameters this function takes. int minParams() const { if ( mParameterList.isEmpty() ) @@ -567,7 +567,7 @@ class CORE_EXPORT QgsExpression */ const ParameterList& parameters() const { return mParameterList; } - /** Does this function use a geometry object. */ + //! Does this function use a geometry object. bool usesGeometry() const { return mUsesGeometry; } /** Returns a list of possible aliases for the function. These include @@ -606,7 +606,7 @@ class CORE_EXPORT QgsExpression */ QStringList groups() const { return mGroups; } - /** The help text for the function. */ + //! The help text for the function. const QString helpText() const { return mHelpText.isEmpty() ? QgsExpression::helpText( mName ) : mHelpText; } /** Returns result of evaluating the function. @@ -898,7 +898,7 @@ class CORE_EXPORT QgsExpression public: NodeList() : mHasNamedNodes( false ) {} virtual ~NodeList() { qDeleteAll( mList ); } - /** Takes ownership of the provided node */ + //! Takes ownership of the provided node void append( Node* node ) { mList.append( node ); mNameList.append( QString() ); } /** Adds a named node. Takes ownership of the provided node. @@ -920,7 +920,7 @@ class CORE_EXPORT QgsExpression //! @note added in QGIS 2.16 QStringList names() const { return mNameList; } - /** Creates a deep copy of this list. Ownership is transferred to the caller */ + //! Creates a deep copy of this list. Ownership is transferred to the caller NodeList* clone() const; virtual QString dump() const; @@ -1076,7 +1076,7 @@ class CORE_EXPORT QgsExpression : mValue( value ) {} - /** The value of the literal. */ + //! The value of the literal. inline QVariant value() const { return mValue; } virtual NodeType nodeType() const override { return ntLiteral; } @@ -1102,7 +1102,7 @@ class CORE_EXPORT QgsExpression , mIndex( -1 ) {} - /** The name of the column. */ + //! The name of the column. QString name() const { return mName; } virtual NodeType nodeType() const override { return ntColumnRef; } diff --git a/src/core/qgsexpressioncontext.h b/src/core/qgsexpressioncontext.h index 463bd15dce6..02462ae71bb 100644 --- a/src/core/qgsexpressioncontext.h +++ b/src/core/qgsexpressioncontext.h @@ -100,13 +100,13 @@ class CORE_EXPORT QgsExpressionContextScope , readOnly( readOnly ) {} - /** Variable name */ + //! Variable name QString name; - /** Variable value */ + //! Variable value QVariant value; - /** True if variable should not be editable by users */ + //! True if variable should not be editable by users bool readOnly; }; diff --git a/src/core/qgsfeature.h b/src/core/qgsfeature.h index 3f1239caedd..39305aabce1 100644 --- a/src/core/qgsfeature.h +++ b/src/core/qgsfeature.h @@ -331,9 +331,9 @@ class CORE_EXPORT QgsFeature }; // class QgsFeature -/** Writes the feature to stream out. QGIS version compatibility is not guaranteed. */ +//! Writes the feature to stream out. QGIS version compatibility is not guaranteed. CORE_EXPORT QDataStream& operator<<( QDataStream& out, const QgsFeature& feature ); -/** Reads a feature from stream in into feature. QGIS version compatibility is not guaranteed. */ +//! Reads a feature from stream in into feature. QGIS version compatibility is not guaranteed. CORE_EXPORT QDataStream& operator>>( QDataStream& in, QgsFeature& feature ); // key = feature id, value = changed attributes diff --git a/src/core/qgsfeaturefilterprovider.h b/src/core/qgsfeaturefilterprovider.h index 5de614457db..66743ec8046 100644 --- a/src/core/qgsfeaturefilterprovider.h +++ b/src/core/qgsfeaturefilterprovider.h @@ -37,10 +37,10 @@ class CORE_EXPORT QgsFeatureFilterProvider { public: - /** Constructor */ + //! Constructor QgsFeatureFilterProvider() {} - /** Destructor */ + //! Destructor virtual ~QgsFeatureFilterProvider() {} /** Add additional filters to the feature request to further restrict the features returned by the request. diff --git a/src/core/qgsfeatureiterator.h b/src/core/qgsfeatureiterator.h index 36cc4761e92..2d870a236ec 100644 --- a/src/core/qgsfeatureiterator.h +++ b/src/core/qgsfeatureiterator.h @@ -42,9 +42,9 @@ class CORE_EXPORT QgsAbstractFeatureIterator //! Status of expression compilation for filter expression requests enum CompileStatus { - NoCompilation, /*!< Expression could not be compiled or not attempt was made to compile expression */ - PartiallyCompiled, /*!< Expression was partially compiled, but extra checks need to be applied to features*/ - Compiled, /*!< Expression was fully compiled and delegated to data provider source*/ + NoCompilation, //!< Expression could not be compiled or not attempt was made to compile expression + PartiallyCompiled, //!< Expression was partially compiled, but extra checks need to be applied to features + Compiled, //!< Expression was fully compiled and delegated to data provider source }; //! base class constructor - stores the iteration parameters @@ -111,10 +111,10 @@ class CORE_EXPORT QgsAbstractFeatureIterator */ virtual bool nextFeatureFilterFids( QgsFeature & f ); - /** A copy of the feature request. */ + //! A copy of the feature request. QgsFeatureRequest mRequest; - /** Set to true, as soon as the iterator is closed. */ + //! Set to true, as soon as the iterator is closed. bool mClosed; /** @@ -129,8 +129,8 @@ class CORE_EXPORT QgsAbstractFeatureIterator //! reference counting (to allow seamless copying of QgsFeatureIterator instances) //! TODO QGIS3: make this private int refs; - void ref(); //!< add reference - void deref(); //!< remove reference, delete if refs == 0 + void ref(); //!< Add reference + void deref(); //!< Remove reference, delete if refs == 0 friend class QgsFeatureIterator; //! Number of features already fetched by iterator diff --git a/src/core/qgsfeaturestore.h b/src/core/qgsfeaturestore.h index 73729c3c2de..640716f2557 100644 --- a/src/core/qgsfeaturestore.h +++ b/src/core/qgsfeaturestore.h @@ -35,16 +35,16 @@ class CORE_EXPORT QgsFeatureStore //! Constructor QgsFeatureStore( const QgsFields& fields, const QgsCoordinateReferenceSystem& crs ); - /** Get fields list */ + //! Get fields list QgsFields& fields() { return mFields; } - /** Set fields. Resets feature's fields to pointer to new internal fields. */ + //! Set fields. Resets feature's fields to pointer to new internal fields. void setFields( const QgsFields & fields ); - /** Get crs */ + //! Get crs QgsCoordinateReferenceSystem crs() const { return mCrs; } - /** Set crs */ + //! Set crs void setCrs( const QgsCoordinateReferenceSystem& crs ) { mCrs = crs; } /** Add feature. Feature's fields will be set to pointer to the store fields. @@ -53,13 +53,13 @@ class CORE_EXPORT QgsFeatureStore */ void addFeature( const QgsFeature& feature ); - /** Get features list reference */ + //! Get features list reference QgsFeatureList& features() { return mFeatures; } - /** Set map of optional parameters */ + //! Set map of optional parameters void setParams( const QMap &theParams ) { mParams = theParams; } - /** Get map of optional parameters */ + //! Get map of optional parameters QMap params() const { return mParams; } private: diff --git a/src/core/qgsfield.h b/src/core/qgsfield.h index fb002c5d5d7..1e5ed1d5bc8 100644 --- a/src/core/qgsfield.h +++ b/src/core/qgsfield.h @@ -222,7 +222,7 @@ class CORE_EXPORT QgsField */ void setAlias( const QString& alias ); - /** Formats string for display*/ + //! Formats string for display QString displayString( const QVariant& v ) const; /** @@ -263,9 +263,9 @@ class CORE_EXPORT QgsField Q_DECLARE_METATYPE( QgsField ) -/** Writes the field to stream out. QGIS version compatibility is not guaranteed. */ +//! Writes the field to stream out. QGIS version compatibility is not guaranteed. CORE_EXPORT QDataStream& operator<<( QDataStream& out, const QgsField& field ); -/** Reads a field from stream in into field. QGIS version compatibility is not guaranteed. */ +//! Reads a field from stream in into field. QGIS version compatibility is not guaranteed. CORE_EXPORT QDataStream& operator>>( QDataStream& in, QgsField& field ); diff --git a/src/core/qgsfields.h b/src/core/qgsfields.h index 8fc6891d159..005ff43d6f0 100644 --- a/src/core/qgsfields.h +++ b/src/core/qgsfields.h @@ -39,11 +39,11 @@ class CORE_EXPORT QgsFields enum FieldOrigin { - OriginUnknown, //!< it has not been specified where the field comes from - OriginProvider, //!< field comes from the underlying data provider of the vector layer (originIndex = index in provider's fields) - OriginJoin, //!< field comes from a joined layer (originIndex / 1000 = index of the join, originIndex % 1000 = index within the join) - OriginEdit, //!< field has been temporarily added in editing mode (originIndex = index in the list of added attributes) - OriginExpression //!< field is calculated from an expression + OriginUnknown, //!< It has not been specified where the field comes from + OriginProvider, //!< Field comes from the underlying data provider of the vector layer (originIndex = index in provider's fields) + OriginJoin, //!< Field comes from a joined layer (originIndex / 1000 = index of the join, originIndex % 1000 = index within the join) + OriginEdit, //!< Field has been temporarily added in editing mode (originIndex = index in the list of added attributes) + OriginExpression //!< Field is calculated from an expression }; typedef struct Field @@ -63,9 +63,9 @@ class CORE_EXPORT QgsFields //! @note added in 2.6 bool operator!=( const Field& other ) const { return !( *this == other ); } - QgsField field; //!< field - FieldOrigin origin; //!< origin of the field - int originIndex; //!< index specific to the origin + QgsField field; //!< Field + FieldOrigin origin; //!< Origin of the field + int originIndex; //!< Index specific to the origin } Field; /** Constructor for an empty field container @@ -320,9 +320,9 @@ class CORE_EXPORT QgsFields Q_DECLARE_METATYPE( QgsFields ) -/** Writes the fields to stream out. QGIS version compatibility is not guaranteed. */ +//! Writes the fields to stream out. QGIS version compatibility is not guaranteed. CORE_EXPORT QDataStream& operator<<( QDataStream& out, const QgsFields& fields ); -/** Reads fields from stream in into fields. QGIS version compatibility is not guaranteed. */ +//! Reads fields from stream in into fields. QGIS version compatibility is not guaranteed. CORE_EXPORT QDataStream& operator>>( QDataStream& in, QgsFields& fields ); #endif // QGSFIELDS_H diff --git a/src/core/qgsgeometrycache.h b/src/core/qgsgeometrycache.h index 4e64b3f4db4..edc27461ff2 100644 --- a/src/core/qgsgeometrycache.h +++ b/src/core/qgsgeometrycache.h @@ -40,7 +40,7 @@ class CORE_EXPORT QgsGeometryCache //! get rid of the cached geometry void removeGeometry( QgsFeatureId fid ) { mCachedGeometries.remove( fid ); } - /** Deletes the geometries in mCachedGeometries */ + //! Deletes the geometries in mCachedGeometries void deleteCachedGeometries(); void setCachedGeometriesRect( const QgsRectangle& extent ) { mCachedGeometriesRect = extent; } @@ -48,10 +48,10 @@ class CORE_EXPORT QgsGeometryCache protected: - /** Cache of the committed geometries retrieved *for the current display* */ + //! Cache of the committed geometries retrieved *for the current display* QgsGeometryMap mCachedGeometries; - /** Extent for which there are cached geometries */ + //! Extent for which there are cached geometries QgsRectangle mCachedGeometriesRect; }; diff --git a/src/core/qgsgeometryvalidator.h b/src/core/qgsgeometryvalidator.h index df4940def88..4f6c227df58 100644 --- a/src/core/qgsgeometryvalidator.h +++ b/src/core/qgsgeometryvalidator.h @@ -34,7 +34,7 @@ class CORE_EXPORT QgsGeometryValidator : public QThread void run() override; void stop(); - /** Validate geometry and produce a list of geometry errors */ + //! Validate geometry and produce a list of geometry errors static void validateGeometry( const QgsGeometry *g, QList &errors ); signals: diff --git a/src/core/qgsgml.h b/src/core/qgsgml.h index 1a2f7f2dd22..7e54d11b9f5 100644 --- a/src/core/qgsgml.h +++ b/src/core/qgsgml.h @@ -53,34 +53,34 @@ class CORE_EXPORT QgsGmlStreamingParser class LayerProperties { public: - /** Constructor */ + //! Constructor LayerProperties() {} - /** Layer name */ + //! Layer name QString mName; - /** Geometry attribute name */ + //! Geometry attribute name QString mGeometryAttribute; }; - /** Axis orientation logic. */ + //! Axis orientation logic. typedef enum { - /** Honour EPSG axis order only if srsName is of the form urn:ogc:def:crs:EPSG: **/ + //! Honour EPSG axis order only if srsName is of the form urn:ogc:def:crs:EPSG: * Honour_EPSG_if_urn, - /** Honour EPSG axis order */ + //! Honour EPSG axis order Honour_EPSG, - /** Ignore EPSG axis order */ + //! Ignore EPSG axis order Ignore_EPSG, } AxisOrientationLogic; - /** Constructor */ + //! Constructor QgsGmlStreamingParser( const QString& typeName, const QString& geometryAttribute, const QgsFields & fields, AxisOrientationLogic axisOrientationLogic = Honour_EPSG_if_urn, bool invertAxisOrientation = false ); - /** Constructor for a join layer, or dealing with renamed fields*/ + //! Constructor for a join layer, or dealing with renamed fields QgsGmlStreamingParser( const QList& layerProperties, const QgsFields & fields, const QMap< QString, QPair >& mapFieldNameToSrcLayerNameFieldName, @@ -102,31 +102,31 @@ class CORE_EXPORT QgsGmlStreamingParser by later calls. */ QVector getAndStealReadyFeatures(); - /** Return the EPSG code, or 0 if unknown */ + //! Return the EPSG code, or 0 if unknown int getEPSGCode() const { return mEpsg; } - /** Return the value of the srsName attribute */ + //! Return the value of the srsName attribute const QString& srsName() const { return mSrsName; } - /** Return layer bounding box */ + //! Return layer bounding box const QgsRectangle& layerExtent() const { return mLayerExtent; } - /** Return the geometry type */ + //! Return the geometry type QgsWkbTypes::Type wkbType() const { return mWkbType; } - /** Return WFS 2.0 "numberMatched" attribute, or -1 if invalid/not found */ + //! Return WFS 2.0 "numberMatched" attribute, or -1 if invalid/not found int numberMatched() const { return mNumberMatched; } - /** Return WFS 2.0 "numberReturned" or WFS 1.1 "numberOfFeatures" attribute, or -1 if invalid/not found */ + //! Return WFS 2.0 "numberReturned" or WFS 1.1 "numberOfFeatures" attribute, or -1 if invalid/not found int numberReturned() const { return mNumberReturned; } - /** Return whether the document parser is a OGC exception */ + //! Return whether the document parser is a OGC exception bool isException() const { return mIsException; } - /** Return the exception text. */ + //! Return the exception text. const QString& exceptionText() const { return mExceptionText; } - /** Return whether a "truncatedResponse" element is found */ + //! Return whether a "truncatedResponse" element is found bool isTruncatedResponse() const { return mTruncatedResponse; } private: @@ -157,7 +157,7 @@ class CORE_EXPORT QgsGmlStreamingParser ExceptionText }; - /** XML handler methods*/ + //! XML handler methods void startElement( const XML_Char* el, const XML_Char** attr ); void endElement( const XML_Char* el ); void characters( const XML_Char* chars, int len ); @@ -191,7 +191,7 @@ class CORE_EXPORT QgsGmlStreamingParser @return attribute value or an empty string if no such attribute */ QString readAttribute( const QString& attributeName, const XML_Char** attr ) const; - /** Creates a rectangle from a coordinate string. */ + //! Creates a rectangle from a coordinate string. bool createBBoxFromCoordinateString( QgsRectangle &bb, const QString& coordString ) const; /** Creates a set of points from a coordinate string. @param points list that will contain the created points @@ -221,26 +221,26 @@ class CORE_EXPORT QgsGmlStreamingParser int createMultiPointFromFragments(); int createPolygonFromFragments(); int createMultiPolygonFromFragments(); - /** Adds all the integers contained in mCurrentWKBFragmentSizes*/ + //! Adds all the integers contained in mCurrentWKBFragmentSizes int totalWKBFragmentSize() const; - /** Get safely (if empty) top from mode stack */ + //! Get safely (if empty) top from mode stack ParseMode modeStackTop() { return mParseModeStack.isEmpty() ? none : mParseModeStack.top(); } - /** Safely (if empty) pop from mode stack */ + //! Safely (if empty) pop from mode stack ParseMode modeStackPop() { return mParseModeStack.isEmpty() ? none : mParseModeStack.pop(); } - /** Expat parser */ + //! Expat parser XML_Parser mParser; - /** List of (feature, gml_id) pairs */ + //! List of (feature, gml_id) pairs QVector mFeatureList; - /** Describe the various feature types of a join layer */ + //! Describe the various feature types of a join layer QList mLayerProperties; QMap< QString, LayerProperties > mMapTypeNameToProperties; - /** Typename without namespace prefix */ + //! Typename without namespace prefix QString mTypeName; QByteArray mTypeNameBA; const char* mTypeNamePtr; @@ -249,7 +249,7 @@ class CORE_EXPORT QgsGmlStreamingParser //results are members such that handler routines are able to manipulate them - /** Name of geometry attribute*/ + //! Name of geometry attribute QString mGeometryAttribute; QByteArray mGeometryAttributeBA; const char* mGeometryAttributePtr; @@ -260,19 +260,19 @@ class CORE_EXPORT QgsGmlStreamingParser bool mIsException; QString mExceptionText; bool mTruncatedResponse; - /** Parsing depth */ + //! Parsing depth int mParseDepth; int mFeatureTupleDepth; - QString mCurrentTypename; /** Used to track the current (unprefixed) typename for wfs:Member in join layer */ - /** Keep track about the most important nested elements*/ + QString mCurrentTypename; //! Used to track the current (unprefixed) typename for wfs:Member in join layer + //! Keep track about the most important nested elements QStack mParseModeStack; - /** This contains the character data if an important element has been encountered*/ + //! This contains the character data if an important element has been encountered QString mStringCash; QgsFeature* mCurrentFeature; QVector mCurrentAttributes; //attributes of current feature QString mCurrentFeatureId; int mFeatureCount; - /** The total WKB for a feature*/ + //! The total WKB for a feature QgsWkbPtr mCurrentWKB; QgsRectangle mCurrentExtent; bool mBoundedByNullFound; @@ -283,36 +283,36 @@ class CORE_EXPORT QgsGmlStreamingParser QList< QList > mCurrentWKBFragments; QString mAttributeName; char mEndian; - /** Coordinate separator for coordinate strings. Usually "," */ + //! Coordinate separator for coordinate strings. Usually "," QString mCoordinateSeparator; - /** Tuple separator for coordinate strings. Usually " " */ + //! Tuple separator for coordinate strings. Usually " " QString mTupleSeparator; - /** Number of dimensions in pos or posList */ + //! Number of dimensions in pos or posList int mDimension; - /** Coordinates mode, coordinate or posList */ + //! Coordinates mode, coordinate or posList ParseMode mCoorMode; - /** EPSG of parsed features geometries */ + //! EPSG of parsed features geometries int mEpsg; - /** Literal srsName attribute */ + //! Literal srsName attribute QString mSrsName; - /** Layer bounding box */ + //! Layer bounding box QgsRectangle mLayerExtent; - /** GML namespace URI */ + //! GML namespace URI QString mGMLNameSpaceURI; const char* mGMLNameSpaceURIPtr; - /** Axis orientation logic */ + //! Axis orientation logic AxisOrientationLogic mAxisOrientationLogic; - /** Whether to invert axis orientation. This value is immutable, but combined with what is infered from data and mAxisOrientationLogic, is used to compute mInvertAxisOrientation */ + //! Whether to invert axis orientation. This value is immutable, but combined with what is infered from data and mAxisOrientationLogic, is used to compute mInvertAxisOrientation bool mInvertAxisOrientationRequest; - /** Whether to invert axis orientation: result of mAxisOrientationLogic, mInvertAxisOrientationRequest and what is infered from data and mAxisOrientationLogic */ + //! Whether to invert axis orientation: result of mAxisOrientationLogic, mInvertAxisOrientationRequest and what is infered from data and mAxisOrientationLogic bool mInvertAxisOrientation; - /** WFS 2.0 "numberReturned" or WFS 1.1 "numberOfFeatures" attribute, or -1 if invalid/not found */ + //! WFS 2.0 "numberReturned" or WFS 1.1 "numberOfFeatures" attribute, or -1 if invalid/not found int mNumberReturned; - /** WFS 2.0 "numberMatched" attribute, or -1 if invalid/not found */ + //! WFS 2.0 "numberMatched" attribute, or -1 if invalid/not found int mNumberMatched; - /** XML blob containing geometry */ + //! XML blob containing geometry std::string mGeometryString; - /** Whether we found a unhandled geometry element */ + //! Whether we found a unhandled geometry element bool mFoundUnhandledGeometryElement; }; @@ -356,10 +356,10 @@ class CORE_EXPORT QgsGml : public QObject */ int getFeatures( const QByteArray &data, QgsWkbTypes::Type* wkbType, QgsRectangle* extent = nullptr ); - /** Get parsed features for given type name */ + //! Get parsed features for given type name QMap featuresMap() const { return mFeatures; } - /** Get feature ids map */ + //! Get feature ids map QMap idsMap() const { return mIdMap; } /** Returns features spatial reference system @@ -370,7 +370,7 @@ class CORE_EXPORT QgsGml : public QObject void setFinished(); - /** Takes progress value and total steps and emit signals 'dataReadProgress' and 'totalStepUpdate'*/ + //! Takes progress value and total steps and emit signals 'dataReadProgress' and 'totalStepUpdate' void handleProgressEvent( qint64 progress, qint64 totalSteps ); signals: @@ -392,23 +392,23 @@ class CORE_EXPORT QgsGml : public QObject QgsGmlStreamingParser mParser; - /** Typename without namespace prefix */ + //! Typename without namespace prefix QString mTypeName; - /** True if the request is finished*/ + //! True if the request is finished bool mFinished; - /** The features of the layer, map of feature maps for each feature type*/ + //! The features of the layer, map of feature maps for each feature type //QMap &mFeatures; QMap mFeatures; //QMap > mFeatures; - /** Stores the relation between provider ids and WFS server ids*/ + //! Stores the relation between provider ids and WFS server ids //QMap &mIdMap; QMap mIdMap; //QMap > mIdMap; - /** Bounding box of the layer*/ + //! Bounding box of the layer QgsRectangle mExtent; }; diff --git a/src/core/qgsgmlschema.h b/src/core/qgsgmlschema.h index 345761f3af0..4c893da8e75 100644 --- a/src/core/qgsgmlschema.h +++ b/src/core/qgsgmlschema.h @@ -80,7 +80,7 @@ class CORE_EXPORT QgsGmlSchema : public QObject ~QgsGmlSchema(); - /** Get fields info from XSD */ + //! Get fields info from XSD bool parseXSD( const QByteArray &xml ); /** Guess GML schema from data if XSD does not exist. @@ -90,16 +90,16 @@ class CORE_EXPORT QgsGmlSchema : public QObject * @return true in case of success */ bool guessSchema( const QByteArray &data ); - /** Get list of dot separated paths to feature classes parsed from GML or XSD */ + //! Get list of dot separated paths to feature classes parsed from GML or XSD QStringList typeNames() const; - /** Get fields for type/class name parsed from GML or XSD */ + //! Get fields for type/class name parsed from GML or XSD QList fields( const QString & typeName ); - /** Get list of geometry attributes for type/class name */ + //! Get list of geometry attributes for type/class name QStringList geometryAttributes( const QString & typeName ); - /** Get error if parseXSD() or guessSchema() failed */ + //! Get error if parseXSD() or guessSchema() failed QgsError error() const { return mError; } private: @@ -115,7 +115,7 @@ class CORE_EXPORT QgsGmlSchema : public QObject geometry }; - /** XML handler methods*/ + //! XML handler methods void startElement( const XML_Char* el, const XML_Char** attr ); void endElement( const XML_Char* el ); void characters( const XML_Char* chars, int len ); @@ -140,22 +140,22 @@ class CORE_EXPORT QgsGmlSchema : public QObject @return attribute value or an empty string if no such attribute*/ QString readAttribute( const QString& attributeName, const XML_Char** attr ) const; - /** Returns pointer to main window or 0 if it does not exist*/ + //! Returns pointer to main window or 0 if it does not exist QWidget* findMainWindow() const; - /** Get dom elements by path */ + //! Get dom elements by path QList domElements( const QDomElement &element, const QString & path ); - /** Get dom element by path */ + //! Get dom element by path QDomElement domElement( const QDomElement &element, const QString & path ); - /** Filter list of elements by attribute value */ + //! Filter list of elements by attribute value QList domElements( QList &elements, const QString & attr, const QString & attrVal ); - /** Get dom element by path and attribute value */ + //! Get dom element by path and attribute value QDomElement domElement( const QDomElement &element, const QString & path, const QString & attr, const QString & attrVal ); - /** Strip namespace from element name */ + //! Strip namespace from element name QString stripNS( const QString & name ); /** Find GML base type for complex type of given name @@ -165,39 +165,39 @@ class CORE_EXPORT QgsGmlSchema : public QObject */ QString xsdComplexTypeGmlBaseType( const QDomElement &element, const QString & name ); - /** Get feature class information from complex type recursively */ + //! Get feature class information from complex type recursively bool xsdFeatureClass( const QDomElement &element, const QString & typeName, QgsGmlFeatureClass & featureClass ); - /** Get safely (if empty) top from mode stack */ + //! Get safely (if empty) top from mode stack ParseMode modeStackTop() { return mParseModeStack.isEmpty() ? none : mParseModeStack.top(); } - /** Safely (if empty) pop from mode stack */ + //! Safely (if empty) pop from mode stack ParseMode modeStackPop() { return mParseModeStack.isEmpty() ? none : mParseModeStack.pop(); } - /** Keep track about the most important nested elements*/ + //! Keep track about the most important nested elements //std::stack mParseModeStack; QStack mParseModeStack; - /** This contains the character data if an important element has been encountered*/ + //! This contains the character data if an important element has been encountered QString mStringCash; QgsFeature* mCurrentFeature; QString mCurrentFeatureId; int mFeatureCount; QString mAttributeName; - /** Coordinate separator for coordinate strings. Usually "," */ + //! Coordinate separator for coordinate strings. Usually "," QString mCoordinateSeparator; - /** Tuple separator for coordinate strings. Usually " " */ + //! Tuple separator for coordinate strings. Usually " " QString mTupleSeparator; /* Schema information guessed/parsed from GML in getSchema() */ - /** Depth level, root element is 0 */ + //! Depth level, root element is 0 int mLevel; - /** Skip all levels under this */ + //! Skip all levels under this int mSkipLevel; - /** Path to current level */ + //! Path to current level QStringList mParsePathStack; QString mCurrentFeatureName; diff --git a/src/core/qgslabelingengine.h b/src/core/qgslabelingengine.h index cd3d36e7c1f..5e8bd6fd4c1 100644 --- a/src/core/qgslabelingengine.h +++ b/src/core/qgslabelingengine.h @@ -51,11 +51,11 @@ class CORE_EXPORT QgsAbstractLabelProvider enum Flag { - DrawLabels = 1 << 1, //!< whether the labels should be rendered - DrawAllLabels = 1 << 2, //!< whether all features will be labelled even though overlaps occur - MergeConnectedLines = 1 << 3, //!< whether adjacent lines (with the same label text) should be merged - CentroidMustBeInside = 1 << 4, //!< whether location of centroid must be inside of polygons - LabelPerFeaturePart = 1 << 6, //!< whether to label each part of multi-part features separately + DrawLabels = 1 << 1, //!< Whether the labels should be rendered + DrawAllLabels = 1 << 2, //!< Whether all features will be labelled even though overlaps occur + MergeConnectedLines = 1 << 3, //!< Whether adjacent lines (with the same label text) should be merged + CentroidMustBeInside = 1 << 4, //!< Whether location of centroid must be inside of polygons + LabelPerFeaturePart = 1 << 6, //!< Whether to label each part of multi-part features separately }; Q_DECLARE_FLAGS( Flags, Flag ) diff --git a/src/core/qgslabelsearchtree.h b/src/core/qgslabelsearchtree.h index 2b3f905bb9e..1fb3e6f5319 100644 --- a/src/core/qgslabelsearchtree.h +++ b/src/core/qgslabelsearchtree.h @@ -36,7 +36,7 @@ class CORE_EXPORT QgsLabelSearchTree QgsLabelSearchTree(); ~QgsLabelSearchTree(); - /** Removes and deletes all the entries*/ + //! Removes and deletes all the entries void clear(); /** Returns label position(s) at a given point. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions diff --git a/src/core/qgslayerdefinition.h b/src/core/qgslayerdefinition.h index bdcfae3af54..01b46bb77b7 100644 --- a/src/core/qgslayerdefinition.h +++ b/src/core/qgslayerdefinition.h @@ -31,13 +31,13 @@ class QgsLayerTreeNode; class CORE_EXPORT QgsLayerDefinition { public: - /** Loads the QLR at path into QGIS. New layers are added to rootGroup and the map layer registry*/ + //! Loads the QLR at path into QGIS. New layers are added to rootGroup and the map layer registry static bool loadLayerDefinition( const QString & path, QgsLayerTreeGroup* rootGroup, QString &errorMessage ); - /** Loads the QLR from the XML document. New layers are added to rootGroup and the map layer registry */ + //! Loads the QLR from the XML document. New layers are added to rootGroup and the map layer registry static bool loadLayerDefinition( QDomDocument doc, QgsLayerTreeGroup* rootGroup, QString &errorMessage ); - /** Export the selected layer tree nodes to a QLR file */ + //! Export the selected layer tree nodes to a QLR file static bool exportLayerDefinition( QString path, const QList& selectedTreeNodes, QString &errorMessage ); - /** Export the selected layer tree nodes to a QLR-XML document */ + //! Export the selected layer tree nodes to a QLR-XML document static bool exportLayerDefinition( QDomDocument doc, const QList& selectedTreeNodes, QString &errorMessage, const QString& relativeBasePath = QString::null ); /** @@ -57,16 +57,16 @@ class CORE_EXPORT QgsLayerDefinition */ DependencySorter( const QString& fileName ); - /** Get the layer nodes in an order where they can be loaded incrementally without dependency break */ + //! Get the layer nodes in an order where they can be loaded incrementally without dependency break QVector sortedLayerNodes() const { return mSortedLayerNodes; } - /** Get the layer IDs in an order where they can be loaded incrementally without dependency break */ + //! Get the layer IDs in an order where they can be loaded incrementally without dependency break QStringList sortedLayerIds() const { return mSortedLayerIds; } - /** Whether some cyclic dependency has been detected */ + //! Whether some cyclic dependency has been detected bool hasCycle() const { return mHasCycle; } - /** Whether some dependency is missing */ + //! Whether some dependency is missing bool hasMissingDependency() const { return mHasMissingDependency; } private: diff --git a/src/core/qgslegendrenderer.h b/src/core/qgslegendrenderer.h index c372f0d805c..6c7682facd2 100644 --- a/src/core/qgslegendrenderer.h +++ b/src/core/qgslegendrenderer.h @@ -42,16 +42,16 @@ class QgsSymbol; class CORE_EXPORT QgsLegendRenderer { public: - /** Construct legend renderer. The ownership of legend model does not change */ + //! Construct legend renderer. The ownership of legend model does not change QgsLegendRenderer( QgsLayerTreeModel* legendModel, const QgsLegendSettings& settings ); - /** Run the layout algorithm and determine the size required for legend */ + //! Run the layout algorithm and determine the size required for legend QSizeF minimumSize(); - /** Set the preferred resulting legend size. */ + //! Set the preferred resulting legend size. void setLegendSize( QSizeF s ) { mLegendSize = s; } - /** Find out preferred legend size set by the client. If null, the legend will be drawn with the minimum size */ + //! Find out preferred legend size set by the client. If null, the legend will be drawn with the minimum size QSizeF legendSize() const { return mLegendSize; } /** Draw the legend with given painter. It will occupy the area reported in legendSize(). @@ -109,10 +109,10 @@ class CORE_EXPORT QgsLegendRenderer QSizeF paintAndDetermineSize( QPainter* painter ); - /** Create list of atoms according to current layer splitting mode */ + //! Create list of atoms according to current layer splitting mode QList createAtomList( QgsLayerTreeGroup* parentGroup, bool splitLayer ); - /** Divide atoms to columns and set columns on atoms */ + //! Divide atoms to columns and set columns on atoms void setColumns( QList& atomList ); /** Draws title in the legend using the title font and the specified alignment @@ -129,7 +129,7 @@ class CORE_EXPORT QgsLegendRenderer Nucleon drawSymbolItem( QgsLayerTreeModelLegendNode* symbolItem, QPainter* painter = nullptr, QPointF point = QPointF(), double labelXOffset = 0 ); - /** Draws a layer item */ + //! Draws a layer item QSizeF drawLayerTitle( QgsLayerTreeLayer* nodeLayer, QPainter* painter = nullptr, QPointF point = QPointF() ); /** Draws a group item. diff --git a/src/core/qgslegendsettings.h b/src/core/qgslegendsettings.h index d5ac748a723..b32bdd94a13 100644 --- a/src/core/qgslegendsettings.h +++ b/src/core/qgslegendsettings.h @@ -52,9 +52,9 @@ class CORE_EXPORT QgsLegendSettings */ void setTitleAlignment( Qt::AlignmentFlag alignment ) { mTitleAlignment = alignment; } - /** Returns reference to modifiable style */ + //! Returns reference to modifiable style QgsComposerLegendStyle & rstyle( QgsComposerLegendStyle::Style s ) { return mStyleMap[s]; } - /** Returns style */ + //! Returns style QgsComposerLegendStyle style( QgsComposerLegendStyle::Style s ) const { return mStyleMap.value( s ); } void setStyle( QgsComposerLegendStyle::Style s, const QgsComposerLegendStyle& style ) { mStyleMap[s] = style; } @@ -178,57 +178,57 @@ class CORE_EXPORT QgsLegendSettings */ void drawText( QPainter* p, const QRectF& rect, const QString& text, const QFont& font, Qt::AlignmentFlag halignment = Qt::AlignLeft, Qt::AlignmentFlag valignment = Qt::AlignTop, int flags = Qt::TextWordWrap ) const; - /** Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE */ + //! Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE QFont scaledFontPixelSize( const QFont& font ) const; - /** Calculates font to from point size to pixel size */ + //! Calculates font to from point size to pixel size double pixelFontSize( double pointSize ) const; - /** Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE */ + //! Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE double textWidthMillimeters( const QFont& font, const QString& text ) const; - /** Returns the font height of a character in millimeters */ + //! Returns the font height of a character in millimeters double fontHeightCharacterMM( const QFont& font, QChar c ) const; - /** Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE */ + //! Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE double fontAscentMillimeters( const QFont& font ) const; - /** Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE */ + //! Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE double fontDescentMillimeters( const QFont& font ) const; private: QString mTitle; - /** Title alignment, one of Qt::AlignLeft, Qt::AlignHCenter, Qt::AlignRight) */ + //! Title alignment, one of Qt::AlignLeft, Qt::AlignHCenter, Qt::AlignRight) Qt::AlignmentFlag mTitleAlignment; QString mWrapChar; QColor mFontColor; - /** Space between item box and contents */ + //! Space between item box and contents qreal mBoxSpace; - /** Width and height of symbol icon */ + //! Width and height of symbol icon QSizeF mSymbolSize; - /** Width and height of WMS legendGraphic pixmap */ + //! Width and height of WMS legendGraphic pixmap QSizeF mWmsLegendSize; - /** Spacing between lines when wrapped */ + //! Spacing between lines when wrapped double mLineSpacing; - /** Space between columns */ + //! Space between columns double mColumnSpace; - /** Number of legend columns */ + //! Number of legend columns int mColumnCount; - /** Allow splitting layers into multiple columns */ + //! Allow splitting layers into multiple columns bool mSplitLayer; - /** Use the same width (maximum) for all columns */ + //! Use the same width (maximum) for all columns bool mEqualColumnWidth; bool mRasterSymbolBorder; @@ -237,16 +237,16 @@ class CORE_EXPORT QgsLegendSettings QMap mStyleMap; - /** Conversion ratio between millimeters and map units - for symbols with size given in map units */ + //! Conversion ratio between millimeters and map units - for symbols with size given in map units double mMmPerMapUnit; - /** Whether to use advanced effects like transparency for symbols - may require their rasterization */ + //! Whether to use advanced effects like transparency for symbols - may require their rasterization bool mUseAdvancedEffects; - /** Denominator of map's scale */ + //! Denominator of map's scale double mMapScale; - /** DPI to be used when rendering legend */ + //! DPI to be used when rendering legend int mDpi; }; diff --git a/src/core/qgslogger.h b/src/core/qgslogger.h index 714df4954c3..f319aa7531a 100644 --- a/src/core/qgslogger.h +++ b/src/core/qgslogger.h @@ -62,14 +62,14 @@ class CORE_EXPORT QgsLogger @param line place in file where the message comes from*/ static void debug( const QString& msg, int debuglevel = 1, const char* file = nullptr, const char* function = nullptr, int line = -1 ); - /** Similar to the previous method, but prints a variable int-value pair*/ + //! Similar to the previous method, but prints a variable int-value pair static void debug( const QString& var, int val, int debuglevel = 1, const char* file = nullptr, const char* function = nullptr, int line = -1 ); - /** Similar to the previous method, but prints a variable double-value pair*/ + //! Similar to the previous method, but prints a variable double-value pair // @note not available in python bindings static void debug( const QString& var, double val, int debuglevel = 1, const char* file = nullptr, const char* function = nullptr, int line = -1 ); - /** Prints out a variable/value pair for types with overloaded operator<<*/ + //! Prints out a variable/value pair for types with overloaded operator<< // @note not available in python bindings template static void debug( const QString& var, T val, const char* file = nullptr, const char* function = nullptr, int line = -1, int debuglevel = 1 ) @@ -79,20 +79,20 @@ class CORE_EXPORT QgsLogger debug( var, os.str().c_str(), file, function, line, debuglevel ); } - /** Goes to qWarning*/ + //! Goes to qWarning static void warning( const QString& msg ); - /** Goes to qCritical*/ + //! Goes to qCritical static void critical( const QString& msg ); - /** Goes to qFatal*/ + //! Goes to qFatal static void fatal( const QString& msg ); /** Reads the environment variable QGIS_DEBUG and converts it to int. If QGIS_DEBUG is not set, the function returns 1 if QGISDEBUG is defined and 0 if not*/ static int debugLevel() { init(); return sDebugLevel; } - /** Logs the message passed in to the logfile defined in QGIS_LOG_FILE if any. **/ + //! Logs the message passed in to the logfile defined in QGIS_LOG_FILE if any. * static void logMessageToFile( const QString& theMessage ); /** Reads the environment variable QGIS_LOG_FILE. Returns NULL if the variable is not set, @@ -102,7 +102,7 @@ class CORE_EXPORT QgsLogger private: static void init(); - /** Current debug level */ + //! Current debug level static int sDebugLevel; static int sPrefixLength; static QString sLogFile; diff --git a/src/core/qgsmaplayer.cpp b/src/core/qgsmaplayer.cpp index 7322ba409c8..31fde2814f9 100644 --- a/src/core/qgsmaplayer.cpp +++ b/src/core/qgsmaplayer.cpp @@ -97,7 +97,7 @@ QgsMapLayer::LayerType QgsMapLayer::type() const return mLayerType; } -/** Get this layer's unique ID */ +//! Get this layer's unique ID QString QgsMapLayer::id() const { return mID; @@ -115,7 +115,7 @@ void QgsMapLayer::setName( const QString& name ) emit nameChanged(); } -/** Read property of QString layerName. */ +//! Read property of QString layerName. QString QgsMapLayer::name() const { QgsDebugMsgLevel( "returning name '" + mLayerName + '\'', 4 ); @@ -140,7 +140,7 @@ QgsRectangle QgsMapLayer::extent() const return mExtent; } -/** Write blend mode for layer */ +//! Write blend mode for layer void QgsMapLayer::setBlendMode( QPainter::CompositionMode blendMode ) { mBlendMode = blendMode; @@ -148,7 +148,7 @@ void QgsMapLayer::setBlendMode( QPainter::CompositionMode blendMode ) emit styleChanged(); } -/** Read blend mode for layer */ +//! Read blend mode for layer QPainter::CompositionMode QgsMapLayer::blendMode() const { return mBlendMode; diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h index 5f86f5793c5..9d4ed928d48 100644 --- a/src/core/qgsmaplayer.h +++ b/src/core/qgsmaplayer.h @@ -75,7 +75,7 @@ class CORE_EXPORT QgsMapLayer : public QObject */ QgsMapLayer::LayerType type() const; - /** Returns the layer's unique ID, which is used to access this layer from QgsMapLayerRegistry. */ + //! Returns the layer's unique ID, which is used to access this layer from QgsMapLayerRegistry. QString id() const; /** @@ -282,7 +282,7 @@ class CORE_EXPORT QgsMapLayer : public QObject */ QPainter::CompositionMode blendMode() const; - /** Returns if this layer is read only. */ + //! Returns if this layer is read only. bool readOnly() const { return isReadOnly(); } /** Synchronises with changes in the datasource @@ -294,7 +294,7 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual QgsMapLayerRenderer* createMapRenderer( QgsRenderContext& rendererContext ) = 0; - /** Returns the extent of the layer. */ + //! Returns the extent of the layer. virtual QgsRectangle extent() const; /** Return the status of the layer. An invalid layer is one which has a bad datasource @@ -334,7 +334,7 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual void setSubLayerVisibility( const QString& name, bool visible ); - /** Returns true if the layer can be edited. */ + //! Returns true if the layer can be edited. virtual bool isEditable() const; /** Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it. @@ -414,10 +414,10 @@ class CORE_EXPORT QgsMapLayer : public QObject */ QgsCoordinateReferenceSystem crs() const; - /** Sets layer's spatial reference system */ + //! Sets layer's spatial reference system void setCrs( const QgsCoordinateReferenceSystem& srs, bool emitSignal = true ); - /** A convenience function to (un)capitalise the layer name */ + //! A convenience function to (un)capitalise the layer name static QString capitaliseLayerName( const QString& name ); /** Retrieve the style URI for this layer @@ -570,7 +570,7 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual bool writeStyle( QDomNode& node, QDomDocument& doc, QString& errorMessage ) const; - /** Return pointer to layer's undo stack */ + //! Return pointer to layer's undo stack QUndoStack *undoStack(); /** Return pointer to layer's style undo stack @@ -643,7 +643,7 @@ class CORE_EXPORT QgsMapLayer : public QObject public slots: - /** Event handler for when a coordinate transform fails due to bad vertex error */ + //! Event handler for when a coordinate transform fails due to bad vertex error virtual void invalidTransformInput(); /** Sets the minimum scale denominator at which the layer will be visible. @@ -680,10 +680,10 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void triggerRepaint(); - /** \brief Obtain Metadata for this layer */ + //! \brief Obtain Metadata for this layer virtual QString metadata() const; - /** Time stamp of data source in the moment when data/metadata were loaded by provider */ + //! Time stamp of data source in the moment when data/metadata were loaded by provider virtual QDateTime timestamp() const { return QDateTime() ; } /** Triggers an emission of the styleChanged() signal. @@ -712,7 +712,7 @@ class CORE_EXPORT QgsMapLayer : public QObject signals: - /** Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar) */ + //! Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar) void statusChanged( const QString& status ); /** @@ -722,7 +722,7 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void nameChanged(); - /** Emit a signal that layer's CRS has been reset */ + //! Emit a signal that layer's CRS has been reset void crsChanged(); /** By emitting this signal the layer tells that either appearance or content have been changed @@ -730,13 +730,13 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void repaintRequested(); - /** This is used to send a request that any mapcanvas using this layer update its extents */ + //! This is used to send a request that any mapcanvas using this layer update its extents void recalculateExtents() const; - /** Data of layer changed */ + //! Data of layer changed void dataChanged(); - /** Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() */ + //! Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() void blendModeChanged( QPainter::CompositionMode blendMode ); /** Signal emitted when renderer is changed. @@ -770,10 +770,10 @@ class CORE_EXPORT QgsMapLayer : public QObject void dependenciesChanged(); protected: - /** Set the extent */ + //! Set the extent virtual void setExtent( const QgsRectangle &rect ); - /** Set whether layer is valid or not - should be used in constructor. */ + //! Set whether layer is valid or not - should be used in constructor. void setValid( bool valid ); /** Called by readLayerXML(), used by children to read state specific to them from @@ -792,34 +792,34 @@ class CORE_EXPORT QgsMapLayer : public QObject @param keyStartsWith reads only properties starting with the specified string (or all if the string is empty)*/ void readCustomProperties( const QDomNode& layerNode, const QString& keyStartsWith = "" ); - /** Write custom properties to project file. */ + //! Write custom properties to project file. void writeCustomProperties( QDomNode & layerNode, QDomDocument & doc ) const; - /** Read style manager's configuration (if any). To be called by subclasses. */ + //! Read style manager's configuration (if any). To be called by subclasses. void readStyleManager( const QDomNode& layerNode ); - /** Write style manager's configuration (if exists). To be called by subclasses. */ + //! Write style manager's configuration (if exists). To be called by subclasses. void writeStyleManager( QDomNode& layerNode, QDomDocument& doc ) const; #if 0 - /** Debugging member - invoked when a connect() is made to this object */ + //! Debugging member - invoked when a connect() is made to this object void connectNotify( const char * signal ) override; #endif - /** Add error message */ + //! Add error message void appendError( const QgsErrorMessage & error ) { mError.append( error );} - /** Set error message */ + //! Set error message void setError( const QgsError & error ) { mError = error;} - /** Extent of the layer */ + //! Extent of the layer mutable QgsRectangle mExtent; - /** Indicates if the layer is valid and can be drawn */ + //! Indicates if the layer is valid and can be drawn bool mValid; - /** Data source description string, varies by layer type */ + //! Data source description string, varies by layer type QString mDataSource; - /** Name of the layer - used for display */ + //! Name of the layer - used for display QString mLayerName; /** Original name of the layer @@ -829,28 +829,28 @@ class CORE_EXPORT QgsMapLayer : public QObject QString mShortName; QString mTitle; - /** Description of the layer*/ + //! Description of the layer QString mAbstract; QString mKeywordList; - /** DataUrl of the layer*/ + //! DataUrl of the layer QString mDataUrl; QString mDataUrlFormat; - /** Attribution of the layer*/ + //! Attribution of the layer QString mAttribution; QString mAttributionUrl; - /** MetadataUrl of the layer*/ + //! MetadataUrl of the layer QString mMetadataUrl; QString mMetadataUrlType; QString mMetadataUrlFormat; - /** WMS legend*/ + //! WMS legend QString mLegendUrl; QString mLegendUrlFormat; - /** \brief Error */ + //! \brief Error QgsError mError; //! List of layers that may modify this layer on modification @@ -870,32 +870,32 @@ class CORE_EXPORT QgsMapLayer : public QObject private to make sure setCrs must be used and crsChanged() is emitted */ QgsCoordinateReferenceSystem mCRS; - /** Private copy constructor - QgsMapLayer not copyable */ + //! Private copy constructor - QgsMapLayer not copyable QgsMapLayer( QgsMapLayer const & ); - /** Private assign operator - QgsMapLayer not copyable */ + //! Private assign operator - QgsMapLayer not copyable QgsMapLayer & operator=( QgsMapLayer const & ); - /** Unique ID of this layer - used to refer to this layer in map layer registry */ + //! Unique ID of this layer - used to refer to this layer in map layer registry QString mID; - /** Type of the layer (eg. vector, raster) */ + //! Type of the layer (eg. vector, raster) QgsMapLayer::LayerType mLayerType; - /** Blend mode for the layer */ + //! Blend mode for the layer QPainter::CompositionMode mBlendMode; - /** Tag for embedding additional information */ + //! Tag for embedding additional information QString mTag; - /** Minimum scale denominator at which this layer should be displayed */ + //! Minimum scale denominator at which this layer should be displayed double mMinScale; - /** Maximum scale denominator at which this layer should be displayed */ + //! Maximum scale denominator at which this layer should be displayed double mMaxScale; - /** A flag that tells us whether to use the above vars to restrict layer visibility */ + //! A flag that tells us whether to use the above vars to restrict layer visibility bool mScaleBasedVisibility; - /** Collection of undoable operations for this layer. **/ + //! Collection of undoable operations for this layer. * QUndoStack mUndoStack; QUndoStack mUndoStackStyles; diff --git a/src/core/qgsmaplayermodel.h b/src/core/qgsmaplayermodel.h index db3de5079c8..33badce780c 100644 --- a/src/core/qgsmaplayermodel.h +++ b/src/core/qgsmaplayermodel.h @@ -37,8 +37,8 @@ class CORE_EXPORT QgsMapLayerModel : public QAbstractItemModel //! Item data roles enum ItemDataRole { - LayerIdRole = Qt::UserRole + 1, /*!< Stores the map layer ID */ - LayerRole, /*!< Stores pointer to the map layer itself */ + LayerIdRole = Qt::UserRole + 1, //!< Stores the map layer ID + LayerRole, //!< Stores pointer to the map layer itself }; /** diff --git a/src/core/qgsmaprendererjob.h b/src/core/qgsmaprendererjob.h index ff57843cd96..fd7ce11e463 100644 --- a/src/core/qgsmaprendererjob.h +++ b/src/core/qgsmaprendererjob.h @@ -49,7 +49,7 @@ struct LayerRenderJob double opacity; bool cached; // if true, img already contains cached image from previous rendering QString layerId; - int renderingTime; //!< time it took to render the layer in ms (it is -1 if not rendered or still rendering) + int renderingTime; //!< Time it took to render the layer in ms (it is -1 if not rendered or still rendering) }; typedef QList LayerRenderJobs; diff --git a/src/core/qgsmapsettings.h b/src/core/qgsmapsettings.h index 06e5624caa9..b42be667168 100644 --- a/src/core/qgsmapsettings.h +++ b/src/core/qgsmapsettings.h @@ -284,12 +284,12 @@ class CORE_EXPORT QgsMapSettings /** Sets the segmentation tolerance applied when rendering curved geometries @param tolerance the segmentation tolerance*/ void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; } - /** Gets the segmentation tolerance applied when rendering curved geometries*/ + //! Gets the segmentation tolerance applied when rendering curved geometries double segmentationTolerance() const { return mSegmentationTolerance; } /** Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) @param type the segmentation tolerance typename*/ void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; } - /** Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)*/ + //! Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const { return mSegmentationToleranceType; } protected: @@ -324,8 +324,8 @@ class CORE_EXPORT QgsMapSettings // derived properties - bool mValid; //!< whether the actual settings are valid (set in updateDerived()) - QgsRectangle mVisibleExtent; //!< extent with some additional white space that matches the output aspect ratio + bool mValid; //!< Whether the actual settings are valid (set in updateDerived()) + QgsRectangle mVisibleExtent; //!< Extent with some additional white space that matches the output aspect ratio double mMapUnitsPerPixel; double mScale; diff --git a/src/core/qgsmapunitscale.h b/src/core/qgsmapunitscale.h index 6b0c1963477..6529d01fba0 100644 --- a/src/core/qgsmapunitscale.h +++ b/src/core/qgsmapunitscale.h @@ -47,18 +47,18 @@ class CORE_EXPORT QgsMapUnitScale , maxSizeMM( 0.0 ) {} - /** The minimum scale, or 0.0 if unset */ + //! The minimum scale, or 0.0 if unset double minScale; - /** The maximum scale, or 0.0 if unset */ + //! The maximum scale, or 0.0 if unset double maxScale; - /** Whether the minimum size in mm should be respected */ + //! Whether the minimum size in mm should be respected bool minSizeMMEnabled; - /** The minimum size in millimeters, or 0.0 if unset */ + //! The minimum size in millimeters, or 0.0 if unset double minSizeMM; - /** Whether the maximum size in mm should be respected */ + //! Whether the maximum size in mm should be respected bool maxSizeMMEnabled; - /** The maximum size in millimeters, or 0.0 if unset */ + //! The maximum size in millimeters, or 0.0 if unset double maxSizeMM; /** Computes a map units per pixel scaling factor, respecting the minimum and maximum scales diff --git a/src/core/qgsnetworkreplyparser.h b/src/core/qgsnetworkreplyparser.h index 3395370b976..ca7cf7b1b18 100644 --- a/src/core/qgsnetworkreplyparser.h +++ b/src/core/qgsnetworkreplyparser.h @@ -56,7 +56,7 @@ class CORE_EXPORT QgsNetworkReplyParser : public QObject * @return raw header */ QByteArray rawHeader( int part, const QByteArray & headerName ) const { return mHeaders.value( part ).value( headerName ); } - /** Get headers */ + //! Get headers QList< RawHeaderMap > headers() const { return mHeaders; } /** Get part part body @@ -64,10 +64,10 @@ class CORE_EXPORT QgsNetworkReplyParser : public QObject * @return part body */ QByteArray body( int part ) const { return mBodies.value( part ); } - /** Get bodies */ + //! Get bodies QList bodies() const { return mBodies; } - /** Parsing error */ + //! Parsing error QString error() const { return mError; } /** Test if reply is multipart. diff --git a/src/core/qgsobjectcustomproperties.h b/src/core/qgsobjectcustomproperties.h index 213fbbb362c..27782bdf219 100644 --- a/src/core/qgsobjectcustomproperties.h +++ b/src/core/qgsobjectcustomproperties.h @@ -54,7 +54,7 @@ class CORE_EXPORT QgsObjectCustomProperties */ void readXml( const QDomNode& parentNode, const QString& keyStartsWith = QString() ); - /** Write store contents to XML */ + //! Write store contents to XML void writeXml( QDomNode& parentNode, QDomDocument& doc ) const; diff --git a/src/core/qgsofflineediting.h b/src/core/qgsofflineediting.h index 0d088cb2345..b5dfb3b4bdb 100644 --- a/src/core/qgsofflineediting.h +++ b/src/core/qgsofflineediting.h @@ -58,14 +58,14 @@ class CORE_EXPORT QgsOfflineEditing : public QObject */ bool convertToOfflineProject( const QString& offlineDataPath, const QString& offlineDbFile, const QStringList& layerIds, bool onlySelected = false ); - /** Return true if current project is offline */ + //! Return true if current project is offline bool isOfflineProject() const; - /** Synchronize to remote layers */ + //! Synchronize to remote layers void synchronize(); signals: - /** Emit a signal that processing has started */ + //! Emit a signal that processing has started void progressStarted(); /** Emit a signal that the next layer of numLayers has started processing @@ -85,7 +85,7 @@ class CORE_EXPORT QgsOfflineEditing : public QObject */ void progressUpdated( int progress ); - /** Emit a signal that processing of all layers has finished */ + //! Emit a signal that processing of all layers has finished void progressStopped(); /** diff --git a/src/core/qgsogcutils.h b/src/core/qgsogcutils.h index fb46c0019df..fa908095797 100644 --- a/src/core/qgsogcutils.h +++ b/src/core/qgsogcutils.h @@ -65,10 +65,10 @@ class CORE_EXPORT QgsOgcUtils */ static QgsGeometry geometryFromGML( const QDomNode& geometryNode ); - /** Read rectangle from GML2 Box */ + //! Read rectangle from GML2 Box static QgsRectangle rectangleFromGMLBox( const QDomNode& boxNode ); - /** Read rectangle from GML3 Envelope */ + //! Read rectangle from GML3 Envelope static QgsRectangle rectangleFromGMLEnvelope( const QDomNode& envelopeNode ); /** Exports the geometry to GML @@ -121,10 +121,10 @@ class CORE_EXPORT QgsOgcUtils int precision = 17 ); - /** Parse XML with OGC fill into QColor */ + //! Parse XML with OGC fill into QColor static QColor colorFromOgcFill( const QDomElement& fillElement ); - /** Parse XML with OGC filter into QGIS expression */ + //! Parse XML with OGC filter into QGIS expression static QgsExpression* expressionFromOgcFilter( const QDomElement& element ); /** Creates OGC filter XML element. Supports minimum standard filter @@ -189,14 +189,14 @@ class CORE_EXPORT QgsOgcUtils class LayerProperties { public: - /** Constructor */ + //! Constructor LayerProperties() {} - /** Layer name */ + //! Layer name QString mName; - /** Geometry attribute name */ + //! Geometry attribute name QString mGeometryAttribute; - /** SRS name */ + //! SRS name QString mSRSName; }; @@ -229,17 +229,17 @@ class CORE_EXPORT QgsOgcUtils private: - /** Static method that creates geometry from GML Point */ + //! Static method that creates geometry from GML Point static QgsGeometry geometryFromGMLPoint( const QDomElement& geometryElement ); - /** Static method that creates geometry from GML LineString */ + //! Static method that creates geometry from GML LineString static QgsGeometry geometryFromGMLLineString( const QDomElement& geometryElement ); - /** Static method that creates geometry from GML Polygon */ + //! Static method that creates geometry from GML Polygon static QgsGeometry geometryFromGMLPolygon( const QDomElement& geometryElement ); - /** Static method that creates geometry from GML MultiPoint */ + //! Static method that creates geometry from GML MultiPoint static QgsGeometry geometryFromGMLMultiPoint( const QDomElement& geometryElement ); - /** Static method that creates geometry from GML MultiLineString */ + //! Static method that creates geometry from GML MultiLineString static QgsGeometry geometryFromGMLMultiLineString( const QDomElement& geometryElement ); - /** Static method that creates geometry from GML MultiPolygon */ + //! Static method that creates geometry from GML MultiPolygon static QgsGeometry geometryFromGMLMultiPolygon( const QDomElement& geometryElement ); /** Reads the \verbatim \endverbatim element and extracts the coordinates as points @param coords list where the found coordinates are appended @@ -294,7 +294,7 @@ class CORE_EXPORT QgsOgcUtils class QgsOgcUtilsExprToFilter { public: - /** Constructor */ + //! Constructor QgsOgcUtilsExprToFilter( QDomDocument& doc, QgsOgcUtils::GMLVersion gmlVersion, QgsOgcUtils::FilterVersion filterVersion, @@ -303,13 +303,13 @@ class QgsOgcUtilsExprToFilter bool honourAxisOrientation, bool invertAxisOrientation ); - /** Convert an expression to a OGC filter */ + //! Convert an expression to a OGC filter QDomElement expressionNodeToOgcFilter( const QgsExpression::Node* node ); - /** Return whether the gml: namespace is used */ + //! Return whether the gml: namespace is used bool GMLNamespaceUsed() const { return mGMLUsed; } - /** Return the error message. */ + //! Return the error message. const QString& errorMessage() const { return mErrorMessage; } private: @@ -340,7 +340,7 @@ class QgsOgcUtilsExprToFilter class QgsOgcUtilsSQLStatementToFilter { public: - /** Constructor */ + //! Constructor QgsOgcUtilsSQLStatementToFilter( QDomDocument& doc, QgsOgcUtils::GMLVersion gmlVersion, QgsOgcUtils::FilterVersion filterVersion, @@ -349,13 +349,13 @@ class QgsOgcUtilsSQLStatementToFilter bool invertAxisOrientation, const QMap< QString, QString>& mapUnprefixedTypenameToPrefixedTypename ); - /** Convert a SQL statement to a OGC filter */ + //! Convert a SQL statement to a OGC filter QDomElement toOgcFilter( const QgsSQLStatement::Node* node ); - /** Return whether the gml: namespace is used */ + //! Return whether the gml: namespace is used bool GMLNamespaceUsed() const { return mGMLUsed; } - /** Return the error message. */ + //! Return the error message. const QString& errorMessage() const { return mErrorMessage; } private: diff --git a/src/core/qgsowsconnection.h b/src/core/qgsowsconnection.h index e2aee7dcdd2..e0231e6f80a 100644 --- a/src/core/qgsowsconnection.h +++ b/src/core/qgsowsconnection.h @@ -45,19 +45,19 @@ class CORE_EXPORT QgsOwsConnection : public QObject //! Destructor ~QgsOwsConnection(); - /** Returns the list of connections for the specified service */ + //! Returns the list of connections for the specified service static QStringList connectionList( const QString & theService ); - /** Deletes the connection for the specified service with the specified name */ + //! Deletes the connection for the specified service with the specified name static void deleteConnection( const QString & theService, const QString & name ); - /** Retreives the selected connection for the specified service */ + //! Retreives the selected connection for the specified service static QString selectedConnection( const QString & theService ); - /** Marks the specified connection for the specified service as selected */ + //! Marks the specified connection for the specified service as selected static void setSelectedConnection( const QString & theService, const QString & name ); QString mConnName; - /** Returns the connection uri */ + //! Returns the connection uri QgsDataSourceUri uri() const; QString mConnectionInfo; diff --git a/src/core/qgspalgeometry.h b/src/core/qgspalgeometry.h index d8d3864df13..c065341648f 100644 --- a/src/core/qgspalgeometry.h +++ b/src/core/qgspalgeometry.h @@ -142,7 +142,7 @@ class QgsTextLabelFeature : public QgsLabelFeature QFont mDefinedFont; //! Metrics of the font for rendering QFontMetricsF* mFontMetrics; - /** Stores attribute values for data defined properties*/ + //! Stores attribute values for data defined properties QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > mDataDefinedValues; }; diff --git a/src/core/qgspallabeling.h b/src/core/qgspallabeling.h index 7230ce9475c..3481124c25b 100644 --- a/src/core/qgspallabeling.h +++ b/src/core/qgspallabeling.h @@ -179,14 +179,14 @@ class CORE_EXPORT QgsPalLayerSettings //TODO QGIS 3.0 - move to QgsLabelingEngine enum Placement { - AroundPoint, /**< Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygon layers only.*/ - OverPoint, /** Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point. Applies to point or polygon layers only.*/ - Line, /**< Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon's perimeter. Applies to line or polygon layers only. */ - Curved, /** Arranges candidates following the curvature of a line feature. Applies to line layers only.*/ - Horizontal, /**< Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only.*/ - Free, /**< Arranges candidates scattered throughout a polygon feature. Candidates are rotated to respect the polygon's orientation. Applies to polygon layers only.*/ - OrderedPositionsAroundPoint, /**< Candidates are placed in predefined positions around a point. Peference is given to positions with greatest cartographic appeal, eg top right, bottom right, etc. Applies to point layers only.*/ - PerimeterCurved, /** Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only.*/ + AroundPoint, //!< Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygon layers only. + OverPoint, //! Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point. Applies to point or polygon layers only. + Line, //!< Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon's perimeter. Applies to line or polygon layers only. + Curved, //! Arranges candidates following the curvature of a line feature. Applies to line layers only. + Horizontal, //!< Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only. + Free, //!< Arranges candidates scattered throughout a polygon feature. Candidates are rotated to respect the polygon's orientation. Applies to polygon layers only. + OrderedPositionsAroundPoint, //!< Candidates are placed in predefined positions around a point. Peference is given to positions with greatest cartographic appeal, eg top right, bottom right, etc. Applies to point layers only. + PerimeterCurved, //! Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only. }; //! Positions for labels when using the QgsPalLabeling::OrderedPositionsAroundPoint placement mode @@ -222,7 +222,7 @@ class CORE_EXPORT QgsPalLayerSettings //LinePlacementFlags type, and replace use of pal::LineArrangementFlag enum LinePlacementFlags { - OnLine = 1, /**< Labels can be placed directly over a line feature.*/ + OnLine = 1, //!< Labels can be placed directly over a line feature. AboveLine = 2, /**< Labels can be placed above a line feature. Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed below the line feature. */ @@ -249,16 +249,16 @@ class CORE_EXPORT QgsPalLayerSettings enum UpsideDownLabels { - Upright, /*!< upside-down labels (90 <= angle < 270) are shown upright */ - ShowDefined, /*!< show upside down when rotation is layer- or data-defined */ - ShowAll /*!< show upside down for all labels, including dynamic ones */ + Upright, //!< Upside-down labels (90 <= angle < 270) are shown upright + ShowDefined, //!< Show upside down when rotation is layer- or data-defined + ShowAll //!< Show upside down for all labels, including dynamic ones }; enum DirectionSymbols { - SymbolLeftRight, /*!< place direction symbols on left/right of label */ - SymbolAbove, /*!< place direction symbols on above label */ - SymbolBelow /*!< place direction symbols on below label */ + SymbolLeftRight, //!< Place direction symbols on left/right of label + SymbolAbove, //!< Place direction symbols on above label + SymbolBelow //!< Place direction symbols on below label }; enum MultiLineAlign @@ -287,7 +287,7 @@ class CORE_EXPORT QgsPalLayerSettings }; - /** Units used for option sizes, before being converted to rendered sizes */ + //! Units used for option sizes, before being converted to rendered sizes enum SizeUnit { Points = 0, @@ -576,7 +576,7 @@ class CORE_EXPORT QgsPalLayerSettings void setDataDefinedProperty( QgsPalLayerSettings::DataDefinedProperties p, bool active, bool useExpr, const QString& expr, const QString& field ); - /** Set a property to static instead data defined */ + //! Set a property to static instead data defined void removeDataDefinedProperty( QgsPalLayerSettings::DataDefinedProperties p ); /** Clear all data-defined properties diff --git a/src/core/qgspluginlayer.h b/src/core/qgspluginlayer.h index f57be662f82..66a7a670204 100644 --- a/src/core/qgspluginlayer.h +++ b/src/core/qgspluginlayer.h @@ -34,10 +34,10 @@ class CORE_EXPORT QgsPluginLayer : public QgsMapLayer public: QgsPluginLayer( const QString& layerType, const QString& layerName = QString() ); - /** Return plugin layer type (the same as used in QgsPluginLayerRegistry) */ + //! Return plugin layer type (the same as used in QgsPluginLayerRegistry) QString pluginLayerType(); - /** Set extent of the layer */ + //! Set extent of the layer void setExtent( const QgsRectangle &extent ) override; /** Set source string. This is used for example in layer tree to show tooltip. diff --git a/src/core/qgspluginlayerregistry.cpp b/src/core/qgspluginlayerregistry.cpp index cd0390ef0f8..0e2d5708db9 100644 --- a/src/core/qgspluginlayerregistry.cpp +++ b/src/core/qgspluginlayerregistry.cpp @@ -54,7 +54,7 @@ bool QgsPluginLayerType::showLayerProperties( QgsPluginLayer *layer ) //============================================================================= -/** Static calls to enforce singleton behaviour */ +//! Static calls to enforce singleton behaviour QgsPluginLayerRegistry* QgsPluginLayerRegistry::_instance = nullptr; QgsPluginLayerRegistry* QgsPluginLayerRegistry::instance() { diff --git a/src/core/qgspluginlayerregistry.h b/src/core/qgspluginlayerregistry.h index 7fa06718ae9..9d0a8fbf628 100644 --- a/src/core/qgspluginlayerregistry.h +++ b/src/core/qgspluginlayerregistry.h @@ -36,7 +36,7 @@ class CORE_EXPORT QgsPluginLayerType QString name(); - /** Return new layer of this type. Return NULL on error */ + //! Return new layer of this type. Return NULL on error virtual QgsPluginLayer* createLayer(); /** Return new layer of this type, using layer URI (specific to this plugin layer type). Return NULL on error. @@ -44,7 +44,7 @@ class CORE_EXPORT QgsPluginLayerType */ virtual QgsPluginLayer* createLayer( const QString& uri ); - /** Show plugin layer properties dialog. Return false if the dialog cannot be shown. */ + //! Show plugin layer properties dialog. Return false if the dialog cannot be shown. virtual bool showLayerProperties( QgsPluginLayer* layer ); protected: @@ -60,7 +60,7 @@ class CORE_EXPORT QgsPluginLayerRegistry { public: - /** Means of accessing canonical single instance */ + //! Means of accessing canonical single instance static QgsPluginLayerRegistry* instance(); ~QgsPluginLayerRegistry(); @@ -69,13 +69,13 @@ class CORE_EXPORT QgsPluginLayerRegistry * \note added in v2.1 */ QStringList pluginLayerTypes(); - /** Add plugin layer type (take ownership) and return true on success */ + //! Add plugin layer type (take ownership) and return true on success bool addPluginLayerType( QgsPluginLayerType* pluginLayerType ); - /** Remove plugin layer type and return true on success */ + //! Remove plugin layer type and return true on success bool removePluginLayerType( const QString& typeName ); - /** Return plugin layer type metadata or NULL if doesn't exist */ + //! Return plugin layer type metadata or NULL if doesn't exist QgsPluginLayerType* pluginLayerType( const QString& typeName ); /** Return new layer if corresponding plugin has been found, else return NULL. @@ -87,12 +87,12 @@ class CORE_EXPORT QgsPluginLayerRegistry typedef QMap PluginLayerTypes; - /** Private since instance() creates it */ + //! Private since instance() creates it QgsPluginLayerRegistry(); QgsPluginLayerRegistry( const QgsPluginLayerRegistry& rh ); QgsPluginLayerRegistry& operator=( const QgsPluginLayerRegistry& rh ); - /** Pointer to canonical Singleton object */ + //! Pointer to canonical Singleton object static QgsPluginLayerRegistry* _instance; PluginLayerTypes mPluginLayerTypes; diff --git a/src/core/qgspoint.h b/src/core/qgspoint.h index 56fed3917ed..6fbf0a59db3 100644 --- a/src/core/qgspoint.h +++ b/src/core/qgspoint.h @@ -122,7 +122,7 @@ class CORE_EXPORT QgsPoint , m_y( 0.0 ) {} - /** Create a point from another point */ + //! Create a point from another point QgsPoint( const QgsPoint& p ); /** Create a point from x,y coordinates @@ -171,7 +171,7 @@ class CORE_EXPORT QgsPoint m_y = y; } - /** Sets the x and y value of the point */ + //! Sets the x and y value of the point void set( double x, double y ) { m_x = x; @@ -260,10 +260,10 @@ class CORE_EXPORT QgsPoint */ double distance( const QgsPoint& other ) const; - /** Returns the minimum distance between this point and a segment */ + //! Returns the minimum distance between this point and a segment double sqrDistToSegment( double x1, double y1, double x2, double y2, QgsPoint& minDistPoint, double epsilon = DEFAULT_SEGMENT_EPSILON ) const; - /** Calculates azimuth between this point and other one (clockwise in degree, starting from north) */ + //! Calculates azimuth between this point and other one (clockwise in degree, starting from north) double azimuth( const QgsPoint& other ) const; /** Returns a new point which correponds to this point projected by a specified distance diff --git a/src/core/qgspointlocator.h b/src/core/qgspointlocator.h index faf35b4078b..272da0ce7ea 100644 --- a/src/core/qgspointlocator.h +++ b/src/core/qgspointlocator.h @@ -92,7 +92,7 @@ class CORE_EXPORT QgsPointLocator : public QObject * false if the creation of index has been prematurely stopped due to the limit of features, otherwise true */ bool init( int maxFeaturesToIndex = -1 ); - /** Indicate whether the data have been already indexed */ + //! Indicate whether the data have been already indexed bool hasIndex() const; struct Match @@ -215,7 +215,7 @@ class CORE_EXPORT QgsPointLocator : public QObject void onGeometryChanged( QgsFeatureId fid, const QgsGeometry& geom ); private: - /** Storage manager */ + //! Storage manager SpatialIndex::IStorageManager* mStorage; QHash mGeoms; @@ -224,7 +224,7 @@ class CORE_EXPORT QgsPointLocator : public QObject //! flag whether the layer is currently empty (i.e. mRTree is null but it is not necessary to rebuild it) bool mIsEmptyLayer; - /** R-tree containing spatial index */ + //! R-tree containing spatial index QgsCoordinateTransform mTransform; QgsVectorLayer* mLayer; QgsRectangle* mExtent; diff --git a/src/core/qgsproject.h b/src/core/qgsproject.h index d8d06aca731..63d6e0cdbc5 100644 --- a/src/core/qgsproject.h +++ b/src/core/qgsproject.h @@ -282,7 +282,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera bool readBoolEntry( const QString& scope, const QString& key, bool def = false, bool* ok = nullptr ) const; - /** Remove the given key */ + //! Remove the given key bool removeEntry( const QString& scope, const QString& key ); @@ -312,10 +312,10 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ QString writePath( const QString& filename, const QString& relativeBasePath = QString::null ) const; - /** Turn filename read from the project file to an absolute path */ + //! Turn filename read from the project file to an absolute path QString readPath( QString filename ) const; - /** Return error message from previous read/write */ + //! Return error message from previous read/write QString error() const; /** Change handler for missing layers. @@ -323,7 +323,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ void setBadLayerHandler( QgsProjectBadLayerHandler* handler ); - /** Returns project file path if layer is embedded from other project file. Returns empty string if layer is not embedded*/ + //! Returns project file path if layer is embedded from other project file. Returns empty string if layer is not embedded QString layerIsEmbedded( const QString& id ) const; /** Creates a maplayer instance defined in an arbitrary project file. Caller takes ownership @@ -338,10 +338,10 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ QgsLayerTreeGroup* createEmbeddedGroup( const QString& groupName, const QString& projectFilePath, const QStringList &invisibleLayers ); - /** Convenience function to set topological editing */ + //! Convenience function to set topological editing void setTopologicalEditing( bool enabled ); - /** Convenience function to query topological editing status */ + //! Convenience function to query topological editing status bool topologicalEditing() const; /** Convenience function to query default distance measurement units for project. diff --git a/src/core/qgsprojectproperty.h b/src/core/qgsprojectproperty.h index 507fb324f3a..49bf0bc519c 100644 --- a/src/core/qgsprojectproperty.h +++ b/src/core/qgsprojectproperty.h @@ -56,10 +56,10 @@ class CORE_EXPORT QgsProperty */ virtual void dump( int tabs = 0 ) const = 0; - /** Returns true if is a QgsPropertyKey */ + //! Returns true if is a QgsPropertyKey virtual bool isKey() const = 0; - /** Returns true if is a QgsPropertyValue */ + //! Returns true if is a QgsPropertyValue virtual bool isValue() const = 0; /** Returns true if a leaf node @@ -123,10 +123,10 @@ class CORE_EXPORT QgsPropertyValue : public QgsProperty virtual ~QgsPropertyValue(); - /** Returns true if is a QgsPropertyKey */ + //! Returns true if is a QgsPropertyKey virtual bool isKey() const override { return false; } - /** Returns true if is a QgsPropertyValue */ + //! Returns true if is a QgsPropertyValue virtual bool isValue() const override { return true; } QVariant value() const override { return value_; } @@ -261,10 +261,10 @@ class CORE_EXPORT QgsPropertyKey : public QgsProperty /// Does this property not have any subkeys or values? /* virtual */ bool isEmpty() const { return mProperties.isEmpty(); } - /** Returns true if is a QgsPropertyKey */ + //! Returns true if is a QgsPropertyKey virtual bool isKey() const override { return true; } - /** Returns true if is a QgsPropertyValue */ + //! Returns true if is a QgsPropertyValue virtual bool isValue() const override { return false; } /// return keys that do not contain other keys diff --git a/src/core/qgsproviderregistry.h b/src/core/qgsproviderregistry.h index 9b9c85edd9e..8fa00d016f1 100644 --- a/src/core/qgsproviderregistry.h +++ b/src/core/qgsproviderregistry.h @@ -47,22 +47,22 @@ class CORE_EXPORT QgsProviderRegistry public: - /** Means of accessing canonical single instance */ + //! Means of accessing canonical single instance static QgsProviderRegistry* instance( const QString& pluginPath = QString::null ); - /** Virtual dectructor */ + //! Virtual dectructor virtual ~QgsProviderRegistry(); - /** Return path for the library of the provider */ + //! Return path for the library of the provider QString library( const QString & providerKey ) const; - /** Return list of provider plugins found */ + //! Return list of provider plugins found QString pluginList( bool asHtml = false ) const; - /** Return library directory where plugins are found */ + //! Return library directory where plugins are found const QDir & libraryDirectory() const; - /** Set library directory where to search for plugins */ + //! Set library directory where to search for plugins void setLibraryDirectory( const QDir & path ); /** Create an instance of the provider @@ -94,10 +94,10 @@ class CORE_EXPORT QgsProviderRegistry QLibrary *providerLibrary( const QString & providerKey ) const; - /** Return list of available providers by their keys */ + //! Return list of available providers by their keys QStringList providerList() const; - /** Return metadata of the provider or NULL if not found */ + //! Return metadata of the provider or NULL if not found const QgsProviderMetadata* providerMetadata( const QString& providerKey ) const; /** Return vector file filter string @@ -124,11 +124,11 @@ class CORE_EXPORT QgsProviderRegistry @note This replaces QgsRasterLayer::buildSupportedRasterFileFilter() */ virtual QString fileRasterFilters() const; - /** Return a string containing the available database drivers */ + //! Return a string containing the available database drivers virtual QString databaseDrivers() const; - /** Return a string containing the available directory drivers */ + //! Return a string containing the available directory drivers virtual QString directoryDrivers() const; - /** Return a string containing the available protocol drivers */ + //! Return a string containing the available protocol drivers virtual QString protocolDrivers() const; void registerGuis( QWidget *widget ); @@ -157,20 +157,20 @@ class CORE_EXPORT QgsProviderRegistry //QgsDataProvider * openVector( QString const & dataSource, QString const & providerKey ); - /** Type for data provider metadata associative container */ + //! Type for data provider metadata associative container typedef std::map Providers; private: - /** Ctor private since instance() creates it */ + //! Ctor private since instance() creates it QgsProviderRegistry( const QString& pluginPath ); void init(); void clean(); - /** Associative container of provider metadata handles */ + //! Associative container of provider metadata handles Providers mProviders; - /** Directory in which provider plugins are installed */ + //! Directory in which provider plugins are installed QDir mLibraryDirectory; /** File filter string for vector files diff --git a/src/core/qgspythonrunner.h b/src/core/qgspythonrunner.h index c0791c1b0b2..07fc0edd79f 100644 --- a/src/core/qgspythonrunner.h +++ b/src/core/qgspythonrunner.h @@ -34,10 +34,10 @@ class CORE_EXPORT QgsPythonRunner (and thus is able to run commands) */ static bool isValid(); - /** Execute a python statement */ + //! Execute a python statement static bool run( const QString& command, const QString& messageOnError = QString() ); - /** Eval a python statement */ + //! Eval a python statement static bool eval( const QString& command, QString& result ); /** Assign an instance of python runner so that run() can be used. @@ -46,7 +46,7 @@ class CORE_EXPORT QgsPythonRunner static void setInstance( QgsPythonRunner* runner ); protected: - /** Protected constructor: can be instantiated only from children */ + //! Protected constructor: can be instantiated only from children QgsPythonRunner(); virtual ~QgsPythonRunner(); diff --git a/src/core/qgsrectangle.h b/src/core/qgsrectangle.h index 2e8595477ec..34878189f3a 100644 --- a/src/core/qgsrectangle.h +++ b/src/core/qgsrectangle.h @@ -83,7 +83,7 @@ class CORE_EXPORT QgsRectangle void scale( double scaleFactor, double centerX, double centerY ); //! Grow the rectangle by the specified amount void grow( double delta ); - /** Updates the rectangle to include the specified point */ + //! Updates the rectangle to include the specified point void include( const QgsPoint& p ); /** Get rectangle enlarged by buffer. * @note added in 2.1 */ @@ -132,7 +132,7 @@ class CORE_EXPORT QgsRectangle */ QgsRectangle & operator=( const QgsRectangle &r1 ); - /** Updates rectangle to include passed argument */ + //! Updates rectangle to include passed argument void unionRect( const QgsRectangle& rect ); /** Returns true if the rectangle has finite boundaries. Will @@ -155,9 +155,9 @@ class CORE_EXPORT QgsRectangle }; -/** Writes the list rectangle to stream out. QGIS version compatibility is not guaranteed. */ +//! Writes the list rectangle to stream out. QGIS version compatibility is not guaranteed. CORE_EXPORT QDataStream& operator<<( QDataStream& out, const QgsRectangle& rectangle ); -/** Reads a rectangle from stream in into rectangle. QGIS version compatibility is not guaranteed. */ +//! Reads a rectangle from stream in into rectangle. QGIS version compatibility is not guaranteed. CORE_EXPORT QDataStream& operator>>( QDataStream& in, QgsRectangle& rectangle ); inline QgsRectangle::~QgsRectangle() diff --git a/src/core/qgsrelation.h b/src/core/qgsrelation.h index 3cc48dcfe20..ca79a034b72 100644 --- a/src/core/qgsrelation.h +++ b/src/core/qgsrelation.h @@ -297,17 +297,17 @@ class CORE_EXPORT QgsRelation void updateRelationStatus(); private: - /** Unique Id */ + //! Unique Id QString mRelationId; - /** Human redable name*/ + //! Human redable name QString mRelationName; - /** The child layer */ + //! The child layer QString mReferencingLayerId; - /** The child layer */ + //! The child layer QgsVectorLayer* mReferencingLayer; - /** The parent layer id */ + //! The parent layer id QString mReferencedLayerId; - /** The parent layer */ + //! The parent layer QgsVectorLayer* mReferencedLayer; /** A list of fields which define the relation. * In most cases there will be only one value, but multiple values diff --git a/src/core/qgsrelationmanager.h b/src/core/qgsrelationmanager.h index 30450c6686d..1bbeb52f727 100644 --- a/src/core/qgsrelationmanager.h +++ b/src/core/qgsrelationmanager.h @@ -128,7 +128,7 @@ class CORE_EXPORT QgsRelationManager : public QObject static QList discoverRelations( const QList& existingRelations, const QList& layers ); signals: - /** This signal is emitted when the relations were loaded after reading a project */ + //! This signal is emitted when the relations were loaded after reading a project void relationsLoaded(); /** @@ -143,7 +143,7 @@ class CORE_EXPORT QgsRelationManager : public QObject void layersRemoved( const QStringList& layers ); private: - /** The references */ + //! The references QMap mRelations; QgsProject* mProject; diff --git a/src/core/qgsrenderchecker.h b/src/core/qgsrenderchecker.h index aff922ad90b..1ba6fa28980 100644 --- a/src/core/qgsrenderchecker.h +++ b/src/core/qgsrenderchecker.h @@ -70,7 +70,7 @@ class CORE_EXPORT QgsRenderChecker void setControlPathSuffix( const QString& theName ); - /** Get an md5 hash that uniquely identifies an image */ + //! Get an md5 hash that uniquely identifies an image QString imageToHash( const QString& theImageFile ); void setRenderedImage( const QString& theImageFileName ) { mRenderedImageFile = theImageFileName; } diff --git a/src/core/qgsrendercontext.h b/src/core/qgsrendercontext.h index 5c24c994a69..a372d7143e4 100644 --- a/src/core/qgsrendercontext.h +++ b/src/core/qgsrendercontext.h @@ -145,7 +145,7 @@ class CORE_EXPORT QgsRenderContext //setters - /** Sets coordinate transformation.*/ + //! Sets coordinate transformation. void setCoordinateTransform( const QgsCoordinateTransform& t ); void setMapToPixel( const QgsMapToPixel& mtp ) {mMapToPixel = mtp;} void setExtent( const QgsRectangle& extent ) {mExtent = extent;} @@ -206,9 +206,9 @@ class CORE_EXPORT QgsRenderContext */ const QgsExpressionContext& expressionContext() const { return mExpressionContext; } - /** Returns pointer to the unsegmentized geometry*/ + //! Returns pointer to the unsegmentized geometry const QgsAbstractGeometry* geometry() const { return mGeometry; } - /** Sets pointer to original (unsegmentized) geometry*/ + //! Sets pointer to original (unsegmentized) geometry void setGeometry( const QgsAbstractGeometry* geometry ) { mGeometry = geometry; } /** Set a filter feature provider used for additional filtering of rendered features. @@ -228,60 +228,60 @@ class CORE_EXPORT QgsRenderContext /** Sets the segmentation tolerance applied when rendering curved geometries @param tolerance the segmentation tolerance*/ void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; } - /** Gets the segmentation tolerance applied when rendering curved geometries*/ + //! Gets the segmentation tolerance applied when rendering curved geometries double segmentationTolerance() const { return mSegmentationTolerance; } /** Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) @param type the segmentation tolerance typename*/ void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; } - /** Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)*/ + //! Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const { return mSegmentationToleranceType; } private: Flags mFlags; - /** Painter for rendering operations*/ + //! Painter for rendering operations QPainter* mPainter; - /** For transformation between coordinate systems. Can be invalid if on-the-fly reprojection is not used*/ + //! For transformation between coordinate systems. Can be invalid if on-the-fly reprojection is not used QgsCoordinateTransform mCoordTransform; QgsRectangle mExtent; QgsMapToPixel mMapToPixel; - /** True if the rendering has been canceled*/ + //! True if the rendering has been canceled bool mRenderingStopped; - /** Factor to scale line widths and point marker sizes*/ + //! Factor to scale line widths and point marker sizes double mScaleFactor; - /** Factor to scale rasters*/ + //! Factor to scale rasters double mRasterScaleFactor; - /** Map scale*/ + //! Map scale double mRendererScale; - /** Labeling engine (can be nullptr)*/ + //! Labeling engine (can be nullptr) QgsLabelingEngineInterface* mLabelingEngine; - /** Newer labeling engine implementation (can be nullptr) */ + //! Newer labeling engine implementation (can be nullptr) QgsLabelingEngine* mLabelingEngine2; - /** Color used for features that are marked as selected */ + //! Color used for features that are marked as selected QColor mSelectionColor; - /** Simplification object which holds the information about how to simplify the features for fast rendering */ + //! Simplification object which holds the information about how to simplify the features for fast rendering QgsVectorSimplifyMethod mVectorSimplifyMethod; - /** Expression context */ + //! Expression context QgsExpressionContext mExpressionContext; - /** Pointer to the (unsegmentized) geometry*/ + //! Pointer to the (unsegmentized) geometry const QgsAbstractGeometry* mGeometry; - /** The feature filter provider */ + //! The feature filter provider const QgsFeatureFilterProvider* mFeatureFilterProvider; double mSegmentationTolerance; diff --git a/src/core/qgsscalecalculator.h b/src/core/qgsscalecalculator.h index fd9ecb5aad8..615b841b5b4 100644 --- a/src/core/qgsscalecalculator.h +++ b/src/core/qgsscalecalculator.h @@ -59,7 +59,7 @@ class CORE_EXPORT QgsScaleCalculator */ void setMapUnits( QgsUnitTypes::DistanceUnit mapUnits ); - /** Returns current map units */ + //! Returns current map units QgsUnitTypes::DistanceUnit mapUnits() const; /** diff --git a/src/core/qgssnapper.h b/src/core/qgssnapper.h index 5af3a4913d6..a9927c1777c 100644 --- a/src/core/qgssnapper.h +++ b/src/core/qgssnapper.h @@ -35,24 +35,24 @@ class QPoint; // ### QGIS 3: remove from API struct CORE_EXPORT QgsSnappingResult { - /** The coordinates of the snapping result*/ + //! The coordinates of the snapping result QgsPoint snappedVertex; /** The vertex index of snappedVertex or -1 if no such vertex number (e.g. snap to segment)*/ int snappedVertexNr; - /** The layer coordinates of the vertex before snappedVertex*/ + //! The layer coordinates of the vertex before snappedVertex QgsPoint beforeVertex; /** The index of the vertex before snappedVertex or -1 if no such vertex*/ int beforeVertexNr; - /** The layer coordinates of the vertex after snappedVertex*/ + //! The layer coordinates of the vertex after snappedVertex QgsPoint afterVertex; /** The index of the vertex after snappedVertex or -1 if no such vertex*/ int afterVertexNr; - /** Index of the snapped geometry*/ + //! Index of the snapped geometry QgsFeatureId snappedAtGeometry; - /** Layer where the snap occurred*/ + //! Layer where the snap occurred const QgsVectorLayer* layer; }; @@ -64,7 +64,7 @@ struct CORE_EXPORT QgsSnappingResult class CORE_EXPORT QgsSnapper { public: - /** Snap to vertex, to segment or both*/ + //! Snap to vertex, to segment or both enum SnappingType { SnapToVertex, @@ -75,24 +75,24 @@ class CORE_EXPORT QgsSnapper enum SnappingMode { - /** Only one snapping result is returned*/ + //! Only one snapping result is returned SnapWithOneResult, /** Several snapping results which have the same position are returned. This is useful for topological editing*/ SnapWithResultsForSamePosition, - /** All results within the given layer tolerances are returned*/ + //! All results within the given layer tolerances are returned SnapWithResultsWithinTolerances }; struct SnapLayer { - /** The layer to which snapping is applied*/ + //! The layer to which snapping is applied QgsVectorLayer* mLayer; - /** The snapping tolerances for the layers, always in source coordinate systems of the layer*/ + //! The snapping tolerances for the layers, always in source coordinate systems of the layer double mTolerance; - /** What snapping type to use (snap to segment or to vertex)*/ + //! What snapping type to use (snap to segment or to vertex) QgsSnapper::SnappingType mSnapTo; - /** What unit is used for tolerance*/ + //! What unit is used for tolerance QgsTolerance::UnitType mUnitType; }; @@ -112,16 +112,16 @@ class CORE_EXPORT QgsSnapper private: - /** Removes the snapping results that contains points in exclude list*/ + //! Removes the snapping results that contains points in exclude list void cleanResultList( QMultiMap& list, const QList& excludeList ) const; /** The map settings object contains information about the output coordinate system * of the map and about the relationship between pixel space and map space */ const QgsMapSettings& mMapSettings; - /** Snap mode to apply*/ + //! Snap mode to apply QgsSnapper::SnappingMode mSnapMode; - /** List of layers to which snapping is applied*/ + //! List of layers to which snapping is applied QList mSnapLayers; }; diff --git a/src/core/qgssnappingconfig.h b/src/core/qgssnappingconfig.h index 1143ebfcdae..2d0bf12fe41 100644 --- a/src/core/qgssnappingconfig.h +++ b/src/core/qgssnappingconfig.h @@ -34,9 +34,9 @@ class CORE_EXPORT QgsSnappingConfig */ enum SnappingMode { - ActiveLayer = 1, /*!< on the active layer */ - AllLayers = 2, /*!< on all vector layers */ - AdvancedConfiguration = 3, /*!< on a per layer configuration basis */ + ActiveLayer = 1, //!< On the active layer + AllLayers = 2, //!< On all vector layers + AdvancedConfiguration = 3, //!< On a per layer configuration basis }; /** @@ -44,9 +44,9 @@ class CORE_EXPORT QgsSnappingConfig */ enum SnappingType { - Vertex = 1, /*!< on vertices only */ - VertexAndSegment = 2, /*!< both on vertices and segments */ - Segment = 3, /*!< on segments only */ + Vertex = 1, //!< On vertices only + VertexAndSegment = 2, //!< Both on vertices and segments + Segment = 3, //!< On segments only }; /** \ingroup core diff --git a/src/core/qgssnappingutils.h b/src/core/qgssnappingutils.h index 72d53a3e8ab..bc11c9248c9 100644 --- a/src/core/qgssnappingutils.h +++ b/src/core/qgssnappingutils.h @@ -53,25 +53,25 @@ class CORE_EXPORT QgsSnappingUtils : public QObject // main actions - /** Get a point locator for the given layer. If such locator does not exist, it will be created */ + //! Get a point locator for the given layer. If such locator does not exist, it will be created QgsPointLocator* locatorForLayer( QgsVectorLayer* vl ); - /** Snap to map according to the current configuration (mode). Optional filter allows discarding unwanted matches. */ + //! Snap to map according to the current configuration (mode). Optional filter allows discarding unwanted matches. QgsPointLocator::Match snapToMap( QPoint point, QgsPointLocator::MatchFilter* filter = nullptr ); QgsPointLocator::Match snapToMap( const QgsPoint& pointMap, QgsPointLocator::MatchFilter* filter = nullptr ); - /** Snap to current layer */ + //! Snap to current layer QgsPointLocator::Match snapToCurrentLayer( QPoint point, int type, QgsPointLocator::MatchFilter* filter = nullptr ); // environment setup - /** Assign current map settings to the utils - used for conversion between screen coords to map coords */ + //! Assign current map settings to the utils - used for conversion between screen coords to map coords void setMapSettings( const QgsMapSettings& settings ); QgsMapSettings mapSettings() const { return mMapSettings; } - /** Set current layer so that if mode is SnapCurrentLayer we know which layer to use */ + //! Set current layer so that if mode is SnapCurrentLayer we know which layer to use void setCurrentLayer( QgsVectorLayer* layer ); - /** The current layer used if mode is SnapCurrentLayer */ + //! The current layer used if mode is SnapCurrentLayer QgsVectorLayer* currentLayer() const { return mCurrentLayer; } @@ -80,9 +80,9 @@ class CORE_EXPORT QgsSnappingUtils : public QObject //! modes for "snap to background" enum SnapToMapMode { - SnapCurrentLayer, //!< snap just to current layer (tolerance and type from defaultSettings()) - SnapAllLayers, //!< snap to all rendered layers (tolerance and type from defaultSettings()) - SnapAdvanced, //!< snap according to the configuration set in setLayers() + SnapCurrentLayer, //!< Snap just to current layer (tolerance and type from defaultSettings()) + SnapAllLayers, //!< Snap to all rendered layers (tolerance and type from defaultSettings()) + SnapAdvanced, //!< Snap according to the configuration set in setLayers() }; enum IndexingStrategy @@ -92,9 +92,9 @@ class CORE_EXPORT QgsSnappingUtils : public QObject IndexHybrid //!< For "big" layers using IndexNeverFull, for the rest IndexAlwaysFull. Compromise between speed and memory usage. }; - /** Set a strategy for indexing geometry data - determines how fast and memory consuming the data structures will be */ + //! Set a strategy for indexing geometry data - determines how fast and memory consuming the data structures will be void setIndexingStrategy( IndexingStrategy strategy ) { mStrategy = strategy; } - /** Find out which strategy is used for indexing - by default hybrid indexing is used */ + //! Find out which strategy is used for indexing - by default hybrid indexing is used IndexingStrategy indexingStrategy() const { return mStrategy; } /** @@ -146,7 +146,7 @@ class CORE_EXPORT QgsSnappingUtils : public QObject QgsTolerance::UnitType unit; }; - /** Query layers used for snapping */ + //! Query layers used for snapping QList layers() const { return mLayers; } /** Get extra information about the instance diff --git a/src/core/qgsspatialindex.cpp b/src/core/qgsspatialindex.cpp index e5e0a378529..7f7ccbf8f49 100644 --- a/src/core/qgsspatialindex.cpp +++ b/src/core/qgsspatialindex.cpp @@ -204,10 +204,10 @@ class QgsSpatialIndexData : public QSharedData leafCapacity, dimension, variant, indexId ); } - /** Storage manager */ + //! Storage manager SpatialIndex::IStorageManager* mStorage; - /** R-tree containing spatial index */ + //! R-tree containing spatial index SpatialIndex::ISpatialIndex* mRTree; private: diff --git a/src/core/qgsspatialindex.h b/src/core/qgsspatialindex.h index 8c6da6debb9..8a9ba9ff8ab 100644 --- a/src/core/qgsspatialindex.h +++ b/src/core/qgsspatialindex.h @@ -52,7 +52,7 @@ class CORE_EXPORT QgsSpatialIndex /* creation of spatial index */ - /** Constructor - creates R-tree */ + //! Constructor - creates R-tree QgsSpatialIndex(); /** Constructor - creates R-tree and bulk loads it with features from the iterator. @@ -62,30 +62,30 @@ class CORE_EXPORT QgsSpatialIndex */ explicit QgsSpatialIndex( const QgsFeatureIterator& fi ); - /** Copy constructor */ + //! Copy constructor QgsSpatialIndex( const QgsSpatialIndex& other ); - /** Destructor finalizes work with spatial index */ + //! Destructor finalizes work with spatial index ~QgsSpatialIndex(); - /** Implement assignment operator */ + //! Implement assignment operator QgsSpatialIndex& operator=( const QgsSpatialIndex& other ); /* operations */ - /** Add feature to index */ + //! Add feature to index bool insertFeature( const QgsFeature& f ); - /** Remove feature from index */ + //! Remove feature from index bool deleteFeature( const QgsFeature& f ); /* queries */ - /** Returns features that intersect the specified rectangle */ + //! Returns features that intersect the specified rectangle QList intersects( const QgsRectangle& rect ) const; - /** Returns nearest neighbors (their count is specified by second parameter) */ + //! Returns nearest neighbors (their count is specified by second parameter) QList nearestNeighbor( const QgsPoint& point, int neighbors ) const; /* debugging */ diff --git a/src/core/qgssqlexpressioncompiler.h b/src/core/qgssqlexpressioncompiler.h index 5a083626816..ccf683d387c 100644 --- a/src/core/qgssqlexpressioncompiler.h +++ b/src/core/qgssqlexpressioncompiler.h @@ -34,13 +34,13 @@ class CORE_EXPORT QgsSqlExpressionCompiler { public: - /** Possible results from expression compilation */ + //! Possible results from expression compilation enum Result { - None, /*!< No expression */ - Complete, /*!< Expression was successfully compiled and can be completely delegated to provider */ - Partial, /*!< Expression was partially compiled, but provider will return extra records and results must be double-checked using QGIS' expression engine*/ - Fail /*!< Provider cannot handle expression */ + None, //!< No expression + Complete, //!< Expression was successfully compiled and can be completely delegated to provider + Partial, //!< Expression was partially compiled, but provider will return extra records and results must be double-checked using QGIS' expression engine + Fail //!< Provider cannot handle expression }; /** Enumeration of flags for how provider handles SQL clauses diff --git a/src/core/qgssqlstatement.h b/src/core/qgssqlstatement.h index 0fdbc5532f0..def8f3973f1 100644 --- a/src/core/qgssqlstatement.h +++ b/src/core/qgssqlstatement.h @@ -171,7 +171,7 @@ class CORE_EXPORT QgsSQLStatement class Visitor; // visitor interface is defined below - /** Node type */ + //! Node type enum NodeType { ntUnaryOperator, @@ -243,27 +243,27 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeList { public: - /** Constructor */ + //! Constructor NodeList() {} virtual ~NodeList() { qDeleteAll( mList ); } - /** Takes ownership of the provided node */ + //! Takes ownership of the provided node void append( Node* node ) { mList.append( node ); } - /** Return list */ + //! Return list QList list() { return mList; } /** Returns the number of nodes in the list. */ int count() const { return mList.count(); } - /** Accept visitor */ + //! Accept visitor void accept( Visitor& v ) const { Q_FOREACH ( Node* node, mList ) { node->accept( v ); } } - /** Creates a deep copy of this list. Ownership is transferred to the caller */ + //! Creates a deep copy of this list. Ownership is transferred to the caller NodeList* clone() const; - /** Dump list */ + //! Dump list virtual QString dump() const; protected: @@ -275,14 +275,14 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeUnaryOperator : public Node { public: - /** Constructor */ + //! Constructor NodeUnaryOperator( UnaryOperator op, Node* operand ) : mOp( op ), mOperand( operand ) {} ~NodeUnaryOperator() { delete mOperand; } - /** Operator */ + //! Operator UnaryOperator op() const { return mOp; } - /** Operand */ + //! Operand Node* operand() const { return mOperand; } virtual NodeType nodeType() const override { return ntUnaryOperator; } @@ -301,17 +301,17 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeBinaryOperator : public Node { public: - /** Constructor */ + //! Constructor NodeBinaryOperator( BinaryOperator op, Node* opLeft, Node* opRight ) : mOp( op ), mOpLeft( opLeft ), mOpRight( opRight ) {} ~NodeBinaryOperator() { delete mOpLeft; delete mOpRight; } - /** Operator */ + //! Operator BinaryOperator op() const { return mOp; } - /** Left operand */ + //! Left operand Node* opLeft() const { return mOpLeft; } - /** Right operand */ + //! Right operand Node* opRight() const { return mOpRight; } virtual NodeType nodeType() const override { return ntBinaryOperator; } @@ -320,10 +320,10 @@ class CORE_EXPORT QgsSQLStatement virtual void accept( Visitor& v ) const override { v.visit( *this ); } virtual Node* clone() const override; - /** Precedence */ + //! Precedence int precedence() const; - /** Is left associative ? */ + //! Is left associative ? bool leftAssociative() const; protected: @@ -338,17 +338,17 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeInOperator : public Node { public: - /** Constructor */ + //! Constructor NodeInOperator( Node* node, NodeList* list, bool notin = false ) : mNode( node ), mList( list ), mNotIn( notin ) {} virtual ~NodeInOperator() { delete mNode; delete mList; } - /** Variable at the left of IN */ + //! Variable at the left of IN Node* node() const { return mNode; } - /** Whether this is a NOT IN operator */ + //! Whether this is a NOT IN operator bool isNotIn() const { return mNotIn; } - /** Values list */ + //! Values list NodeList* list() const { return mList; } virtual NodeType nodeType() const override { return ntInOperator; } @@ -368,20 +368,20 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeBetweenOperator : public Node { public: - /** Constructor */ + //! Constructor NodeBetweenOperator( Node* node, Node* minVal, Node* maxVal, bool notBetween = false ) : mNode( node ), mMinVal( minVal ), mMaxVal( maxVal ), mNotBetween( notBetween ) {} virtual ~NodeBetweenOperator() { delete mNode; delete mMinVal; delete mMaxVal; } - /** Variable at the left of BETWEEN */ + //! Variable at the left of BETWEEN Node* node() const { return mNode; } - /** Whether this is a NOT BETWEEN operator */ + //! Whether this is a NOT BETWEEN operator bool isNotBetween() const { return mNotBetween; } - /** Minimum bound */ + //! Minimum bound Node* minVal() const { return mMinVal; } - /** Maximum bound */ + //! Maximum bound Node* maxVal() const { return mMaxVal; } virtual NodeType nodeType() const override { return ntBetweenOperator; } @@ -402,14 +402,14 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeFunction : public Node { public: - /** Constructor */ + //! Constructor NodeFunction( const QString& name, NodeList* args ) : mName( name ), mArgs( args ) {} virtual ~NodeFunction() { delete mArgs; } - /** Return function name */ + //! Return function name QString name() const { return mName; } - /** Return arguments */ + //! Return arguments NodeList* args() const { return mArgs; } virtual NodeType nodeType() const override { return ntFunction; } @@ -429,10 +429,10 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeLiteral : public Node { public: - /** Constructor */ + //! Constructor NodeLiteral( const QVariant& value ) : mValue( value ) {} - /** The value of the literal. */ + //! The value of the literal. inline QVariant value() const { return mValue; } virtual NodeType nodeType() const override { return ntLiteral; } @@ -450,24 +450,24 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeColumnRef : public Node { public: - /** Constructor with colum name only */ + //! Constructor with colum name only NodeColumnRef( const QString& name, bool star ) : mName( name ), mDistinct( false ), mStar( star ) {} - /** Constructor with table and column name */ + //! Constructor with table and column name NodeColumnRef( const QString& tableName, const QString& name, bool star ) : mTableName( tableName ), mName( name ), mDistinct( false ), mStar( star ) {} - /** Set whether this is prefixed by DISTINCT */ + //! Set whether this is prefixed by DISTINCT void setDistinct( bool distinct = true ) { mDistinct = distinct; } - /** The name of the table. May be empty. */ + //! The name of the table. May be empty. QString tableName() const { return mTableName; } - /** The name of the column. */ + //! The name of the column. QString name() const { return mName; } - /** Whether this is the * column */ + //! Whether this is the * column bool star() const { return mStar; } - /** Whether this is prefixed by DISTINCT */ + //! Whether this is prefixed by DISTINCT bool distinct() const { return mDistinct; } virtual NodeType nodeType() const override { return ntColumnRef; } @@ -475,7 +475,7 @@ class CORE_EXPORT QgsSQLStatement virtual void accept( Visitor& v ) const override { v.visit( *this ); } virtual Node* clone() const override; - /** Clone with same type return */ + //! Clone with same type return NodeColumnRef* cloneThis() const; protected: @@ -490,17 +490,17 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeSelectedColumn : public Node { public: - /** Constructor */ + //! Constructor NodeSelectedColumn( Node* node ) : mColumnNode( node ) {} virtual ~NodeSelectedColumn() { delete mColumnNode; } - /** Set alias name */ + //! Set alias name void setAlias( const QString& alias ) { mAlias = alias; } - /** Column that is refered to */ + //! Column that is refered to Node* column() const { return mColumnNode; } - /** Alias name */ + //! Alias name QString alias() const { return mAlias; } virtual NodeType nodeType() const override { return ntSelectedColumn; } @@ -508,7 +508,7 @@ class CORE_EXPORT QgsSQLStatement virtual void accept( Visitor& v ) const override { v.visit( *this ); } virtual Node* clone() const override; - /** Clone with same type return */ + //! Clone with same type return NodeSelectedColumn* cloneThis() const; protected: @@ -521,14 +521,14 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeCast : public Node { public: - /** Constructor */ + //! Constructor NodeCast( Node* node, const QString& type ) : mNode( node ), mType( type ) {} virtual ~NodeCast() { delete mNode; } - /** Node that is refered to */ + //! Node that is refered to Node* node() const { return mNode; } - /** Type */ + //! Type QString type() const { return mType; } virtual NodeType nodeType() const override { return ntCast; } @@ -547,15 +547,15 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeTableDef : public Node { public: - /** Constructor with table name */ + //! Constructor with table name NodeTableDef( const QString& name ) : mName( name ) {} - /** Constructor with table name and alias */ + //! Constructor with table name and alias NodeTableDef( const QString& name, const QString& alias ) : mName( name ), mAlias( alias ) {} - /** Table name */ + //! Table name QString name() const { return mName; } - /** Table alias */ + //! Table alias QString alias() const { return mAlias; } virtual NodeType nodeType() const override { return ntTableDef; } @@ -563,7 +563,7 @@ class CORE_EXPORT QgsSQLStatement virtual void accept( Visitor& v ) const override { v.visit( *this ); } virtual Node* clone() const override; - /** Clone with same type return */ + //! Clone with same type return NodeTableDef* cloneThis() const; protected: @@ -576,22 +576,22 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeJoin : public Node { public: - /** Constructor with table definition, ON expression */ + //! Constructor with table definition, ON expression NodeJoin( NodeTableDef* tabledef, Node* onExpr, JoinType type ) : mTableDef( tabledef ), mOnExpr( onExpr ), mType( type ) {} - /** Constructor with table definition and USING columns */ + //! Constructor with table definition and USING columns NodeJoin( NodeTableDef* tabledef, const QList& usingColumns, JoinType type ) : mTableDef( tabledef ), mOnExpr( nullptr ), mUsingColumns( usingColumns ), mType( type ) {} virtual ~NodeJoin() { delete mTableDef; delete mOnExpr; } - /** Table definition */ + //! Table definition NodeTableDef* tableDef() const { return mTableDef; } - /** On expression. Will be nullptr if usingColumns() is not empty */ + //! On expression. Will be nullptr if usingColumns() is not empty Node* onExpr() const { return mOnExpr; } - /** Columns referenced by USING */ + //! Columns referenced by USING QList usingColumns() const { return mUsingColumns; } - /** Join type */ + //! Join type JoinType type() const { return mType; } virtual NodeType nodeType() const override { return ntJoin; } @@ -599,7 +599,7 @@ class CORE_EXPORT QgsSQLStatement virtual void accept( Visitor& v ) const override { v.visit( *this ); } virtual Node* clone() const override; - /** Clone with same type return */ + //! Clone with same type return NodeJoin* cloneThis() const; protected: @@ -614,14 +614,14 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeColumnSorted : public Node { public: - /** Constructor */ + //! Constructor NodeColumnSorted( NodeColumnRef* column, bool asc ) : mColumn( column ), mAsc( asc ) {} ~NodeColumnSorted() { delete mColumn; } - /** The name of the column. */ + //! The name of the column. NodeColumnRef* column() const { return mColumn; } - /** Whether the column is sorted in ascending order */ + //! Whether the column is sorted in ascending order bool ascending() const { return mAsc; } virtual NodeType nodeType() const override { return ntColumnSorted; } @@ -629,7 +629,7 @@ class CORE_EXPORT QgsSQLStatement virtual void accept( Visitor& v ) const override { v.visit( *this ); } virtual Node* clone() const override; - /** Clone with same type return */ + //! Clone with same type return NodeColumnSorted* cloneThis() const; protected: @@ -642,30 +642,30 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT NodeSelect : public Node { public: - /** Constructor */ + //! Constructor NodeSelect( const QList& tableList, const QList& columns, bool distinct ) : mTableList( tableList ), mColumns( columns ), mDistinct( distinct ), mWhere( nullptr ) {} virtual ~NodeSelect() { qDeleteAll( mTableList ); qDeleteAll( mColumns ); qDeleteAll( mJoins ); delete mWhere; qDeleteAll( mOrderBy ); } - /** Set joins */ + //! Set joins void setJoins( const QList& joins ) { qDeleteAll( mJoins ); mJoins = joins; } - /** Append a join */ + //! Append a join void appendJoin( NodeJoin* join ) { mJoins.append( join ); } - /** Set where clause */ + //! Set where clause void setWhere( Node* where ) { delete mWhere; mWhere = where; } - /** Set order by columns */ + //! Set order by columns void setOrderBy( const QList& orderBy ) { qDeleteAll( mOrderBy ); mOrderBy = orderBy; } - /** Return the list of tables */ + //! Return the list of tables QList tables() const { return mTableList; } - /** Return the list of columns */ + //! Return the list of columns QList columns() const { return mColumns; } - /** Return if the SELECT is DISTINCT */ + //! Return if the SELECT is DISTINCT bool distinct() const { return mDistinct; } - /** Return the list of joins */ + //! Return the list of joins QList joins() const { return mJoins; } - /** Return the where clause */ + //! Return the where clause Node* where() const { return mWhere; } - /** Return the list of order by columns */ + //! Return the list of order by columns QList orderBy() const { return mOrderBy; } virtual NodeType nodeType() const override { return ntSelect; } @@ -692,31 +692,31 @@ class CORE_EXPORT QgsSQLStatement { public: virtual ~Visitor() {} - /** Visit NodeUnaryOperator */ + //! Visit NodeUnaryOperator virtual void visit( const NodeUnaryOperator& n ) = 0; - /** Visit NodeBinaryOperator */ + //! Visit NodeBinaryOperator virtual void visit( const NodeBinaryOperator& n ) = 0; - /** Visit NodeInOperator */ + //! Visit NodeInOperator virtual void visit( const NodeInOperator& n ) = 0; - /** Visit NodeBetweenOperator */ + //! Visit NodeBetweenOperator virtual void visit( const NodeBetweenOperator& n ) = 0; - /** Visit NodeFunction */ + //! Visit NodeFunction virtual void visit( const NodeFunction& n ) = 0; - /** Visit NodeLiteral */ + //! Visit NodeLiteral virtual void visit( const NodeLiteral& n ) = 0; - /** Visit NodeColumnRef */ + //! Visit NodeColumnRef virtual void visit( const NodeColumnRef& n ) = 0; - /** Visit NodeSelectedColumn */ + //! Visit NodeSelectedColumn virtual void visit( const NodeSelectedColumn& n ) = 0; - /** Visit NodeTableDef */ + //! Visit NodeTableDef virtual void visit( const NodeTableDef& n ) = 0; - /** Visit NodeSelect */ + //! Visit NodeSelect virtual void visit( const NodeSelect& n ) = 0; - /** Visit NodeJoin */ + //! Visit NodeJoin virtual void visit( const NodeJoin& n ) = 0; - /** Visit NodeColumnSorted */ + //! Visit NodeColumnSorted virtual void visit( const NodeColumnSorted& n ) = 0; - /** Visit NodeCast */ + //! Visit NodeCast virtual void visit( const NodeCast& n ) = 0; }; @@ -725,7 +725,7 @@ class CORE_EXPORT QgsSQLStatement class CORE_EXPORT RecursiveVisitor: public QgsSQLStatement::Visitor { public: - /** Constructor */ + //! Constructor RecursiveVisitor() {} void visit( const QgsSQLStatement::NodeUnaryOperator& n ) override { n.operand()->accept( *this ); } @@ -743,7 +743,7 @@ class CORE_EXPORT QgsSQLStatement void visit( const QgsSQLStatement::NodeCast& n ) override { n.node()->accept( *this ); } }; - /** Entry function for the visitor pattern */ + //! Entry function for the visitor pattern void acceptVisitor( Visitor& v ) const; protected: diff --git a/src/core/qgstextlabelfeature.h b/src/core/qgstextlabelfeature.h index 647d4376cb1..59db97bcf0f 100644 --- a/src/core/qgstextlabelfeature.h +++ b/src/core/qgstextlabelfeature.h @@ -61,7 +61,7 @@ class QgsTextLabelFeature : public QgsLabelFeature QFont mDefinedFont; //! Metrics of the font for rendering QFontMetricsF* mFontMetrics; - /** Stores attribute values for data defined properties*/ + //! Stores attribute values for data defined properties QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > mDataDefinedValues; }; diff --git a/src/core/qgstextrenderer.h b/src/core/qgstextrenderer.h index d36b266f18a..9c3da97b6b9 100644 --- a/src/core/qgstextrenderer.h +++ b/src/core/qgstextrenderer.h @@ -210,29 +210,29 @@ class CORE_EXPORT QgsTextBackgroundSettings */ enum ShapeType { - ShapeRectangle = 0, /*!< rectangle */ - ShapeSquare, /*!< square - buffered sizes only*/ - ShapeEllipse, /*!< ellipse */ - ShapeCircle, /*!< circle */ - ShapeSVG /*!< SVG file */ + ShapeRectangle = 0, //!< Rectangle + ShapeSquare, //!< Square - buffered sizes only + ShapeEllipse, //!< Ellipse + ShapeCircle, //!< Circle + ShapeSVG //!< SVG file }; /** Methods for determining the background shape size. */ enum SizeType { - SizeBuffer = 0, /*!< shape size is determined by adding a buffer margin around text */ - SizeFixed, /*!< fixed size */ - SizePercent /*!< shape size is determined by percent of text size */ + SizeBuffer = 0, //!< Shape size is determined by adding a buffer margin around text + SizeFixed, //!< Fixed size + SizePercent //!< Shape size is determined by percent of text size }; /** Methods for determining the rotation of the background shape. */ enum RotationType { - RotationSync = 0, /*!< shape rotation is synced with text rotation */ - RotationOffset, /*!< shape rotation is offset from text rotation */ - RotationFixed /*!< shape rotation is a fixed angle */ + RotationSync = 0, //!< Shape rotation is synced with text rotation + RotationOffset, //!< Shape rotation is offset from text rotation + RotationFixed //!< Shape rotation is a fixed angle }; QgsTextBackgroundSettings(); @@ -605,10 +605,10 @@ class CORE_EXPORT QgsTextShadowSettings */ enum ShadowPlacement { - ShadowLowest = 0, /*!< draw shadow below all text components */ - ShadowText, /*!< draw shadow under text */ - ShadowBuffer, /*!< draw shadow under buffer */ - ShadowShape /*!< draw shadow under background shape */ + ShadowLowest = 0, //!< Draw shadow below all text components + ShadowText, //!< Draw shadow under text + ShadowBuffer, //!< Draw shadow under buffer + ShadowShape //!< Draw shadow under background shape }; QgsTextShadowSettings(); diff --git a/src/core/qgstolerance.h b/src/core/qgstolerance.h index 48d1034717a..5091f9c4ab3 100644 --- a/src/core/qgstolerance.h +++ b/src/core/qgstolerance.h @@ -33,11 +33,11 @@ class CORE_EXPORT QgsTolerance * For map (project) units, use ProjectUnits.*/ enum UnitType { - /** Layer unit value */ + //! Layer unit value LayerUnits, - /** Pixels unit of tolerance*/ + //! Pixels unit of tolerance Pixels, - /** Map (project) units. Added in 2.8 */ + //! Map (project) units. Added in 2.8 ProjectUnits }; diff --git a/src/core/qgstracer.cpp b/src/core/qgstracer.cpp index 92578e88050..624db76a8ed 100644 --- a/src/core/qgstracer.cpp +++ b/src/core/qgstracer.cpp @@ -87,7 +87,7 @@ double closestSegment( const QgsPolyline& pl, const QgsPoint& pt, int& vertexAft ///// -/** Simple graph structure for shortest path search */ +//! Simple graph structure for shortest path search struct QgsTracerGraph { QgsTracerGraph() : joinedVertices( 0 ) {} diff --git a/src/core/qgstransaction.h b/src/core/qgstransaction.h index 570049f4733..4d63908a606 100644 --- a/src/core/qgstransaction.h +++ b/src/core/qgstransaction.h @@ -51,7 +51,7 @@ class CORE_EXPORT QgsTransaction : public QObject Q_OBJECT public: - /** Creates a transaction for the specified connection string and provider */ + //! Creates a transaction for the specified connection string and provider static QgsTransaction* create( const QString& connString, const QString& providerKey ); /** Creates a transaction which includes the specified layers. Connection string @@ -60,10 +60,10 @@ class CORE_EXPORT QgsTransaction : public QObject virtual ~QgsTransaction(); - /** Add layer to the transaction. The layer must not be in edit mode.*/ + //! Add layer to the transaction. The layer must not be in edit mode. bool addLayer( const QString& layerId ); - /** Add layer to the transaction. The layer must not be in edit mode.*/ + //! Add layer to the transaction. The layer must not be in edit mode. bool addLayer( QgsVectorLayer* layer ); /** Begin transaction @@ -76,13 +76,13 @@ class CORE_EXPORT QgsTransaction : public QObject * Some providers might not honour the statement timeout. */ bool begin( QString& errorMsg, int statementTimeout = 20 ); - /** Commit transaction. */ + //! Commit transaction. bool commit( QString& errorMsg ); - /** Roll back transaction. */ + //! Roll back transaction. bool rollback( QString& errorMsg ); - /** Executes sql */ + //! Executes sql virtual bool executeSql( const QString& sql, QString& error ) = 0; /** diff --git a/src/core/qgsunittypes.h b/src/core/qgsunittypes.h index 034aa2c0acf..00dc9a0ebc1 100644 --- a/src/core/qgsunittypes.h +++ b/src/core/qgsunittypes.h @@ -41,61 +41,61 @@ class CORE_EXPORT QgsUnitTypes //! Units of distance enum DistanceUnit { - DistanceMeters = 0, /*!< meters */ - DistanceKilometers, /*!< kilometers */ - DistanceFeet, /*!< imperial feet */ - DistanceNauticalMiles, /*!< nautical miles */ - DistanceYards, /*!< imperial yards */ - DistanceMiles, /*!< terrestial miles */ - DistanceDegrees, /*!< degrees, for planar geographic CRS distance measurements */ - DistanceUnknownUnit, /*!< unknown distance unit */ + DistanceMeters = 0, //!< Meters + DistanceKilometers, //!< Kilometers + DistanceFeet, //!< Imperial feet + DistanceNauticalMiles, //!< Nautical miles + DistanceYards, //!< Imperial yards + DistanceMiles, //!< Terrestial miles + DistanceDegrees, //!< Degrees, for planar geographic CRS distance measurements + DistanceUnknownUnit, //!< Unknown distance unit }; /** Types of distance units */ enum DistanceUnitType { - Standard = 0, /*!< unit is a standard measurement unit */ - Geographic, /*!< unit is a geographic (eg degree based) unit */ - UnknownType, /*!< unknown unit type */ + Standard = 0, //!< Unit is a standard measurement unit + Geographic, //!< Unit is a geographic (eg degree based) unit + UnknownType, //!< Unknown unit type }; //! Units of area enum AreaUnit { - AreaSquareMeters = 0, /*!< square meters */ - AreaSquareKilometers, /*!< square kilometers */ - AreaSquareFeet, /*!< square feet */ - AreaSquareYards, /*!< square yards */ - AreaSquareMiles, /*!< square miles */ - AreaHectares, /*!< hectares */ - AreaAcres, /*!< acres */ - AreaSquareNauticalMiles, /*!< square nautical miles */ - AreaSquareDegrees, /*!< square degrees, for planar geographic CRS area measurements */ - AreaUnknownUnit, /*!< unknown areal unit */ + AreaSquareMeters = 0, //!< Square meters + AreaSquareKilometers, //!< Square kilometers + AreaSquareFeet, //!< Square feet + AreaSquareYards, //!< Square yards + AreaSquareMiles, //!< Square miles + AreaHectares, //!< Hectares + AreaAcres, //!< Acres + AreaSquareNauticalMiles, //!< Square nautical miles + AreaSquareDegrees, //!< Square degrees, for planar geographic CRS area measurements + AreaUnknownUnit, //!< Unknown areal unit }; //! Units of angles enum AngleUnit { - AngleDegrees = 0, /*!< degrees */ - AngleRadians, /*!< square kilometers */ - AngleGon, /*!< gon/gradian */ - AngleMinutesOfArc, /*!< minutes of arc */ - AngleSecondsOfArc, /*!< seconds of arc */ - AngleTurn, /*!< turn/revolutions */ - AngleUnknownUnit, /*!< unknown angle unit */ + AngleDegrees = 0, //!< Degrees + AngleRadians, //!< Square kilometers + AngleGon, //!< Gon/gradian + AngleMinutesOfArc, //!< Minutes of arc + AngleSecondsOfArc, //!< Seconds of arc + AngleTurn, //!< Turn/revolutions + AngleUnknownUnit, //!< Unknown angle unit }; //! Rendering size units enum RenderUnit { - RenderMillimeters = 0, //!< millimeters - RenderMapUnits, //!< map units - RenderPixels, //!< pixels - RenderPercentage, //!< percentage of another measurement (eg canvas size, feature size) + RenderMillimeters = 0, //!< Millimeters + RenderMapUnits, //!< Map units + RenderPixels, //!< Pixels + RenderPercentage, //!< Percentage of another measurement (eg canvas size, feature size) RenderPoints, //! points (eg for font sizes) - RenderUnknownUnit, //!< mixed or unknown units + RenderUnknownUnit, //!< Mixed or unknown units }; //! List of render units diff --git a/src/core/qgsvectordataprovider.h b/src/core/qgsvectordataprovider.h index c172f248683..bb5c967ab81 100644 --- a/src/core/qgsvectordataprovider.h +++ b/src/core/qgsvectordataprovider.h @@ -61,47 +61,47 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider */ enum Capability { - /** Provider has no capabilities */ + //! Provider has no capabilities NoCapabilities = 0, - /** Allows adding features */ + //! Allows adding features AddFeatures = 1, - /** Allows deletion of features */ + //! Allows deletion of features DeleteFeatures = 1 << 1, - /** Allows modification of attribute values */ + //! Allows modification of attribute values ChangeAttributeValues = 1 << 2, - /** Allows addition of new attributes (fields) */ + //! Allows addition of new attributes (fields) AddAttributes = 1 << 3, - /** Allows deletion of attributes (fields) */ + //! Allows deletion of attributes (fields) DeleteAttributes = 1 << 4, - /** Allows creation of spatial index */ + //! Allows creation of spatial index CreateSpatialIndex = 1 << 6, - /** Fast access to features using their ID */ + //! Fast access to features using their ID SelectAtId = 1 << 7, - /** Allows modifications of geometries */ + //! Allows modifications of geometries ChangeGeometries = 1 << 8, - /** Allows user to select encoding */ + //! Allows user to select encoding SelectEncoding = 1 << 13, - /** Can create indexes on provider's fields */ + //! Can create indexes on provider's fields CreateAttributeIndex = 1 << 12, - /** Supports simplification of geometries on provider side according to a distance tolerance */ + //! Supports simplification of geometries on provider side according to a distance tolerance SimplifyGeometries = 1 << 14, - /** Supports topological simplification of geometries on provider side according to a distance tolerance */ + //! Supports topological simplification of geometries on provider side according to a distance tolerance SimplifyGeometriesWithTopologicalValidation = 1 << 15, - /** Supports transactions*/ + //! Supports transactions TransactionSupport = 1 << 16, - /** Supports circular geometry types (circularstring, compoundcurve, curvepolygon)*/ + //! Supports circular geometry types (circularstring, compoundcurve, curvepolygon) CircularGeometries = 1 << 17, /** Supports joint updates for attributes and geometry * Providers supporting this should still define ChangeGeometries | ChangeAttributeValues */ ChangeFeatures = 1 << 18, - /** Supports renaming attributes (fields). Added in QGIS 2.16 */ + //! Supports renaming attributes (fields). Added in QGIS 2.16 RenameAttributes = 1 << 19, }; Q_DECLARE_FLAGS( Capabilities, Capability ) - /** Bitmask of all provider's editing capabilities */ + //! Bitmask of all provider's editing capabilities const static int EditingCapabilities = AddFeatures | DeleteFeatures | ChangeAttributeValues | ChangeGeometries | AddAttributes | DeleteAttributes | RenameAttributes; @@ -296,7 +296,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider */ virtual bool createSpatialIndex(); - /** Create an attribute index on the datasource*/ + //! Create an attribute index on the datasource virtual bool createAttributeIndex( int field ); /** Returns flags containing the supported capabilities @@ -385,7 +385,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider */ virtual bool doesStrictFeatureTypeCheck() const { return true;} - /** Returns a list of available encodings */ + //! Returns a list of available encodings static QStringList availableEncodings(); /** @@ -495,19 +495,19 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider mutable bool mCacheMinMaxDirty; mutable QMap mCacheMinValues, mCacheMaxValues; - /** Encoding */ + //! Encoding QTextCodec* mEncoding; - /** List of attribute indices to fetch with nextFeature calls*/ + //! List of attribute indices to fetch with nextFeature calls QgsAttributeList mAttributesToFetch; - /** The names of the providers native types*/ + //! The names of the providers native types QList< NativeType > mNativeTypes; - /** Old notation **/ + //! Old notation * QMap mOldTypeList; - /** List of errors */ + //! List of errors mutable QStringList mErrors; static QStringList smEncodings; diff --git a/src/core/qgsvectorfilewriter.h b/src/core/qgsvectorfilewriter.h index af9f44ac6f4..0780a15f360 100644 --- a/src/core/qgsvectorfilewriter.h +++ b/src/core/qgsvectorfilewriter.h @@ -148,7 +148,7 @@ class CORE_EXPORT QgsVectorFileWriter QString ext; QMap driverOptions; QMap layerOptions; - /** Some formats require a compulsory encoding, typically UTF-8. If no compulsory encoding, empty string */ + //! Some formats require a compulsory encoding, typically UTF-8. If no compulsory encoding, empty string QString compulsoryEncoding; }; @@ -179,10 +179,10 @@ class CORE_EXPORT QgsVectorFileWriter class CORE_EXPORT FieldValueConverter { public: - /** Constructor */ + //! Constructor FieldValueConverter(); - /** Destructor */ + //! Destructor virtual ~FieldValueConverter(); /** Return a possibly modified field definition. Default implementation will return provided field unmodified. @@ -203,16 +203,16 @@ class CORE_EXPORT QgsVectorFileWriter * @note Added in QGIS 3.0 */ enum EditionCapability { - /** Flag to indicate that a new layer can be added to the dataset */ + //! Flag to indicate that a new layer can be added to the dataset CanAddNewLayer = 1 << 0, - /** Flag to indicate that new features can be added to an existing layer */ + //! Flag to indicate that new features can be added to an existing layer CanAppendToExistingLayer = 1 << 1, - /** Flag to indicate that new fields can be added to an existing layer. Imply CanAppendToExistingLayer */ + //! Flag to indicate that new fields can be added to an existing layer. Imply CanAppendToExistingLayer CanAddNewFieldsToExistingLayer = 1 << 2, - /** Flag to indicate that an existing layer can be deleted */ + //! Flag to indicate that an existing layer can be deleted CanDeleteLayer = 1 << 3 }; @@ -225,16 +225,16 @@ class CORE_EXPORT QgsVectorFileWriter */ typedef enum { - /** Create or overwrite file */ + //! Create or overwrite file CreateOrOverwriteFile, - /** Create or overwrite layer */ + //! Create or overwrite layer CreateOrOverwriteLayer, - /** Append features to existing layer, but do not create new fields */ + //! Append features to existing layer, but do not create new fields AppendToLayerNoNewFields, - /** Append features to existing layer, and create new fields if needed */ + //! Append features to existing layer, and create new fields if needed AppendToLayerAddFields } ActionOnExistingFile; @@ -334,63 +334,63 @@ class CORE_EXPORT QgsVectorFileWriter class CORE_EXPORT SaveVectorOptions { public: - /** Constructor */ + //! Constructor SaveVectorOptions(); - /** Destructor */ + //! Destructor virtual ~SaveVectorOptions(); - /** OGR driver to use */ + //! OGR driver to use QString driverName; - /** Layer name. If let empty, it will be derived from the filename */ + //! Layer name. If let empty, it will be derived from the filename QString layerName; - /** Action on existing file */ + //! Action on existing file ActionOnExistingFile actionOnExistingFile; - /** Encoding to use */ + //! Encoding to use QString fileEncoding; /** Transform to reproject exported geometries with, or invalid transform * for no transformation */ QgsCoordinateTransform ct; - /** Write only selected features of layer */ + //! Write only selected features of layer bool onlySelectedFeatures; - /** List of OGR data source creation options */ + //! List of OGR data source creation options QStringList datasourceOptions; - /** List of OGR layer creation options */ + //! List of OGR layer creation options QStringList layerOptions; - /** Only write geometries */ + //! Only write geometries bool skipAttributeCreation; - /** Attributes to export (empty means all unless skipAttributeCreation is set) */ + //! Attributes to export (empty means all unless skipAttributeCreation is set) QgsAttributeList attributes; - /** Symbology to export */ + //! Symbology to export SymbologyExport symbologyExport; - /** Scale of symbology */ + //! Scale of symbology double symbologyScale; - /** If not empty, only features intersecting the extent will be saved */ + //! If not empty, only features intersecting the extent will be saved QgsRectangle filterExtent; /** Set to a valid geometry type to override the default geometry type for the layer. This parameter * allows for conversion of geometryless tables to null geometries, etc */ QgsWkbTypes::Type overrideGeometryType; - /** Set to true to force creation of multi* geometries */ + //! Set to true to force creation of multi* geometries bool forceMulti; - /** Set to true to include z dimension in output. This option is only valid if overrideGeometryType is set */ + //! Set to true to include z dimension in output. This option is only valid if overrideGeometryType is set bool includeZ; - /** Field value converter */ + //! Field value converter FieldValueConverter* fieldValueConverter; }; @@ -408,7 +408,7 @@ class CORE_EXPORT QgsVectorFileWriter QString *newFilename = nullptr, QString *errorMessage = nullptr ); - /** Create a new vector file writer */ + //! Create a new vector file writer QgsVectorFileWriter( const QString& vectorFileName, const QString& fileEncoding, const QgsFields& fields, @@ -421,7 +421,7 @@ class CORE_EXPORT QgsVectorFileWriter SymbologyExport symbologyExport = NoSymbology ); - /** Returns map with format filter string as key and OGR format key as value*/ + //! Returns map with format filter string as key and OGR format key as value static QMap< QString, QString> supportedFiltersAndFormats(); /** Returns driver list that can be used for dialogs. It contains all OGR drivers @@ -430,28 +430,28 @@ class CORE_EXPORT QgsVectorFileWriter */ static QMap< QString, QString> ogrDriverList(); - /** Returns filter string that can be used for dialogs*/ + //! Returns filter string that can be used for dialogs static QString fileFilterString(); - /** Creates a filter for an OGR driver key*/ + //! Creates a filter for an OGR driver key static QString filterForDriver( const QString& driverName ); - /** Converts codec name to string passed to ENCODING layer creation option of OGR Shapefile*/ + //! Converts codec name to string passed to ENCODING layer creation option of OGR Shapefile static QString convertCodecNameForEncodingOption( const QString &codecName ); - /** Checks whether there were any errors in constructor */ + //! Checks whether there were any errors in constructor WriterError hasError(); - /** Retrieves error message */ + //! Retrieves error message QString errorMessage(); - /** Add feature to the currently opened data source */ + //! Add feature to the currently opened data source bool addFeature( QgsFeature& feature, QgsFeatureRenderer* renderer = nullptr, QgsUnitTypes::DistanceUnit outputUnit = QgsUnitTypes::DistanceMeters ); //! @note not available in python bindings QMap attrIdxToOgrIdx() { return mAttrIdxToOgrIdx; } - /** Close opened shapefile for writing */ + //! Close opened shapefile for writing ~QgsVectorFileWriter(); /** Delete a shapefile (and its accompanying shx / dbf / prf) @@ -523,16 +523,16 @@ class CORE_EXPORT QgsVectorFileWriter QgsFields mFields; - /** Contains error value if construction was not successful */ + //! Contains error value if construction was not successful WriterError mError; QString mErrorMessage; QTextCodec *mCodec; - /** Geometry type which is being used */ + //! Geometry type which is being used QgsWkbTypes::Type mWkbType; - /** Map attribute indizes to OGR field indexes */ + //! Map attribute indizes to OGR field indexes QMap mAttrIdxToOgrIdx; SymbologyExport mSymbologyExport; @@ -541,12 +541,12 @@ class CORE_EXPORT QgsVectorFileWriter QMap< QgsSymbolLayer*, QString > mSymbolLayerTable; #endif - /** Scale for symbology export (e.g. for symbols units in map units)*/ + //! Scale for symbology export (e.g. for symbols units in map units) double mSymbologyScaleDenominator; QString mOgrDriverName; - /** Field value converter */ + //! Field value converter FieldValueConverter* mFieldValueConverter; private: @@ -597,7 +597,7 @@ class CORE_EXPORT QgsVectorFileWriter OGRFeatureH createFeature( const QgsFeature& feature ); bool writeFeature( OGRLayerH layer, OGRFeatureH feature ); - /** Writes features considering symbol level order*/ + //! Writes features considering symbol level order WriterError exportFeaturesSymbolLevels( QgsVectorLayer* layer, QgsFeatureIterator& fit, const QgsCoordinateTransform& ct, QString* errorMessage = nullptr ); double mmScaleFactor( double scaleDenominator, QgsUnitTypes::RenderUnit symbolUnits, QgsUnitTypes::DistanceUnit mapUnits ); double mapUnitScaleFactor( double scaleDenominator, QgsUnitTypes::RenderUnit symbolUnits, QgsUnitTypes::DistanceUnit mapUnits ); @@ -605,7 +605,7 @@ class CORE_EXPORT QgsVectorFileWriter void startRender( QgsVectorLayer* vl ); void stopRender( QgsVectorLayer* vl ); QgsFeatureRenderer* symbologyRenderer( QgsVectorLayer* vl ) const; - /** Adds attributes needed for classification*/ + //! Adds attributes needed for classification void addRendererAttributes( QgsVectorLayer* vl, QgsAttributeList& attList ); static QMap sDriverMetadata; diff --git a/src/core/qgsvectorlayer.cpp b/src/core/qgsvectorlayer.cpp index f1b78711cae..86e173d3f11 100644 --- a/src/core/qgsvectorlayer.cpp +++ b/src/core/qgsvectorlayer.cpp @@ -638,7 +638,7 @@ class QgsVectorLayerInterruptionCheckerDuringCountSymbolFeatures: public QgsInte { public: - /** Constructor */ + //! Constructor explicit QgsVectorLayerInterruptionCheckerDuringCountSymbolFeatures( QProgressDialog* dialog ) : mDialog( dialog ) { @@ -3407,7 +3407,7 @@ QList QgsVectorLayer::getDoubleValues( const QString &fieldOrExpression, } -/** Write blend mode for features */ +//! Write blend mode for features void QgsVectorLayer::setFeatureBlendMode( QPainter::CompositionMode featureBlendMode ) { mFeatureBlendMode = featureBlendMode; @@ -3415,13 +3415,13 @@ void QgsVectorLayer::setFeatureBlendMode( QPainter::CompositionMode featureBlend emit styleChanged(); } -/** Read blend mode for layer */ +//! Read blend mode for layer QPainter::CompositionMode QgsVectorLayer::featureBlendMode() const { return mFeatureBlendMode; } -/** Write transparency for layer */ +//! Write transparency for layer void QgsVectorLayer::setLayerTransparency( int layerTransparency ) { mLayerTransparency = layerTransparency; @@ -3429,7 +3429,7 @@ void QgsVectorLayer::setLayerTransparency( int layerTransparency ) emit styleChanged(); } -/** Read transparency for layer */ +//! Read transparency for layer int QgsVectorLayer::layerTransparency() const { return mLayerTransparency; diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h index 3e87a374930..08085b50fef 100644 --- a/src/core/qgsvectorlayer.h +++ b/src/core/qgsvectorlayer.h @@ -83,15 +83,15 @@ struct CORE_EXPORT QgsVectorJoinInfo , joinFieldIndex( -1 ) {} - /** Join field in the target layer*/ + //! Join field in the target layer QString targetFieldName; - /** Source layer*/ + //! Source layer QString joinLayerId; - /** Join field in the source layer*/ + //! Join field in the source layer QString joinFieldName; - /** True if the join is cached in virtual memory*/ + //! True if the join is cached in virtual memory bool memoryCache; - /** True if the cached join attributes need to be updated*/ + //! True if the cached join attributes need to be updated bool cacheDirty; /** Cache for joined attributes to provide fast lookup (size is 0 if no memory caching) @@ -99,9 +99,9 @@ struct CORE_EXPORT QgsVectorJoinInfo */ QHash< QString, QgsAttributes> cachedAttributes; - /** Join field index in the target layer. For backward compatibility with 1.x (x>=7)*/ + //! Join field index in the target layer. For backward compatibility with 1.x (x>=7) int targetFieldIndex; - /** Join field index in the source layer. For backward compatibility with 1.x (x>=7)*/ + //! Join field index in the source layer. For backward compatibility with 1.x (x>=7) int joinFieldIndex; /** An optional prefix. If it is a Null string "{layername}_" will be used @@ -127,7 +127,7 @@ struct CORE_EXPORT QgsVectorJoinInfo QStringList* joinFieldNamesSubset() const { return joinFieldsSubset.data(); } protected: - /** Subset of fields to use from joined layer. null = use all fields*/ + //! Subset of fields to use from joined layer. null = use all fields QSharedPointer joinFieldsSubset; }; @@ -420,20 +420,20 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte //! Result of an edit operation enum EditResult { - Success = 0, /**< Edit operation was successful */ - EmptyGeometry = 1, /**< Edit operation resulted in an empty geometry */ - EditFailed = 2, /**< Edit operation failed */ - FetchFeatureFailed = 3, /**< Unable to fetch requested feature */ - InvalidLayer = 4, /**< Edit failed due to invalid layer */ + Success = 0, //!< Edit operation was successful + EmptyGeometry = 1, //!< Edit operation resulted in an empty geometry + EditFailed = 2, //!< Edit operation failed + FetchFeatureFailed = 3, //!< Unable to fetch requested feature + InvalidLayer = 4, //!< Edit failed due to invalid layer }; //! Selection behaviour enum SelectBehaviour { - SetSelection, /**< Set selection, removing any existing selection */ - AddToSelection, /**< Add selection to current selection */ - IntersectSelection, /**< Modify current selection to include only select features which match */ - RemoveFromSelection, /**< Remove from current selection */ + SetSelection, //!< Set selection, removing any existing selection + AddToSelection, //!< Add selection to current selection + IntersectSelection, //!< Modify current selection to include only select features which match + RemoveFromSelection, //!< Remove from current selection }; /** Constructor - creates a vector layer @@ -452,16 +452,16 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QgsVectorLayer( const QString& path = QString::null, const QString& baseName = QString::null, const QString& providerLib = QString::null, bool loadDefaultStyleFlag = true ); - /** Destructor */ + //! Destructor virtual ~QgsVectorLayer(); - /** Returns the permanent storage type for this layer as a friendly name. */ + //! Returns the permanent storage type for this layer as a friendly name. QString storageType() const; - /** Capabilities for this layer in a friendly format. */ + //! Capabilities for this layer in a friendly format. QString capabilitiesString() const; - /** Returns a comment for the data in the layer */ + //! Returns a comment for the data in the layer QString dataComment() const; /** @@ -489,7 +489,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ QString displayExpression() const; - /** Returns the data provider */ + //! Returns the data provider QgsVectorDataProvider* dataProvider(); /** Returns the data provider in a const-correct manner @@ -497,10 +497,10 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ const QgsVectorDataProvider* dataProvider() const; - /** Sets the textencoding of the data provider */ + //! Sets the textencoding of the data provider void setProviderEncoding( const QString& encoding ); - /** Setup the coordinate system transformation for the layer */ + //! Setup the coordinate system transformation for the layer void setCoordinateSystem(); /** Joins another vector layer to this layer @@ -642,13 +642,13 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void modifySelection( const QgsFeatureIds& selectIds, const QgsFeatureIds &deselectIds ); - /** Select not selected features and deselect selected ones */ + //! Select not selected features and deselect selected ones void invertSelection(); - /** Select all the features */ + //! Select all the features void selectAll(); - /** Get all feature Ids */ + //! Get all feature Ids QgsFeatureIds allFeatureIds() const; /** @@ -691,7 +691,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ const QgsFeatureIds &selectedFeaturesIds() const; - /** Returns the bounding box of the selected features. If there is no selection, QgsRectangle(0,0,0,0) is returned */ + //! Returns the bounding box of the selected features. If there is no selection, QgsRectangle(0,0,0,0) is returned QgsRectangle boundingBoxOfSelected() const; /** Returns whether the layer contains labels which are enabled and should be drawn. @@ -706,14 +706,14 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool diagramsEnabled() const; - /** Sets diagram rendering object (takes ownership) */ + //! Sets diagram rendering object (takes ownership) void setDiagramRenderer( QgsDiagramRenderer* r ); const QgsDiagramRenderer* diagramRenderer() const { return mDiagramRenderer; } void setDiagramLayerSettings( const QgsDiagramLayerSettings& s ); const QgsDiagramLayerSettings *diagramLayerSettings() const { return mDiagramLayerSettings; } - /** Return renderer. */ + //! Return renderer. QgsFeatureRenderer* renderer() { return mRenderer; } /** Return const renderer. @@ -727,16 +727,16 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void setRenderer( QgsFeatureRenderer* r ); - /** Returns point, line or polygon */ + //! Returns point, line or polygon QgsWkbTypes::GeometryType geometryType() const; - /** Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeometry */ + //! Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeometry bool hasGeometryType() const; - /** Returns the WKBType or WKBUnknown in case of error*/ + //! Returns the WKBType or WKBUnknown in case of error QgsWkbTypes::Type wkbType() const; - /** Return the provider type for this layer */ + //! Return the provider type for this layer QString providerType() const; /** Reads vector layer specific state from project file Dom node. @@ -1088,12 +1088,12 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void setLabeling( QgsAbstractVectorLayerLabeling* labeling ); - /** Returns true if the provider is in editing mode */ + //! Returns true if the provider is in editing mode virtual bool isEditable() const override; virtual bool isSpatial() const override; - /** Returns true if the provider has been modified since the last commit */ + //! Returns true if the provider has been modified since the last commit virtual bool isModified() const; /** Snaps a point to the closest vertex if there is one within the snapping tolerance @@ -1116,7 +1116,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QMultiMap < double, QgsSnappingResult > &snappingResults, QgsSnapper::SnappingType snap_to ); - /** Synchronises with changes in the datasource */ + //! Synchronises with changes in the datasource virtual void reload() override; /** Return new instance of QgsMapLayerRenderer that will be used for rendering of given context @@ -1124,7 +1124,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ virtual QgsMapLayerRenderer* createMapRenderer( QgsRenderContext& rendererContext ) override; - /** Return the extent of the layer */ + //! Return the extent of the layer QgsRectangle extent() const override; /** @@ -1162,7 +1162,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ inline QgsAttributeList pendingPkAttributesList() const { return pkAttributeList(); } - /** Returns list of attributes making up the primary key */ + //! Returns list of attributes making up the primary key QgsAttributeList pkAttributeList() const; /** @@ -1182,7 +1182,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool setReadOnly( bool readonly = true ); - /** Change feature's geometry */ + //! Change feature's geometry bool changeGeometry( QgsFeatureId fid, const QgsGeometry& geom ); /** @@ -1231,7 +1231,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ QString attributeAlias( int index ) const; - /** Convenience function that returns the attribute alias if defined or the field name else */ + //! Convenience function that returns the attribute alias if defined or the field name else QString attributeDisplayName( int index ) const; //! Returns a map of field name to attribute alias @@ -1256,7 +1256,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void setExcludeAttributesWfs( const QSet& att ) { mExcludeAttributesWFS = att; } - /** Delete an attribute field (but does not commit it) */ + //! Delete an attribute field (but does not commit it) bool deleteAttribute( int attr ); /** @@ -1268,10 +1268,10 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool deleteAttributes( QList attrs ); - /** Insert a copy of the given features into the layer (but does not commit it) */ + //! Insert a copy of the given features into the layer (but does not commit it) bool addFeatures( QgsFeatureList features, bool makeSelected = true ); - /** Delete a feature from the layer (but does not commit it) */ + //! Delete a feature from the layer (but does not commit it) bool deleteFeature( QgsFeatureId fid ); /** @@ -1312,10 +1312,10 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool rollBack( bool deleteBuffer = true ); - /** Get annotation form */ + //! Get annotation form QString annotationForm() const { return mAnnotationForm; } - /** Set annotation form for layer */ + //! Set annotation form for layer void setAnnotationForm( const QString& ui ); /** @@ -1338,13 +1338,13 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void beginEditCommand( const QString& text ); - /** Finish edit command and add it to undo/redo stack */ + //! Finish edit command and add it to undo/redo stack void endEditCommand(); - /** Destroy active command and reverts all changes in it */ + //! Destroy active command and reverts all changes in it void destroyEditCommand(); - /** Editing vertex markers */ + //! Editing vertex markers enum VertexMarkerType { SemiTransparentCircle, @@ -1352,13 +1352,13 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte NoMarker }; - /** Draws a vertex symbol at (screen) coordinates x, y. (Useful to assist vertex editing.) */ + //! Draws a vertex symbol at (screen) coordinates x, y. (Useful to assist vertex editing.) static void drawVertexMarker( double x, double y, QPainter& p, QgsVectorLayer::VertexMarkerType type, int vertexSize ); - /** Assembles mUpdatedFields considering provider fields, joined fields and added fields */ + //! Assembles mUpdatedFields considering provider fields, joined fields and added fields void updateFields(); - /** Caches joined attributes if required (and not already done) */ + //! Caches joined attributes if required (and not already done) // marked as const as these are just caches, and need to be created from const accessors void createJoinCaches() const; @@ -1466,19 +1466,19 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ QList< double > getDoubleValues( const QString &fieldOrExpression, bool &ok, bool selectedOnly = false, int* nullCount = nullptr ) const; - /** Set the blending mode used for rendering each feature */ + //! Set the blending mode used for rendering each feature void setFeatureBlendMode( QPainter::CompositionMode blendMode ); - /** Returns the current blending mode for features */ + //! Returns the current blending mode for features QPainter::CompositionMode featureBlendMode() const; - /** Set the transparency for the vector layer */ + //! Set the transparency for the vector layer void setLayerTransparency( int layerTransparency ); - /** Returns the current transparency for the vector layer */ + //! Returns the current transparency for the vector layer int layerTransparency() const; QString metadata() const override; - /** @note not available in python bindings */ + //! @note not available in python bindings inline QgsGeometryCache* cache() { return mCache; } /** Set the simplification settings for fast rendering of features @@ -1607,7 +1607,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ virtual void updateExtents(); - /** Check if there is a join with a layer that will be removed */ + //! Check if there is a join with a layer that will be removed void checkJoinLayerRemove( const QString& theLayerId ); /** @@ -1633,28 +1633,28 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void selectionChanged( const QgsFeatureIds& selected, const QgsFeatureIds& deselected, const bool clearAndSelect ); - /** This signal is emitted when selection was changed */ + //! This signal is emitted when selection was changed void selectionChanged(); - /** This signal is emitted when modifications has been done on layer */ + //! This signal is emitted when modifications has been done on layer void layerModified(); - /** Is emitted, when layer is checked for modifications. Use for last-minute additions */ + //! Is emitted, when layer is checked for modifications. Use for last-minute additions void beforeModifiedCheck() const; - /** Is emitted, before editing on this layer is started */ + //! Is emitted, before editing on this layer is started void beforeEditingStarted(); - /** Is emitted, when editing on this layer has started*/ + //! Is emitted, when editing on this layer has started void editingStarted(); - /** Is emitted, when edited changes successfully have been written to the data provider */ + //! Is emitted, when edited changes successfully have been written to the data provider void editingStopped(); - /** Is emitted, before changes are commited to the data provider */ + //! Is emitted, before changes are commited to the data provider void beforeCommitChanges(); - /** Is emitted, before changes are rolled back*/ + //! Is emitted, before changes are rolled back void beforeRollBack(); /** @@ -1747,26 +1747,26 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void geometryChanged( QgsFeatureId fid, const QgsGeometry& geometry ); - /** This signal is emitted, when attributes are deleted from the provider */ + //! This signal is emitted, when attributes are deleted from the provider void committedAttributesDeleted( const QString& layerId, const QgsAttributeList& deletedAttributes ); - /** This signal is emitted, when attributes are added to the provider */ + //! This signal is emitted, when attributes are added to the provider void committedAttributesAdded( const QString& layerId, const QList& addedAttributes ); - /** This signal is emitted, when features are added to the provider */ + //! This signal is emitted, when features are added to the provider void committedFeaturesAdded( const QString& layerId, const QgsFeatureList& addedFeatures ); - /** This signal is emitted, when features are deleted from the provider */ + //! This signal is emitted, when features are deleted from the provider void committedFeaturesRemoved( const QString& layerId, const QgsFeatureIds& deletedFeatureIds ); - /** This signal is emitted, when attribute value changes are saved to the provider */ + //! This signal is emitted, when attribute value changes are saved to the provider void committedAttributeValuesChanges( const QString& layerId, const QgsChangedAttributesMap& changedAttributesValues ); - /** This signal is emitted, when geometry changes are saved to the provider */ + //! This signal is emitted, when geometry changes are saved to the provider void committedGeometriesChanges( const QString& layerId, const QgsGeometryMap& changedGeometries ); - /** Emitted when the font family defined for labeling layer is not found on system */ + //! Emitted when the font family defined for labeling layer is not found on system void labelingFontNotFound( QgsVectorLayer* layer, const QString& fontfamily ); - /** Signal emitted when setFeatureBlendMode() is called */ + //! Signal emitted when setFeatureBlendMode() is called void featureBlendModeChanged( QPainter::CompositionMode blendMode ); - /** Signal emitted when setLayerTransparency() is called */ + //! Signal emitted when setLayerTransparency() is called void layerTransparencyChanged( int layerTransparency ); /** @@ -1853,7 +1853,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte void onRelationsLoaded(); protected: - /** Set the extent */ + //! Set the extent void setExtent( const QgsRectangle &rect ) override; private: // Private methods @@ -1862,10 +1862,10 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ virtual bool isReadOnly() const override; - /** Vector layers are not copyable */ + //! Vector layers are not copyable QgsVectorLayer( const QgsVectorLayer & rhs ); - /** Vector layers are not copyable */ + //! Vector layers are not copyable QgsVectorLayer & operator=( QgsVectorLayer const & rhs ); @@ -1875,7 +1875,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool setDataProvider( QString const & provider ); - /** Goes through all features and finds a free id (e.g. to give it temporarily to a not-commited feature) */ + //! Goes through all features and finds a free id (e.g. to give it temporarily to a not-commited feature) QgsFeatureId findFreeId(); /** Snaps to a geometry and adds the result to the multimap if it is within the snapping result @@ -1893,31 +1893,31 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QMultiMap& snappingResults, QgsSnapper::SnappingType snap_to ) const; - /** Add joined attributes to a feature */ + //! Add joined attributes to a feature //void addJoinedAttributes( QgsFeature& f, bool all = false ); - /** Read labeling from SLD */ + //! Read labeling from SLD void readSldLabeling( const QDomNode& node ); private: // Private attributes QgsConditionalLayerStyles * mConditionalStyles; - /** Pointer to data provider derived from the abastract base class QgsDataProvider */ + //! Pointer to data provider derived from the abastract base class QgsDataProvider QgsVectorDataProvider *mDataProvider; - /** The preview expression used to generate a human readable preview string for features */ + //! The preview expression used to generate a human readable preview string for features QString mDisplayExpression; QString mMapTipTemplate; - /** Data provider key */ + //! Data provider key QString mProviderKey; - /** The user-defined actions that are accessed from the Identify Results dialog box */ + //! The user-defined actions that are accessed from the Identify Results dialog box QgsActionManager* mActions; - /** Flag indicating whether the layer is in read-only mode (editing disabled) or not */ + //! Flag indicating whether the layer is in read-only mode (editing disabled) or not bool mReadOnly; /** Set holding the feature IDs that are activated. Note that if a feature @@ -1926,46 +1926,46 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ QgsFeatureIds mSelectedFeatureIds; - /** Field map to commit */ + //! Field map to commit QgsFields mFields; - /** Map that stores the aliases for attributes. Key is the attribute name and value the alias for that attribute*/ + //! Map that stores the aliases for attributes. Key is the attribute name and value the alias for that attribute QgsStringMap mAttributeAliasMap; //! Map which stores default value expressions for fields QgsStringMap mDefaultExpressionMap; - /** Holds the configuration for the edit form */ + //! Holds the configuration for the edit form QgsEditFormConfig mEditFormConfig; - /** Attributes which are not published in WMS*/ + //! Attributes which are not published in WMS QSet mExcludeAttributesWMS; - /** Attributes which are not published in WFS*/ + //! Attributes which are not published in WFS QSet mExcludeAttributesWFS; - /** Geometry type as defined in enum WkbType (qgis.h) */ + //! Geometry type as defined in enum WkbType (qgis.h) QgsWkbTypes::Type mWkbType; - /** Renderer object which holds the information about how to display the features */ + //! Renderer object which holds the information about how to display the features QgsFeatureRenderer *mRenderer; - /** Simplification object which holds the information about how to simplify the features for fast rendering */ + //! Simplification object which holds the information about how to simplify the features for fast rendering QgsVectorSimplifyMethod mSimplifyMethod; - /** Labeling configuration */ + //! Labeling configuration QgsAbstractVectorLayerLabeling* mLabeling; - /** Whether 'labeling font not found' has be shown for this layer (only show once in QgsMessageBar, on first rendering) */ + //! Whether 'labeling font not found' has be shown for this layer (only show once in QgsMessageBar, on first rendering) bool mLabelFontNotFoundNotified; - /** Blend mode for features */ + //! Blend mode for features QPainter::CompositionMode mFeatureBlendMode; - /** Layer transparency */ + //! Layer transparency int mLayerTransparency; - /** Flag if the vertex markers should be drawn only for selection (true) or for all features (false) */ + //! Flag if the vertex markers should be drawn only for selection (true) or for all features (false) bool mVertexMarkerOnlyForSelection; QStringList mCommitErrors; diff --git a/src/core/qgsvectorlayerdiagramprovider.h b/src/core/qgsvectorlayerdiagramprovider.h index 8db71242163..ea59fc52703 100644 --- a/src/core/qgsvectorlayerdiagramprovider.h +++ b/src/core/qgsvectorlayerdiagramprovider.h @@ -39,7 +39,7 @@ class QgsDiagramLabelFeature : public QgsLabelFeature const QgsAttributes& attributes() { return mAttributes; } protected: - /** Stores attribute values for diagram rendering*/ + //! Stores attribute values for diagram rendering QgsAttributes mAttributes; }; diff --git a/src/core/qgsvectorlayereditbuffer.h b/src/core/qgsvectorlayereditbuffer.h index 31107dbf8ba..4a9d528cfbe 100644 --- a/src/core/qgsvectorlayereditbuffer.h +++ b/src/core/qgsvectorlayereditbuffer.h @@ -38,7 +38,7 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject QgsVectorLayerEditBuffer( QgsVectorLayer* layer ); ~QgsVectorLayerEditBuffer(); - /** Returns true if the provider has been modified since the last commit */ + //! Returns true if the provider has been modified since the last commit virtual bool isModified() const; @@ -48,26 +48,26 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject */ virtual bool addFeature( QgsFeature& f ); - /** Insert a copy of the given features into the layer (but does not commit it) */ + //! Insert a copy of the given features into the layer (but does not commit it) virtual bool addFeatures( QgsFeatureList& features ); - /** Delete a feature from the layer (but does not commit it) */ + //! Delete a feature from the layer (but does not commit it) virtual bool deleteFeature( QgsFeatureId fid ); - /** Deletes a set of features from the layer (but does not commit it) */ + //! Deletes a set of features from the layer (but does not commit it) virtual bool deleteFeatures( const QgsFeatureIds& fid ); - /** Change feature's geometry */ + //! Change feature's geometry virtual bool changeGeometry( QgsFeatureId fid, const QgsGeometry &geom ); - /** Changed an attribute value (but does not commit it) */ + //! Changed an attribute value (but does not commit it) virtual bool changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue = QVariant() ); /** Add an attribute field (but does not commit it) returns true if the field was added */ virtual bool addAttribute( const QgsField &field ); - /** Delete an attribute field (but does not commit it) */ + //! Delete an attribute field (but does not commit it) virtual bool deleteAttribute( int attr ); /** Renames an attribute field (but does not commit it) @@ -94,7 +94,7 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject */ virtual bool commitChanges( QStringList& commitErrors ); - /** Stop editing and discard the edits */ + //! Stop editing and discard the edits virtual void rollBack(); /** Returns a map of new features which are not committed. @@ -167,7 +167,7 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject void undoIndexChanged( int index ); signals: - /** This signal is emitted when modifications has been done on layer */ + //! This signal is emitted when modifications has been done on layer void layerModified(); void featureAdded( QgsFeatureId fid ); @@ -190,7 +190,7 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject */ void attributeRenamed( int idx, const QString& newName ); - /** Signals emitted after committing changes */ + //! Signals emitted after committing changes void committedAttributesDeleted( const QString& layerId, const QgsAttributeList& deletedAttributes ); void committedAttributesAdded( const QString& layerId, const QList& addedAttributes ); @@ -211,19 +211,19 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject void updateFields( QgsFields& fields ); - /** Update feature with uncommitted geometry updates */ + //! Update feature with uncommitted geometry updates void updateFeatureGeometry( QgsFeature &f ); - /** Update feature with uncommitted attribute updates */ + //! Update feature with uncommitted attribute updates void updateChangedAttributes( QgsFeature &f ); - /** Update added and changed features after addition of an attribute */ + //! Update added and changed features after addition of an attribute void handleAttributeAdded( int index ); - /** Update added and changed features after removal of an attribute */ + //! Update added and changed features after removal of an attribute void handleAttributeDeleted( int index ); - /** Updates an index in an attribute map to a new value (for updates of changed attributes) */ + //! Updates an index in an attribute map to a new value (for updates of changed attributes) void updateAttributeMapIndex( QgsAttributeMap& attrs, int index, int offset ) const; void updateLayerFields(); @@ -247,22 +247,22 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject */ QgsFeatureIds mDeletedFeatureIds; - /** New features which are not committed. */ + //! New features which are not committed. QgsFeatureMap mAddedFeatures; - /** Changed attributes values which are not committed */ + //! Changed attributes values which are not committed QgsChangedAttributesMap mChangedAttributeValues; - /** Deleted attributes fields which are not committed. The list is kept sorted. */ + //! Deleted attributes fields which are not committed. The list is kept sorted. QgsAttributeList mDeletedAttributeIds; - /** Added attributes fields which are not committed */ + //! Added attributes fields which are not committed QList mAddedAttributes; - /** Renamed attributes which are not committed. */ + //! Renamed attributes which are not committed. QgsFieldNameMap mRenamedAttributes; - /** Changed geometries which are not committed. */ + //! Changed geometries which are not committed. QgsGeometryMap mChangedGeometries; friend class QgsGrassProvider; //GRASS provider totally abuses the edit buffer diff --git a/src/core/qgsvectorlayerfeatureiterator.h b/src/core/qgsvectorlayerfeatureiterator.h index 8f7666693ff..c077bb07129 100644 --- a/src/core/qgsvectorlayerfeatureiterator.h +++ b/src/core/qgsvectorlayerfeatureiterator.h @@ -167,12 +167,12 @@ class CORE_EXPORT QgsVectorLayerFeatureIterator : public QgsAbstractFeatureItera */ struct FetchJoinInfo { - const QgsVectorJoinInfo* joinInfo;//!< cannonical source of information about the join - QgsAttributeList attributes; //!< attributes to fetch - int indexOffset; //!< at what position the joined fields start - QgsVectorLayer* joinLayer; //!< resolved pointer to the joined layer - int targetField; //!< index of field (of this layer) that drives the join - int joinField; //!< index of field (of the joined layer) must have equal value + const QgsVectorJoinInfo* joinInfo;//!< Cannonical source of information about the join + QgsAttributeList attributes; //!< Attributes to fetch + int indexOffset; //!< At what position the joined fields start + QgsVectorLayer* joinLayer; //!< Resolved pointer to the joined layer + int targetField; //!< Index of field (of this layer) that drives the join + int joinField; //!< Index of field (of the joined layer) must have equal value void addJoinedAttributesCached( QgsFeature& f, const QVariant& joinValue ) const; void addJoinedAttributesDirect( QgsFeature& f, const QVariant& joinValue ) const; @@ -206,7 +206,7 @@ class CORE_EXPORT QgsVectorLayerFeatureIterator : public QgsAbstractFeatureItera QList< int > mPreparedFields; QList< int > mFieldsToPrepare; - /** Join list sorted by dependency*/ + //! Join list sorted by dependency QList< FetchJoinInfo > mOrderedJoinInfoList; /** diff --git a/src/core/qgsvectorlayerimport.h b/src/core/qgsvectorlayerimport.h index 569f6a57fa1..4b92af4d06c 100644 --- a/src/core/qgsvectorlayerimport.h +++ b/src/core/qgsvectorlayerimport.h @@ -50,7 +50,7 @@ class CORE_EXPORT QgsVectorLayerImport ErrInvalidProvider, ErrProviderUnsupportedFeature, ErrConnectionFailed, - ErrUserCancelled, /*!< User cancelled the import*/ + ErrUserCancelled, //!< User cancelled the import }; /** @@ -99,28 +99,28 @@ class CORE_EXPORT QgsVectorLayerImport QProgressDialog *progress = nullptr ); - /** Checks whether there were any errors */ + //! Checks whether there were any errors ImportError hasError(); - /** Retrieves error message */ + //! Retrieves error message QString errorMessage(); int errorCount() const { return mErrorCount; } - /** Add feature to the new created layer */ + //! Add feature to the new created layer bool addFeature( QgsFeature& feature ); - /** Close the new created layer */ + //! Close the new created layer ~QgsVectorLayerImport(); protected: - /** Flush the buffer writing the features to the new layer */ + //! Flush the buffer writing the features to the new layer bool flushBuffer(); - /** Create index */ + //! Create index bool createSpatialIndex(); - /** Contains error value */ + //! Contains error value ImportError mError; QString mErrorMessage; @@ -128,7 +128,7 @@ class CORE_EXPORT QgsVectorLayerImport QgsVectorDataProvider *mProvider; - /** Map attribute indexes to new field indexes */ + //! Map attribute indexes to new field indexes QMap mOldToNewAttrIdx; int mAttributeCount; diff --git a/src/core/qgsvectorlayerjoinbuffer.h b/src/core/qgsvectorlayerjoinbuffer.h index 7d1da6dbbdf..c56868ce33e 100644 --- a/src/core/qgsvectorlayerjoinbuffer.h +++ b/src/core/qgsvectorlayerjoinbuffer.h @@ -50,16 +50,16 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject */ void updateFields( QgsFields& fields ); - /** Calls cacheJoinLayer() for all vector joins*/ + //! Calls cacheJoinLayer() for all vector joins void createJoinCaches(); - /** Saves mVectorJoins to xml under the layer node*/ + //! Saves mVectorJoins to xml under the layer node void writeXml( QDomNode& layer_node, QDomDocument& document ) const; - /** Reads joins from project file*/ + //! Reads joins from project file void readXml( const QDomNode& layer_node ); - /** Quick way to test if there is any join at all*/ + //! Quick way to test if there is any join at all bool containsJoins() const { return !mVectorJoins.isEmpty(); } const QgsVectorJoinList& vectorJoins() const { return mVectorJoins; } @@ -96,13 +96,13 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject QgsVectorLayer* mLayer; - /** Joined vector layers*/ + //! Joined vector layers QgsVectorJoinList mVectorJoins; - /** Caches attributes of join layer in memory if QgsVectorJoinInfo.memoryCache is true (and the cache is not already there)*/ + //! Caches attributes of join layer in memory if QgsVectorJoinInfo.memoryCache is true (and the cache is not already there) void cacheJoinLayer( QgsVectorJoinInfo& joinInfo ); - /** Main mutex to protect most data members that can be modified concurrently */ + //! Main mutex to protect most data members that can be modified concurrently QMutex mMutex; }; diff --git a/src/core/qgsvectorlayerrenderer.h b/src/core/qgsvectorlayerrenderer.h index a74ef62dfef..7ba66a09aee 100644 --- a/src/core/qgsvectorlayerrenderer.h +++ b/src/core/qgsvectorlayerrenderer.h @@ -51,7 +51,7 @@ class QgsVectorLayerDiagramProvider; class QgsVectorLayerRendererInterruptionChecker: public QgsInterruptionChecker { public: - /** Constructor */ + //! Constructor explicit QgsVectorLayerRendererInterruptionChecker( const QgsRenderContext& context ); bool mustStop() const override; private: @@ -93,7 +93,7 @@ class QgsVectorLayerRenderer : public QgsMapLayerRenderer */ void drawRendererLevels( QgsFeatureIterator& fit ); - /** Stop version 2 renderer and selected renderer (if required) */ + //! Stop version 2 renderer and selected renderer (if required) void stopRenderer( QgsSingleSymbolRenderer* selRenderer ); @@ -103,7 +103,7 @@ class QgsVectorLayerRenderer : public QgsMapLayerRenderer QgsVectorLayerRendererInterruptionChecker mInterruptionChecker; - /** The rendered layer */ + //! The rendered layer QgsVectorLayer* mLayer; QgsFields mFields; // TODO: use fields from mSource diff --git a/src/core/qgsvectorsimplifymethod.h b/src/core/qgsvectorsimplifymethod.h index 7851eefea2c..3dbfb220872 100644 --- a/src/core/qgsvectorsimplifymethod.h +++ b/src/core/qgsvectorsimplifymethod.h @@ -28,7 +28,7 @@ class CORE_EXPORT QgsVectorSimplifyMethod //! construct a default object QgsVectorSimplifyMethod(); - /** Simplification flags for fast rendering of features */ + //! Simplification flags for fast rendering of features enum SimplifyHint { NoSimplification = 0, //!< No simplification can be applied @@ -38,12 +38,12 @@ class CORE_EXPORT QgsVectorSimplifyMethod }; Q_DECLARE_FLAGS( SimplifyHints, SimplifyHint ) - /** Sets the simplification hints of the vector layer managed */ + //! Sets the simplification hints of the vector layer managed void setSimplifyHints( SimplifyHints simplifyHints ) { mSimplifyHints = simplifyHints; } - /** Gets the simplification hints of the vector layer managed */ + //! Gets the simplification hints of the vector layer managed inline SimplifyHints simplifyHints() const { return mSimplifyHints; } - /** Types of local simplification algorithms that can be used */ + //! Types of local simplification algorithms that can be used enum SimplifyAlgorithm { Distance = 0, //!< The simplification uses the distance between points to remove duplicate points @@ -51,43 +51,43 @@ class CORE_EXPORT QgsVectorSimplifyMethod Visvalingam = 2, //!< The simplification gives each point in a line an importance weighting, so that least important points are removed first }; - /** Sets the local simplification algorithm of the vector layer managed */ + //! Sets the local simplification algorithm of the vector layer managed void setSimplifyAlgorithm( SimplifyAlgorithm simplifyAlgorithm ) { mSimplifyAlgorithm = simplifyAlgorithm; } - /** Gets the local simplification algorithm of the vector layer managed */ + //! Gets the local simplification algorithm of the vector layer managed inline SimplifyAlgorithm simplifyAlgorithm() const { return mSimplifyAlgorithm; } - /** Sets the tolerance of simplification in map units. Represents the maximum distance in map units between two coordinates which can be considered equal */ + //! Sets the tolerance of simplification in map units. Represents the maximum distance in map units between two coordinates which can be considered equal void setTolerance( double tolerance ) { mTolerance = tolerance; } - /** Gets the tolerance of simplification in map units. Represents the maximum distance in map units between two coordinates which can be considered equal */ + //! Gets the tolerance of simplification in map units. Represents the maximum distance in map units between two coordinates which can be considered equal inline double tolerance() const { return mTolerance; } - /** Sets the simplification threshold of the vector layer managed */ + //! Sets the simplification threshold of the vector layer managed void setThreshold( float threshold ) { mThreshold = threshold; } - /** Gets the simplification threshold of the vector layer managed */ + //! Gets the simplification threshold of the vector layer managed inline float threshold() const { return mThreshold; } - /** Sets where the simplification executes, after fetch the geometries from provider, or when supported, in provider before fetch the geometries */ + //! Sets where the simplification executes, after fetch the geometries from provider, or when supported, in provider before fetch the geometries void setForceLocalOptimization( bool localOptimization ) { mLocalOptimization = localOptimization; } - /** Gets where the simplification executes, after fetch the geometries from provider, or when supported, in provider before fetch the geometries */ + //! Gets where the simplification executes, after fetch the geometries from provider, or when supported, in provider before fetch the geometries inline bool forceLocalOptimization() const { return mLocalOptimization; } - /** Sets the maximum scale at which the layer should be simplified */ + //! Sets the maximum scale at which the layer should be simplified void setMaximumScale( float maximumScale ) { mMaximumScale = maximumScale; } - /** Gets the maximum scale at which the layer should be simplified */ + //! Gets the maximum scale at which the layer should be simplified inline float maximumScale() const { return mMaximumScale; } private: - /** Simplification hints for fast rendering of features of the vector layer managed */ + //! Simplification hints for fast rendering of features of the vector layer managed SimplifyHints mSimplifyHints; - /** Simplification algorithm */ + //! Simplification algorithm SimplifyAlgorithm mSimplifyAlgorithm; - /** Simplification tolerance, it represents the maximum distance between two coordinates which can be considered equal */ + //! Simplification tolerance, it represents the maximum distance between two coordinates which can be considered equal double mTolerance; - /** Simplification threshold */ + //! Simplification threshold float mThreshold; - /** Simplification executes after fetch the geometries from provider, otherwise it executes, when supported, in provider before fetch the geometries */ + //! Simplification executes after fetch the geometries from provider, otherwise it executes, when supported, in provider before fetch the geometries bool mLocalOptimization; - /** Maximum scale at which the layer should be simplified (Maximum scale at which generalisation should be carried out) */ + //! Maximum scale at which the layer should be simplified (Maximum scale at which generalisation should be carried out) float mMaximumScale; }; diff --git a/src/core/raster/qgsbrightnesscontrastfilter.h b/src/core/raster/qgsbrightnesscontrastfilter.h index 7a065dfb6ea..bb6608353da 100644 --- a/src/core/raster/qgsbrightnesscontrastfilter.h +++ b/src/core/raster/qgsbrightnesscontrastfilter.h @@ -49,17 +49,17 @@ class CORE_EXPORT QgsBrightnessContrastFilter : public QgsRasterInterface void writeXml( QDomDocument& doc, QDomElement& parentElem ) const override; - /** Sets base class members from xml. Usually called from create() methods of subclasses*/ + //! Sets base class members from xml. Usually called from create() methods of subclasses void readXml( const QDomElement& filterElem ) override; private: - /** Adjusts a color component by the specified brightness and contrast factor*/ + //! Adjusts a color component by the specified brightness and contrast factor int adjustColorComponent( int colorComponent, int alpha, int brightness, double contrastFactor ) const; - /** Current brightness coefficient value. Default: 0. Range: -255...255 */ + //! Current brightness coefficient value. Default: 0. Range: -255...255 int mBrightness; - /** Current contrast coefficient value. Default: 0. Range: -100...100 */ + //! Current contrast coefficient value. Default: 0. Range: -100...100 double mContrast; }; diff --git a/src/core/raster/qgscolorrampshader.h b/src/core/raster/qgscolorrampshader.h index b96a99fe85c..0fe2fbf068f 100644 --- a/src/core/raster/qgscolorrampshader.h +++ b/src/core/raster/qgscolorrampshader.h @@ -58,7 +58,7 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction bool operator<( const ColorRampItem& other ) const { return value < other.value; } }; - /** Supported methods for color interpolation. */ + //! Supported methods for color interpolation. enum ColorRamp_TYPE { INTERPOLATED, //!< Interpolates the color between two class breaks linearly. @@ -66,28 +66,28 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction EXACT //!< Assigns the color of the exact matching value in the color ramp item list }; - /** \brief Get the custom colormap*/ + //! \brief Get the custom colormap QList colorRampItemList() const {return mColorRampItemList.toList();} - /** \brief Get the color ramp type */ + //! \brief Get the color ramp type QgsColorRampShader::ColorRamp_TYPE colorRampType() const {return mColorRampType;} - /** \brief Get the color ramp type as a string */ + //! \brief Get the color ramp type as a string QString colorRampTypeAsQString(); - /** \brief Set custom colormap */ + //! \brief Set custom colormap void setColorRampItemList( const QList& theList ); //TODO: sort on set - /** \brief Set the color ramp type*/ + //! \brief Set the color ramp type void setColorRampType( QgsColorRampShader::ColorRamp_TYPE theColorRampType ); - /** \brief Set the color ramp type*/ + //! \brief Set the color ramp type void setColorRampType( const QString& theType ); - /** \brief Generates and new RGB value based on one input value */ + //! \brief Generates and new RGB value based on one input value bool shade( double, int*, int*, int*, int* ) override; - /** \brief Generates and new RGB value based on original RGB value */ + //! \brief Generates and new RGB value based on original RGB value bool shade( double, double, double, double, int*, int*, int*, int* ) override; void legendSymbologyItems( QList< QPair< QString, QColor > >& symbolItems ) const override; @@ -111,7 +111,7 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction * interpolated for values between the item values (false)*/ QVector mColorRampItemList; - /** \brief The color ramp type */ + //! \brief The color ramp type QgsColorRampShader::ColorRamp_TYPE mColorRampType; /** Look up table to speed up finding the right color. @@ -121,7 +121,7 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction double mLUTFactor; bool mLUTInitialized; - /** Do not render values out of range */ + //! Do not render values out of range bool mClip; }; diff --git a/src/core/raster/qgscontrastenhancement.h b/src/core/raster/qgscontrastenhancement.h index 54c60f8ec72..70dba28d195 100644 --- a/src/core/raster/qgscontrastenhancement.h +++ b/src/core/raster/qgscontrastenhancement.h @@ -40,7 +40,7 @@ class CORE_EXPORT QgsContrastEnhancement public: - /** \brief This enumerator describes the types of contrast enhancement algorithms that can be used. */ + //! \brief This enumerator describes the types of contrast enhancement algorithms that can be used. enum ContrastEnhancementAlgorithm { NoEnhancement, //this should be the default color scaling algorithm @@ -59,10 +59,10 @@ class CORE_EXPORT QgsContrastEnhancement * Static methods * */ - /** \brief Helper function that returns the maximum possible value for a GDAL data type */ + //! \brief Helper function that returns the maximum possible value for a GDAL data type static double maximumValuePossible( Qgis::DataType ); - /** \brief Helper function that returns the minimum possible value for a GDAL data type */ + //! \brief Helper function that returns the minimum possible value for a GDAL data type static double minimumValuePossible( Qgis::DataType ); /* @@ -70,10 +70,10 @@ class CORE_EXPORT QgsContrastEnhancement * Non-Static Inline methods * */ - /** \brief Return the maximum value for the contrast enhancement range. */ + //! \brief Return the maximum value for the contrast enhancement range. double maximumValue() const { return mMaximumValue; } - /** \brief Return the minimum value for the contrast enhancement range. */ + //! \brief Return the minimum value for the contrast enhancement range. double minimumValue() const { return mMinimumValue; } ContrastEnhancementAlgorithm contrastEnhancementAlgorithm() const { return mContrastEnhancementAlgorithm; } @@ -87,22 +87,22 @@ class CORE_EXPORT QgsContrastEnhancement * Non-Static methods * */ - /** \brief Apply the contrast enhancement to a value. Return values are 0 - 254, -1 means the pixel was clipped and should not be displayed */ + //! \brief Apply the contrast enhancement to a value. Return values are 0 - 254, -1 means the pixel was clipped and should not be displayed int enhanceContrast( double ); - /** \brief Return true if pixel is in stretable range, false if pixel is outside of range (i.e., clipped) */ + //! \brief Return true if pixel is in stretable range, false if pixel is outside of range (i.e., clipped) bool isValueInDisplayableRange( double ); - /** \brief Set the contrast enhancement algorithm */ + //! \brief Set the contrast enhancement algorithm void setContrastEnhancementAlgorithm( ContrastEnhancementAlgorithm, bool generateTable = true ); - /** \brief A public method that allows the user to set their own custom contrast enhancment function */ + //! \brief A public method that allows the user to set their own custom contrast enhancment function void setContrastEnhancementFunction( QgsContrastEnhancementFunction* ); - /** \brief Set the maximum value for the contrast enhancement range. */ + //! \brief Set the maximum value for the contrast enhancement range. void setMaximumValue( double, bool generateTable = true ); - /** \brief Return the minimum value for the contrast enhancement range. */ + //! \brief Return the minimum value for the contrast enhancement range. void setMinimumValue( double, bool generateTable = true ); void writeXml( QDomDocument& doc, QDomElement& parentElem ) const; @@ -110,39 +110,39 @@ class CORE_EXPORT QgsContrastEnhancement void readXml( const QDomElement& elem ); private: - /** \brief Current contrast enhancement algorithm */ + //! \brief Current contrast enhancement algorithm ContrastEnhancementAlgorithm mContrastEnhancementAlgorithm; - /** \brief Pointer to the contrast enhancement function */ + //! \brief Pointer to the contrast enhancement function QgsContrastEnhancementFunction* mContrastEnhancementFunction; - /** \brief Flag indicating if the lookup table needs to be regenerated */ + //! \brief Flag indicating if the lookup table needs to be regenerated bool mEnhancementDirty; - /** \brief Scalar so that values can be used as array indicies */ + //! \brief Scalar so that values can be used as array indicies double mLookupTableOffset; - /** \brief Pointer to the lookup table */ + //! \brief Pointer to the lookup table int *mLookupTable; - /** \brief User defineable minimum value for the band, used for enhanceContrasting */ + //! \brief User defineable minimum value for the band, used for enhanceContrasting double mMinimumValue; - /** \brief user defineable maximum value for the band, used for enhanceContrasting */ + //! \brief user defineable maximum value for the band, used for enhanceContrasting double mMaximumValue; - /** \brief Data type of the band */ + //! \brief Data type of the band Qgis::DataType mRasterDataType; - /** \brief Maximum range of values for a given data type */ + //! \brief Maximum range of values for a given data type double mRasterDataTypeRange; - /** \brief Method to generate a new lookup table */ + //! \brief Method to generate a new lookup table bool generateLookupTable(); - /** \brief Method to calculate the actual enhanceContrasted value(s) */ + //! \brief Method to calculate the actual enhanceContrasted value(s) int calculateContrastEnhancementValue( double ); const QgsContrastEnhancement& operator=( const QgsContrastEnhancement& ); diff --git a/src/core/raster/qgscontrastenhancementfunction.h b/src/core/raster/qgscontrastenhancementfunction.h index 25936c9886a..4221fa84361 100644 --- a/src/core/raster/qgscontrastenhancementfunction.h +++ b/src/core/raster/qgscontrastenhancementfunction.h @@ -35,29 +35,29 @@ class CORE_EXPORT QgsContrastEnhancementFunction QgsContrastEnhancementFunction( const QgsContrastEnhancementFunction& f ); virtual ~QgsContrastEnhancementFunction() {} - /** \brief A customizable method that takes in a double and returns a int between 0 and 255 */ + //! \brief A customizable method that takes in a double and returns a int between 0 and 255 virtual int enhance( double ); - /** \brief A customicable method to indicate if the pixels is displayable */ + //! \brief A customicable method to indicate if the pixels is displayable virtual bool isValueInDisplayableRange( double ); - /** \brief Mustator for the maximum value */ + //! \brief Mustator for the maximum value void setMaximumValue( double ); - /** \brief Mutator for the minimum value */ + //! \brief Mutator for the minimum value void setMinimumValue( double ); protected: - /** \brief User defineable maximum value for the band, used for enhanceContrasting */ + //! \brief User defineable maximum value for the band, used for enhanceContrasting double mMaximumValue; - /** \brief User defineable minimum value for the band, used for enhanceContrasting */ + //! \brief User defineable minimum value for the band, used for enhanceContrasting double mMinimumValue; - /** \brief Minimum maximum range for the band, used for enhanceContrasting */ + //! \brief Minimum maximum range for the band, used for enhanceContrasting double mMinimumMaximumRange; - /** \brief Data type of the band */ + //! \brief Data type of the band Qgis::DataType mQgsRasterDataType; }; diff --git a/src/core/raster/qgscubicrasterresampler.h b/src/core/raster/qgscubicrasterresampler.h index 8b9e1bacda7..36f7001e1f7 100644 --- a/src/core/raster/qgscubicrasterresampler.h +++ b/src/core/raster/qgscubicrasterresampler.h @@ -42,7 +42,7 @@ class CORE_EXPORT QgsCubicRasterResampler: public QgsRasterResampler double* xDerivativeMatrixAlpha, double* yDerivativeMatrixRed, double* yDerivativeMatrixGreen, double* yDerivativeMatrixBlue, double* yDerivativeMatrixAlpha ); - /** Use cubic curve interpoation at the borders of the raster*/ + //! Use cubic curve interpoation at the borders of the raster QRgb curveInterpolation( QRgb pt1, QRgb pt2, double t, double d1red, double d1green, double d1blue, double d1alpha, double d2red, double d2green, double d2blue, double d2alpha ); diff --git a/src/core/raster/qgshillshaderenderer.h b/src/core/raster/qgshillshaderenderer.h index 2c1387395c6..1501ee89370 100644 --- a/src/core/raster/qgshillshaderenderer.h +++ b/src/core/raster/qgshillshaderenderer.h @@ -123,10 +123,10 @@ class CORE_EXPORT QgsHillshadeRenderer : public QgsRasterRenderer double mLightAzimuth; bool mMultiDirectional; - /** Calculates the first order derivative in x-direction according to Horn (1981)*/ + //! Calculates the first order derivative in x-direction according to Horn (1981) double calcFirstDerX( double x11, double x21, double x31, double x12, double x22, double x32, double x13, double x23, double x33 , double cellsize ); - /** Calculates the first order derivative in y-direction according to Horn (1981)*/ + //! Calculates the first order derivative in y-direction according to Horn (1981) double calcFirstDerY( double x11, double x21, double x31, double x12, double x22, double x32, double x13, double x23, double x33 , double cellsize ); }; diff --git a/src/core/raster/qgshuesaturationfilter.h b/src/core/raster/qgshuesaturationfilter.h index 10dbdb6c980..70224589a20 100644 --- a/src/core/raster/qgshuesaturationfilter.h +++ b/src/core/raster/qgshuesaturationfilter.h @@ -66,23 +66,23 @@ class CORE_EXPORT QgsHueSaturationFilter : public QgsRasterInterface void writeXml( QDomDocument& doc, QDomElement& parentElem ) const override; - /** Sets base class members from xml. Usually called from create() methods of subclasses*/ + //! Sets base class members from xml. Usually called from create() methods of subclasses void readXml( const QDomElement& filterElem ) override; private: - /** Process a change in saturation and update resultant HSL & RGB values*/ + //! Process a change in saturation and update resultant HSL & RGB values void processSaturation( int &r, int &g, int &b, int &h, int &s, int &l ); - /** Process a colorization and update resultant HSL & RGB values*/ + //! Process a colorization and update resultant HSL & RGB values void processColorization( int &r, int &g, int &b, int &h, int &s, int &l ); - /** Current saturation value. Range: -100 (desaturated) ... 0 (no change) ... 100 (increased)*/ + //! Current saturation value. Range: -100 (desaturated) ... 0 (no change) ... 100 (increased) int mSaturation; double mSaturationScale; - /** Current grayscale mode*/ + //! Current grayscale mode QgsHueSaturationFilter::GrayscaleMode mGrayscaleMode; - /** Colorize settings*/ + //! Colorize settings bool mColorizeOn; QColor mColorizeColor; int mColorizeH, mColorizeS; diff --git a/src/core/raster/qgsmultibandcolorrenderer.h b/src/core/raster/qgsmultibandcolorrenderer.h index b4a079a672d..c47e2eeac95 100644 --- a/src/core/raster/qgsmultibandcolorrenderer.h +++ b/src/core/raster/qgsmultibandcolorrenderer.h @@ -47,15 +47,15 @@ class CORE_EXPORT QgsMultiBandColorRenderer: public QgsRasterRenderer void setBlueBand( int band ) { mBlueBand = band; } const QgsContrastEnhancement* redContrastEnhancement() const { return mRedContrastEnhancement; } - /** Takes ownership*/ + //! Takes ownership void setRedContrastEnhancement( QgsContrastEnhancement* ce ); const QgsContrastEnhancement* greenContrastEnhancement() const { return mGreenContrastEnhancement; } - /** Takes ownership*/ + //! Takes ownership void setGreenContrastEnhancement( QgsContrastEnhancement* ce ); const QgsContrastEnhancement* blueContrastEnhancement() const { return mBlueContrastEnhancement; } - /** Takes ownership*/ + //! Takes ownership void setBlueContrastEnhancement( QgsContrastEnhancement* ce ); void writeXml( QDomDocument& doc, QDomElement& parentElem ) const override; diff --git a/src/core/raster/qgspalettedrasterrenderer.h b/src/core/raster/qgspalettedrasterrenderer.h index 9d6d6b2bf37..272dc54aa28 100644 --- a/src/core/raster/qgspalettedrasterrenderer.h +++ b/src/core/raster/qgspalettedrasterrenderer.h @@ -31,7 +31,7 @@ class QDomElement; class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer { public: - /** Renderer owns color array*/ + //! Renderer owns color array QgsPalettedRasterRenderer( QgsRasterInterface* input, int bandNumber, QColor* colorArray, int nColors, const QVector& labels = QVector() ); QgsPalettedRasterRenderer( QgsRasterInterface* input, int bandNumber, QRgb* colorArray, int nColors, const QVector& labels = QVector() ); ~QgsPalettedRasterRenderer(); @@ -40,9 +40,9 @@ class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer QgsRasterBlock *block( int bandNo, const QgsRectangle & extent, int width, int height, QgsRasterBlockFeedback* feedback = nullptr ) override; - /** Returns number of colors*/ + //! Returns number of colors int nColors() const { return mNColors; } - /** Returns copy of color array (caller takes ownership)*/ + //! Returns copy of color array (caller takes ownership) QColor* colors() const; /** Returns copy of rgb array (caller takes ownership) @@ -66,11 +66,11 @@ class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer private: int mBand; - /** Color array*/ + //! Color array QRgb* mColors; - /** Number of colors*/ + //! Number of colors int mNColors; - /** Optional category labels, size of vector may be < mNColors */ + //! Optional category labels, size of vector may be < mNColors QVector mLabels; QgsPalettedRasterRenderer( const QgsPalettedRasterRenderer& ); diff --git a/src/core/raster/qgsraster.h b/src/core/raster/qgsraster.h index 7d7d75377fc..039d9758c08 100644 --- a/src/core/raster/qgsraster.h +++ b/src/core/raster/qgsraster.h @@ -82,7 +82,7 @@ class CORE_EXPORT QgsRaster PyramidsErdas = 2 }; - /** \brief Contrast enhancement limits */ + //! \brief Contrast enhancement limits enum ContrastEnhancementLimits { ContrastEnhancementNone, @@ -91,7 +91,7 @@ class CORE_EXPORT QgsRaster ContrastEnhancementCumulativeCut }; - /** \brief This enumerator describes the different kinds of drawing we can do */ + //! \brief This enumerator describes the different kinds of drawing we can do enum DrawingStyle { UndefinedDrawingStyle, diff --git a/src/core/raster/qgsrasterbandstats.h b/src/core/raster/qgsrasterbandstats.h index 80cee43a6d3..ca93dba2664 100644 --- a/src/core/raster/qgsrasterbandstats.h +++ b/src/core/raster/qgsrasterbandstats.h @@ -61,7 +61,7 @@ class CORE_EXPORT QgsRasterBandStats bandNumber = 1; } - /** Compares region, size etc. not collected statistics */ + //! Compares region, size etc. not collected statistics bool contains( const QgsRasterBandStats &s ) const { return ( s.bandNumber == bandNumber && @@ -71,10 +71,10 @@ class CORE_EXPORT QgsRasterBandStats s.statsGathered == ( statsGathered & s.statsGathered ) ); } - /** \brief The gdal band number (starts at 1)*/ + //! \brief The gdal band number (starts at 1) int bandNumber; - /** \brief The number of not no data cells in the band. */ + //! \brief The number of not no data cells in the band. // TODO: check if no data are excluded in stats calculation qgssize elementCount; @@ -86,31 +86,31 @@ class CORE_EXPORT QgsRasterBandStats * are ignored. This does not use the gdal GetMinimum function. */ double minimumValue; - /** \brief The mean cell value for the band. NO_DATA values are excluded. */ + //! \brief The mean cell value for the band. NO_DATA values are excluded. double mean; - /** \brief The range is the distance between min & max. */ + //! \brief The range is the distance between min & max. double range; - /** \brief The standard deviation of the cell values. */ + //! \brief The standard deviation of the cell values. double stdDev; - /** \brief Collected statistics */ + //! \brief Collected statistics int statsGathered; - /** \brief The sum of all cells in the band. NO_DATA values are excluded. */ + //! \brief The sum of all cells in the band. NO_DATA values are excluded. double sum; - /** \brief The sum of the squares. Used to calculate standard deviation. */ + //! \brief The sum of the squares. Used to calculate standard deviation. double sumOfSquares; - /** \brief Number of columns used to calc statistics */ + //! \brief Number of columns used to calc statistics int width; - /** \brief Number of rows used to calc statistics */ + //! \brief Number of rows used to calc statistics int height; - /** \brief Extent used to calc statistics */ + //! \brief Extent used to calc statistics QgsRectangle extent; }; #endif diff --git a/src/core/raster/qgsrasterblock.h b/src/core/raster/qgsrasterblock.h index c4a254bd20c..e2862ffbdf3 100644 --- a/src/core/raster/qgsrasterblock.h +++ b/src/core/raster/qgsrasterblock.h @@ -79,7 +79,7 @@ class CORE_EXPORT QgsRasterBlock */ bool isValid() const { return mValid; } - /** \brief Mark block as valid or invalid */ + //! \brief Mark block as valid or invalid void setValid( bool valid ) { mValid = valid; } /** Returns true if block is empty, i.e. its size is 0 (zero rows or cols). @@ -130,16 +130,16 @@ class CORE_EXPORT QgsRasterBlock return typeSize( mDataType ); } - /** Returns true if data type is numeric */ + //! Returns true if data type is numeric static bool typeIsNumeric( Qgis::DataType type ); - /** Returns true if data type is color */ + //! Returns true if data type is color static bool typeIsColor( Qgis::DataType type ); - /** Returns data type */ + //! Returns data type Qgis::DataType dataType() const { return mDataType; } - /** For given data type returns wider type and sets no data value */ + //! For given data type returns wider type and sets no data value static Qgis::DataType typeWithNoDataValue( Qgis::DataType dataType, double *noDataValue ); /** True if the block has no data value. @@ -322,10 +322,10 @@ class CORE_EXPORT QgsRasterBlock * @@note added in 2.3 */ void applyScaleOffset( double scale, double offset ); - /** \brief Get error */ + //! \brief Get error QgsError error() const { return mError; } - /** \brief Set error */ + //! \brief Set error void setError( const QgsError & theError ) { mError = theError;} QString toString() const; diff --git a/src/core/raster/qgsrasterdataprovider.h b/src/core/raster/qgsrasterdataprovider.h index 6560e7499dc..c7014fbb0f2 100644 --- a/src/core/raster/qgsrasterdataprovider.h +++ b/src/core/raster/qgsrasterdataprovider.h @@ -54,9 +54,9 @@ class CORE_EXPORT QgsImageFetcher : public QObject { Q_OBJECT public: - /** Constructor */ + //! Constructor QgsImageFetcher( QObject* parent = 0 ) : QObject( parent ) {} - /** Destructor */ + //! Destructor virtual ~QgsImageFetcher() {} /** Starts the image download @@ -67,9 +67,9 @@ class CORE_EXPORT QgsImageFetcher : public QObject /** Emitted when the download completes * @param legend The downloaded legend image */ void finish( const QImage& legend ); - /** Emitted to report progress */ + //! Emitted to report progress void progress( qint64 received, qint64 total ); - /** Emitted when an error occurs */ + //! Emitted when an error occurs void error( const QString& msg ); }; @@ -104,7 +104,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast virtual QgsRectangle extent() const override = 0; - /** Returns data type for the band specified by number */ + //! Returns data type for the band specified by number virtual Qgis::DataType dataType( int bandNo ) const override = 0; /** Returns source data type for the band specified by number, @@ -112,7 +112,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast */ virtual Qgis::DataType sourceDataType( int bandNo ) const override = 0; - /** Returns data type for the band specified by number */ + //! Returns data type for the band specified by number virtual int colorInterpretation( int theBandNo ) const { Q_UNUSED( theBandNo ); @@ -179,7 +179,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast return QStringLiteral( "Unknown" ); } } - /** Reload data (data could change) */ + //! Reload data (data could change) virtual bool reload() { return true; } virtual QString colorInterpretationName( int theBandNo ) const @@ -198,24 +198,24 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast // TODO: remove or make protected all readBlock working with void* - /** Read block of data using given extent and size. */ + //! Read block of data using given extent and size. virtual QgsRasterBlock *block( int theBandNo, const QgsRectangle &theExtent, int theWidth, int theHeight, QgsRasterBlockFeedback* feedback = nullptr ) override; - /** Return true if source band has no data value */ + //! Return true if source band has no data value virtual bool sourceHasNoDataValue( int bandNo ) const { return mSrcHasNoDataValue.value( bandNo -1 ); } - /** \brief Get source nodata value usage */ + //! \brief Get source nodata value usage virtual bool useSourceNoDataValue( int bandNo ) const { return mUseSrcNoDataValue.value( bandNo -1 ); } - /** \brief Set source nodata value usage */ + //! \brief Set source nodata value usage virtual void setUseSourceNoDataValue( int bandNo, bool use ); - /** Value representing no data value. */ + //! Value representing no data value. virtual double sourceNoDataValue( int bandNo ) const { return mSrcNoDataValue.value( bandNo -1 ); } virtual void setUserNoDataValue( int bandNo, const QgsRasterRangeList& noData ); - /** Get list of user no data value ranges */ + //! Get list of user no data value ranges virtual QgsRasterRangeList userNoDataValues( int bandNo ) const { return mUserNoDataValue.value( bandNo -1 ); } virtual QList colorTable( int bandNo ) const @@ -228,7 +228,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast return QStringList(); } - /** \brief Returns whether the provider supplies a legend graphic */ + //! \brief Returns whether the provider supplies a legend graphic virtual bool supportsLegendGraphic() const { return false; } /** \brief Returns the legend rendered as pixmap @@ -266,7 +266,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast return nullptr; } - /** \brief Create pyramid overviews */ + //! \brief Create pyramid overviews virtual QString buildPyramids( const QList & thePyramidList, const QString & theResamplingMethod = "NEAREST", QgsRaster::RasterPyramidsFormat theFormat = QgsRaster::PyramidsGTiff, @@ -289,7 +289,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast virtual QList buildPyramidList( QList overviewList = QList() ) // clazy:exclude=function-args-by-ref { Q_UNUSED( overviewList ); return QList(); } - /** \brief Returns true if raster has at least one populated histogram. */ + //! \brief Returns true if raster has at least one populated histogram. bool hasPyramids(); /** @@ -346,22 +346,22 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast */ virtual QString lastError() = 0; - /** Returns the format of the error text for the last error in this provider */ + //! Returns the format of the error text for the last error in this provider virtual QString lastErrorFormat(); - /** Returns the dpi of the output device. */ + //! Returns the dpi of the output device. int dpi() const { return mDpi; } - /** Sets the output device resolution. */ + //! Sets the output device resolution. void setDpi( int dpi ) { mDpi = dpi; } - /** Time stamp of data source in the moment when data/metadata were loaded by provider */ + //! Time stamp of data source in the moment when data/metadata were loaded by provider virtual QDateTime timestamp() const override { return mTimestamp; } - /** Current time stamp of data source */ + //! Current time stamp of data source virtual QDateTime dataTimestamp() const override { return QDateTime(); } - /** Writes into the provider datasource*/ + //! Writes into the provider datasource // TODO: add data type (may be defferent from band type) virtual bool write( void* data, int band, int width, int height, int xOffset, int yOffset ) { @@ -374,7 +374,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast return false; } - /** Creates a new dataset with mDataSourceURI */ + //! Creates a new dataset with mDataSourceURI static QgsRasterDataProvider* create( const QString &providerKey, const QString &uri, const QString& format, int nBands, @@ -389,7 +389,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast */ virtual bool setNoDataValue( int bandNo, double noDataValue ) { Q_UNUSED( bandNo ); Q_UNUSED( noDataValue ); return false; } - /** Remove dataset*/ + //! Remove dataset virtual bool remove() { return false; } /** Returns a list of pyramid resampling method name and label pairs @@ -440,10 +440,10 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast virtual void readBlock( int bandNo, QgsRectangle const & viewExtent, int width, int height, void *data, QgsRasterBlockFeedback* feedback = nullptr ) { Q_UNUSED( bandNo ); Q_UNUSED( viewExtent ); Q_UNUSED( width ); Q_UNUSED( height ); Q_UNUSED( data ); Q_UNUSED( feedback ); } - /** Returns true if user no data contains value */ + //! Returns true if user no data contains value bool userNoDataValuesContains( int bandNo, double value ) const; - /** Copy member variables from other raster data provider. Useful for implementation of clone() method in subclasses */ + //! Copy member variables from other raster data provider. Useful for implementation of clone() method in subclasses void copyBaseSettings( const QgsRasterDataProvider& other ); //! @note not available in Python bindings @@ -460,10 +460,10 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast * is available. Used internally only */ //bool hasNoDataValue ( int theBandNo ); - /** \brief Cell value representing original source no data. e.g. -9999, indexed from 0 */ + //! \brief Cell value representing original source no data. e.g. -9999, indexed from 0 QList mSrcNoDataValue; - /** \brief Source no data value exists. */ + //! \brief Source no data value exists. QList mSrcHasNoDataValue; /** \brief Use source nodata value. User can disable usage of source nodata diff --git a/src/core/raster/qgsrasterfilewriter.h b/src/core/raster/qgsrasterfilewriter.h index 98b469775ab..8e446e454ca 100644 --- a/src/core/raster/qgsrasterfilewriter.h +++ b/src/core/raster/qgsrasterfilewriter.h @@ -133,7 +133,7 @@ class CORE_EXPORT QgsRasterFileWriter void addToVRT( const QString& filename, int band, int xSize, int ySize, int xOffset, int yOffset ); void buildPyramids( const QString& filename ); - /** Create provider and datasource for a part image (vrt mode)*/ + //! Create provider and datasource for a part image (vrt mode) QgsRasterDataProvider* createPartProvider( const QgsRectangle& extent, int nCols, int iterCols, int iterRows, int iterLeft, int iterTop, const QString& outputUrl, int fileIndex, int nBands, Qgis::DataType type, @@ -154,7 +154,7 @@ class CORE_EXPORT QgsRasterFileWriter Qgis::DataType type, const QList& destHasNoDataValueList = QList(), const QList& destNoDataValueList = QList() ); - /** Calculate nRows, geotransform and pixel size for output*/ + //! Calculate nRows, geotransform and pixel size for output void globalOutputParameters( const QgsRectangle& extent, int nCols, int& nRows, double* geoTransform, double& pixelSize ); QString partFileName( int fileIndex ); @@ -167,7 +167,7 @@ class CORE_EXPORT QgsRasterFileWriter QStringList mCreateOptions; QgsCoordinateReferenceSystem mOutputCRS; - /** False: Write one file, true: create a directory and add the files numbered*/ + //! False: Write one file, true: create a directory and add the files numbered bool mTiledMode; double mMaxTileWidth; double mMaxTileHeight; diff --git a/src/core/raster/qgsrasterhistogram.h b/src/core/raster/qgsrasterhistogram.h index 011a206b446..474274bb692 100644 --- a/src/core/raster/qgsrasterhistogram.h +++ b/src/core/raster/qgsrasterhistogram.h @@ -45,7 +45,7 @@ class CORE_EXPORT QgsRasterHistogram valid = false; } - /** Compares region, size etc. not histogram itself */ + //! Compares region, size etc. not histogram itself bool operator==( const QgsRasterHistogram &h ) const { return ( h.bandNumber == bandNumber && @@ -58,16 +58,16 @@ class CORE_EXPORT QgsRasterHistogram h.height == height ); } - /** \brief The gdal band number (starts at 1)*/ + //! \brief The gdal band number (starts at 1) int bandNumber; - /** \brief Number of bins (intervals,buckets) in histogram. */ + //! \brief Number of bins (intervals,buckets) in histogram. int binCount; - /** \brief The number of non NULL cells used to calculate histogram. */ + //! \brief The number of non NULL cells used to calculate histogram. int nonNullCount; - /** \brief Whether histogram includes out of range values (in first and last bin) */ + //! \brief Whether histogram includes out of range values (in first and last bin) bool includeOutOfRange; /** \brief Store the histogram for a given layer @@ -75,22 +75,22 @@ class CORE_EXPORT QgsRasterHistogram */ HistogramVector histogramVector; - /** \brief The maximum histogram value. */ + //! \brief The maximum histogram value. double maximum; - /** \brief The minimum histogram value. */ + //! \brief The minimum histogram value. double minimum; - /** \brief Number of columns used to calc histogram */ + //! \brief Number of columns used to calc histogram int width; - /** \brief Number of rows used to calc histogram */ + //! \brief Number of rows used to calc histogram int height; - /** \brief Extent used to calc histogram */ + //! \brief Extent used to calc histogram QgsRectangle extent; - /** \brief Histogram is valid */ + //! \brief Histogram is valid bool valid; }; #endif diff --git a/src/core/raster/qgsrasteridentifyresult.h b/src/core/raster/qgsrasteridentifyresult.h index 08117a4b293..c9ca82a5419 100644 --- a/src/core/raster/qgsrasteridentifyresult.h +++ b/src/core/raster/qgsrasteridentifyresult.h @@ -43,10 +43,10 @@ class CORE_EXPORT QgsRasterIdentifyResult virtual ~QgsRasterIdentifyResult(); - /** \brief Returns true if valid */ + //! \brief Returns true if valid bool isValid() const { return mValid; } - /** \brief Get results format */ + //! \brief Get results format QgsRaster::IdentifyFormat format() const { return mFormat; } /** \brief Get results. Results are different for each format: @@ -56,34 +56,34 @@ class CORE_EXPORT QgsRasterIdentifyResult */ QMap results() const { return mResults; } - /** Set map of optional parameters */ + //! Set map of optional parameters void setParams( const QMap & theParams ) { mParams = theParams; } - /** Get map of optional parameters */ + //! Get map of optional parameters QMap params() const { return mParams; } - /** \brief Get error */ + //! \brief Get error QgsError error() const { return mError; } - /** \brief Set error */ + //! \brief Set error void setError( const QgsError & theError ) { mError = theError;} private: - /** \brief Is valid */ + //! \brief Is valid bool mValid; - /** \brief Results format */ + //! \brief Results format QgsRaster::IdentifyFormat mFormat; - /** \brief Results */ + //! \brief Results // TODO: better hierarchy (sublayer multiple feature sets)? // TODO?: results are not consistent for different formats (per band x per sublayer) QMap mResults; - /** \brief Additional params (e.g. request url used by WMS) */ + //! \brief Additional params (e.g. request url used by WMS) QMap mParams; - /** \brief Error */ + //! \brief Error QgsError mError; }; diff --git a/src/core/raster/qgsrasterinterface.h b/src/core/raster/qgsrasterinterface.h index f87161533c9..0cfd85d98a3 100644 --- a/src/core/raster/qgsrasterinterface.h +++ b/src/core/raster/qgsrasterinterface.h @@ -96,10 +96,10 @@ class CORE_EXPORT QgsRasterInterface virtual ~QgsRasterInterface(); - /** Clone itself, create deep copy */ + //! Clone itself, create deep copy virtual QgsRasterInterface *clone() const = 0; - /** Returns a bitmask containing the supported capabilities */ + //! Returns a bitmask containing the supported capabilities virtual int capabilities() const { return QgsRasterInterface::NoCapabilities; @@ -110,7 +110,7 @@ class CORE_EXPORT QgsRasterInterface */ QString capabilitiesString() const; - /** Returns data type for the band specified by number */ + //! Returns data type for the band specified by number virtual Qgis::DataType dataType( int bandNo ) const = 0; /** Returns source data type for the band specified by number, @@ -125,18 +125,18 @@ class CORE_EXPORT QgsRasterInterface int dataTypeSize( int bandNo ) { return QgsRasterBlock::typeSize( dataType( bandNo ) ); } - /** Get number of bands */ + //! Get number of bands virtual int bandCount() const = 0; - /** Get block size */ + //! Get block size virtual int xBlockSize() const { return mInput ? mInput->xBlockSize() : 0; } virtual int yBlockSize() const { return mInput ? mInput->yBlockSize() : 0; } - /** Get raster size */ + //! Get raster size virtual int xSize() const { return mInput ? mInput->xSize() : 0; } virtual int ySize() const { return mInput ? mInput->ySize() : 0; } - /** \brief helper function to create zero padded band names */ + //! \brief helper function to create zero padded band names virtual QString generateBandName( int theBandNumber ) const { return tr( "Band" ) + QStringLiteral( " %1" ) .arg( theBandNumber, 1 + static_cast< int >( log10( static_cast< double >( bandCount() ) ) ), 10, QChar( '0' ) ); @@ -157,13 +157,13 @@ class CORE_EXPORT QgsRasterInterface * Returns true if set correctly, false if cannot use that input */ virtual bool setInput( QgsRasterInterface* input ) { mInput = input; return true; } - /** Current input */ + //! Current input virtual QgsRasterInterface * input() const { return mInput; } - /** Is on/off */ + //! Is on/off virtual bool on() const { return mOn; } - /** Set on/off */ + //! Set on/off virtual void setOn( bool on ) { mOn = on; } /** Get source / raw input, the first in pipe, usually provider. @@ -253,19 +253,19 @@ class CORE_EXPORT QgsRasterInterface const QgsRectangle & theExtent = QgsRectangle(), int theSampleSize = 0 ); - /** Write base class members to xml. */ + //! Write base class members to xml. virtual void writeXml( QDomDocument& doc, QDomElement& parentElem ) const { Q_UNUSED( doc ); Q_UNUSED( parentElem ); } - /** Sets base class members from xml. Usually called from create() methods of subclasses */ + //! Sets base class members from xml. Usually called from create() methods of subclasses virtual void readXml( const QDomElement& filterElem ) { Q_UNUSED( filterElem ); } protected: // QgsRasterInterface used as input QgsRasterInterface* mInput; - /** \brief List of cached statistics, all bands mixed */ + //! \brief List of cached statistics, all bands mixed QList mStatistics; - /** \brief List of cached histograms, all bands mixed */ + //! \brief List of cached histograms, all bands mixed QList mHistograms; // On/off state, if off, it does not do anything, replicates input @@ -282,7 +282,7 @@ class CORE_EXPORT QgsRasterInterface int theSampleSize = 0, bool theIncludeOutOfRange = false ); - /** Fill in statistics defaults if not specified */ + //! Fill in statistics defaults if not specified void initStatistics( QgsRasterBandStats &theStatistics, int theBandNo, int theStats = QgsRasterBandStats::All, const QgsRectangle & theExtent = QgsRectangle(), diff --git a/src/core/raster/qgsrasteriterator.h b/src/core/raster/qgsrasteriterator.h index 525a020e84f..63f6586242d 100644 --- a/src/core/raster/qgsrasteriterator.h +++ b/src/core/raster/qgsrasteriterator.h @@ -86,7 +86,7 @@ class CORE_EXPORT QgsRasterIterator int mMaximumTileWidth; int mMaximumTileHeight; - /** Remove part into and release memory*/ + //! Remove part into and release memory void removePartInfo( int bandNumber ); }; diff --git a/src/core/raster/qgsrasterlayer.h b/src/core/raster/qgsrasterlayer.h index 1723cbf9448..a1409172ebb 100644 --- a/src/core/raster/qgsrasterlayer.h +++ b/src/core/raster/qgsrasterlayer.h @@ -136,16 +136,16 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer { Q_OBJECT public: - /** \brief Default cumulative cut lower limit */ + //! \brief Default cumulative cut lower limit static const double CUMULATIVE_CUT_LOWER; - /** \brief Default cumulative cut upper limit */ + //! \brief Default cumulative cut upper limit static const double CUMULATIVE_CUT_UPPER; - /** \brief Default sample size (number of pixels) for estimated statistics/histogram calculation */ + //! \brief Default sample size (number of pixels) for estimated statistics/histogram calculation static const double SAMPLE_SIZE; - /** \brief Constructor. Provider is not set. */ + //! \brief Constructor. Provider is not set. QgsRasterLayer(); /** \brief This is the constructor for the RasterLayer class. @@ -173,16 +173,16 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer //as the previous constructor will be called with the literal for providerKey //implicitly converted to a bool. //for QGIS 3.0, make either constructor explicit or alter the signatures - /** \brief [ data provider interface ] Constructor in provider mode */ + //! \brief [ data provider interface ] Constructor in provider mode QgsRasterLayer( const QString &uri, const QString &baseName, const QString &providerKey, bool loadDefaultStyleFlag = true ); - /** \brief The destructor */ + //! \brief The destructor ~QgsRasterLayer(); - /** \brief This enumerator describes the types of shading that can be used */ + //! \brief This enumerator describes the types of shading that can be used enum ColorShadingAlgorithm { UndefinedShader, @@ -192,7 +192,7 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer UserDefinedShader }; - /** \brief This enumerator describes the type of raster layer */ + //! \brief This enumerator describes the type of raster layer enum LayerType { GrayOrUndefined, @@ -209,41 +209,41 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer static bool isValidRasterFileName( const QString & theFileNameQString, QString &retError ); static bool isValidRasterFileName( const QString & theFileNameQString ); - /** Return time stamp for given file name */ + //! Return time stamp for given file name static QDateTime lastModified( const QString & name ); - /** [ data provider interface ] Set the data provider */ + //! [ data provider interface ] Set the data provider void setDataProvider( const QString & provider ); - /** \brief Accessor for raster layer type (which is a read only property) */ + //! \brief Accessor for raster layer type (which is a read only property) LayerType rasterType() { return mRasterType; } - /** Set raster renderer. Takes ownership of the renderer object*/ + //! Set raster renderer. Takes ownership of the renderer object void setRenderer( QgsRasterRenderer* theRenderer ); QgsRasterRenderer* renderer() const { return mPipe.renderer(); } - /** Set raster resample filter. Takes ownership of the resample filter object*/ + //! Set raster resample filter. Takes ownership of the resample filter object QgsRasterResampleFilter * resampleFilter() const { return mPipe.resampleFilter(); } QgsBrightnessContrastFilter * brightnessFilter() const { return mPipe.brightnessFilter(); } QgsHueSaturationFilter * hueSaturationFilter() const { return mPipe.hueSaturationFilter(); } - /** Get raster pipe */ + //! Get raster pipe QgsRasterPipe * pipe() { return &mPipe; } - /** \brief Accessor that returns the width of the (unclipped) raster */ + //! \brief Accessor that returns the width of the (unclipped) raster int width() const; - /** \brief Accessor that returns the height of the (unclipped) raster */ + //! \brief Accessor that returns the height of the (unclipped) raster int height() const; - /** \brief Get the number of bands in this layer */ + //! \brief Get the number of bands in this layer int bandCount() const; - /** \brief Get the name of a band given its number */ + //! \brief Get the name of a band given its number QString bandName( int theBandNoInt ) const; - /** Returns the data provider */ + //! Returns the data provider QgsRasterDataProvider* dataProvider(); /** Returns the data provider in a const-correct manner @@ -251,7 +251,7 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer */ const QgsRasterDataProvider* dataProvider() const; - /** Synchronises with changes in the datasource */ + //! Synchronises with changes in the datasource virtual void reload() override; /** Return new instance of QgsMapLayerRenderer that will be used for rendering of given context @@ -259,26 +259,26 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer */ virtual QgsMapLayerRenderer* createMapRenderer( QgsRenderContext& rendererContext ) override; - /** \brief This is an overloaded version of the draw() function that is called by both draw() and thumbnailAsPixmap */ + //! \brief This is an overloaded version of the draw() function that is called by both draw() and thumbnailAsPixmap void draw( QPainter * theQPainter, QgsRasterViewPort * myRasterViewPort, const QgsMapToPixel* theQgsMapToPixel = nullptr ); - /** Returns a list with classification items (Text and color) */ + //! Returns a list with classification items (Text and color) QgsLegendColorList legendSymbologyItems() const; virtual bool isSpatial() const override { return true; } - /** \brief Obtain GDAL Metadata for this layer */ + //! \brief Obtain GDAL Metadata for this layer QString metadata() const override; - /** \brief Get an 100x100 pixmap of the color palette. If the layer has no palette a white pixmap will be returned */ + //! \brief Get an 100x100 pixmap of the color palette. If the layer has no palette a white pixmap will be returned QPixmap paletteAsPixmap( int theBandNumber = 1 ); - /** \brief [ data provider interface ] Which provider is being used for this Raster Layer? */ + //! \brief [ data provider interface ] Which provider is being used for this Raster Layer? QString providerType() const; - /** \brief Returns the number of raster units per each raster pixel. In a world file, this is normally the first row (without the sign) */ + //! \brief Returns the number of raster units per each raster pixel. In a world file, this is normally the first row (without the sign) double rasterUnitsPerPixelX(); double rasterUnitsPerPixelY(); @@ -296,13 +296,13 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer int theSampleSize = SAMPLE_SIZE, bool theGenerateLookupTableFlag = true ); - /** \brief Set default contrast enhancement */ + //! \brief Set default contrast enhancement void setDefaultContrastEnhancement(); - /** \brief [ data provider interface ] A wrapper function to emit a progress update signal */ + //! \brief [ data provider interface ] A wrapper function to emit a progress update signal void showProgress( int theValue ); - /** \brief Returns the sublayers of this layer - Useful for providers that manage their own layers, such as WMS */ + //! \brief Returns the sublayers of this layer - Useful for providers that manage their own layers, such as WMS virtual QStringList subLayers() const override; /** \brief Draws a preview of the rasterlayer into a QImage @@ -323,64 +323,64 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer */ virtual void setSubLayerVisibility( const QString& name, bool vis ) override; - /** Time stamp of data source in the moment when data/metadata were loaded by provider */ + //! Time stamp of data source in the moment when data/metadata were loaded by provider virtual QDateTime timestamp() const override; public slots: void showStatusMessage( const QString & theMessage ); - /** \brief receive progress signal from provider */ + //! \brief receive progress signal from provider void onProgress( int, double, const QString& ); signals: - /** \brief Signal for notifying listeners of long running processes */ + //! \brief Signal for notifying listeners of long running processes void progressUpdate( int theValue ); protected: - /** \brief Read the symbology for the current layer from the Dom node supplied */ + //! \brief Read the symbology for the current layer from the Dom node supplied bool readSymbology( const QDomNode& node, QString& errorMessage ) override; - /** \brief Read the style information for the current layer from the Dom node supplied */ + //! \brief Read the style information for the current layer from the Dom node supplied bool readStyle( const QDomNode &node, QString &errorMessage ) override; - /** \brief Reads layer specific state from project file Dom node */ + //! \brief Reads layer specific state from project file Dom node bool readXml( const QDomNode& layer_node ) override; - /** \brief Write the symbology for the layer into the docment provided */ + //! \brief Write the symbology for the layer into the docment provided bool writeSymbology( QDomNode&, QDomDocument& doc, QString& errorMessage ) const override; - /** \brief Write the style for the layer into the docment provided */ + //! \brief Write the style for the layer into the docment provided bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const override; - /** \brief Write layer specific state to project file Dom node */ + //! \brief Write layer specific state to project file Dom node bool writeXml( QDomNode & layer_node, QDomDocument & doc ) const override; private: - /** \brief Initialize default values */ + //! \brief Initialize default values void init(); - /** \brief Close data provider and clear related members */ + //! \brief Close data provider and clear related members void closeDataProvider(); - /** \brief Update the layer if it is outdated */ + //! \brief Update the layer if it is outdated bool update(); - /** Sets corresponding renderer for style*/ + //! Sets corresponding renderer for style void setRendererForDrawingStyle( QgsRaster::DrawingStyle theDrawingStyle ); - /** \brief Constant defining flag for XML and a constant that signals property not used */ + //! \brief Constant defining flag for XML and a constant that signals property not used const QString QSTRING_NOT_SET; const QString TRSTRING_NOT_SET; - /** Pointer to data provider */ + //! Pointer to data provider QgsRasterDataProvider* mDataProvider; - /** [ data provider interface ] Timestamp, the last modified time of the data source when the layer was created */ + //! [ data provider interface ] Timestamp, the last modified time of the data source when the layer was created QDateTime mLastModified; QgsRasterViewPort mLastViewPort; - /** [ data provider interface ] Data provider key */ + //! [ data provider interface ] Data provider key QString mProviderKey; LayerType mRasterType; diff --git a/src/core/raster/qgsrasterlayerrenderer.h b/src/core/raster/qgsrasterlayerrenderer.h index 3f992941904..66528066343 100644 --- a/src/core/raster/qgsrasterlayerrenderer.h +++ b/src/core/raster/qgsrasterlayerrenderer.h @@ -71,9 +71,9 @@ class QgsRasterLayerRenderer : public QgsMapLayerRenderer //! when notified of new data in data provider it launches a preview draw of the raster virtual void onNewData() override; private: - QgsRasterLayerRenderer* mR; //!< parent renderer instance - int mMinimalPreviewInterval; //!< in miliseconds - QTime mLastPreview; //!< when last preview has been generated + QgsRasterLayerRenderer* mR; //!< Parent renderer instance + int mMinimalPreviewInterval; //!< In miliseconds + QTime mLastPreview; //!< When last preview has been generated }; //! feedback class for cancellation and preview generation diff --git a/src/core/raster/qgsrasternuller.h b/src/core/raster/qgsrasternuller.h index cacde254a96..e52f8a6dfc3 100644 --- a/src/core/raster/qgsrasternuller.h +++ b/src/core/raster/qgsrasternuller.h @@ -50,7 +50,7 @@ class CORE_EXPORT QgsRasterNuller : public QgsRasterInterface QgsRasterRangeList noData( int bandNo ) const { return mNoData.value( bandNo -1 ); } - /** \brief Set output no data value. */ + //! \brief Set output no data value. void setOutputNoDataValue( int bandNo, double noData ); private: diff --git a/src/core/raster/qgsrasterpipe.h b/src/core/raster/qgsrasterpipe.h index e9c2937a1ad..bf695b1baf5 100644 --- a/src/core/raster/qgsrasterpipe.h +++ b/src/core/raster/qgsrasterpipe.h @@ -77,10 +77,10 @@ class CORE_EXPORT QgsRasterPipe */ bool set( QgsRasterInterface * theInterface ); - /** Remove and delete interface at given index if possible */ + //! Remove and delete interface at given index if possible bool remove( int idx ); - /** Remove and delete interface from pipe if possible */ + //! Remove and delete interface from pipe if possible bool remove( QgsRasterInterface * theInterface ); int size() const { return mInterfaces.size(); } @@ -91,7 +91,7 @@ class CORE_EXPORT QgsRasterPipe * Returns true on success */ bool setOn( int idx, bool on ); - /** Test if interface at index may be swithed on/off */ + //! Test if interface at index may be swithed on/off bool canSetOn( int idx, bool on ); // Getters for special types of interfaces @@ -104,7 +104,7 @@ class CORE_EXPORT QgsRasterPipe QgsRasterNuller * nuller() const; private: - /** Get known parent type_info of interface parent */ + //! Get known parent type_info of interface parent Role interfaceRole( QgsRasterInterface * iface ) const; // Interfaces in pipe, the first is always provider @@ -121,7 +121,7 @@ class CORE_EXPORT QgsRasterPipe // Check if index is in bounds bool checkBounds( int idx ) const; - /** Get known interface by role */ + //! Get known interface by role QgsRasterInterface * interface( Role role ) const; /** \brief Try to connect interfaces in pipe and to the provider at beginning. diff --git a/src/core/raster/qgsrasterprojector.h b/src/core/raster/qgsrasterprojector.h index 05b087e9ca9..a4313294dee 100644 --- a/src/core/raster/qgsrasterprojector.h +++ b/src/core/raster/qgsrasterprojector.h @@ -55,7 +55,7 @@ class CORE_EXPORT QgsRasterProjector : public QgsRasterInterface QgsRasterProjector(); - /** \brief The destructor */ + //! \brief The destructor ~QgsRasterProjector(); QgsRasterProjector *clone() const override; @@ -64,14 +64,14 @@ class CORE_EXPORT QgsRasterProjector : public QgsRasterInterface Qgis::DataType dataType( int bandNo ) const override; - /** \brief set source and destination CRS */ + //! \brief set source and destination CRS void setCrs( const QgsCoordinateReferenceSystem & theSrcCRS, const QgsCoordinateReferenceSystem & theDestCRS, int srcDatumTransform = -1, int destDatumTransform = -1 ); - /** \brief Get source CRS */ + //! \brief Get source CRS QgsCoordinateReferenceSystem sourceCrs() const { return mSrcCRS; } - /** \brief Get destination CRS */ + //! \brief Get destination CRS QgsCoordinateReferenceSystem destinationCrs() const { return mDestCRS; } Precision precision() const { return mPrecision; } @@ -81,30 +81,30 @@ class CORE_EXPORT QgsRasterProjector : public QgsRasterInterface QgsRasterBlock *block( int bandNo, const QgsRectangle & extent, int width, int height, QgsRasterBlockFeedback* feedback = nullptr ) override; - /** Calculate destination extent and size from source extent and size */ + //! Calculate destination extent and size from source extent and size bool destExtentSize( const QgsRectangle& theSrcExtent, int theSrcXSize, int theSrcYSize, QgsRectangle& theDestExtent, int& theDestXSize, int& theDestYSize ); - /** Calculate destination extent and size from source extent and size */ + //! Calculate destination extent and size from source extent and size static bool extentSize( const QgsCoordinateTransform& ct, const QgsRectangle& theSrcExtent, int theSrcXSize, int theSrcYSize, QgsRectangle& theDestExtent, int& theDestXSize, int& theDestYSize ); private: - /** Source CRS */ + //! Source CRS QgsCoordinateReferenceSystem mSrcCRS; - /** Destination CRS */ + //! Destination CRS QgsCoordinateReferenceSystem mDestCRS; - /** Source datum transformation id (or -1 if none) */ + //! Source datum transformation id (or -1 if none) int mSrcDatumTransform; - /** Destination datum transformation id (or -1 if none) */ + //! Destination datum transformation id (or -1 if none) int mDestDatumTransform; - /** Requested precision */ + //! Requested precision Precision mPrecision; }; @@ -119,7 +119,7 @@ class CORE_EXPORT QgsRasterProjector : public QgsRasterInterface class ProjectorData { public: - /** Initialize reprojector and calculate matrix */ + //! Initialize reprojector and calculate matrix ProjectorData( const QgsRectangle &extent, int width, int height, QgsRasterInterface *input, const QgsCoordinateTransform &inverseCt, QgsRasterProjector::Precision precision ); ~ProjectorData(); @@ -137,38 +137,38 @@ class ProjectorData ProjectorData( const ProjectorData& other ); ProjectorData& operator=( const ProjectorData& other ); - /** \brief get destination point for _current_ destination position */ + //! \brief get destination point for _current_ destination position void destPointOnCPMatrix( int theRow, int theCol, double *theX, double *theY ); - /** \brief Get matrix upper left row/col indexes for destination row/col */ + //! \brief Get matrix upper left row/col indexes for destination row/col int matrixRow( int theDestRow ); int matrixCol( int theDestCol ); - /** \brief Get precise source row and column indexes for current source extent and resolution */ + //! \brief Get precise source row and column indexes for current source extent and resolution inline bool preciseSrcRowCol( int theDestRow, int theDestCol, int *theSrcRow, int *theSrcCol ); - /** \brief Get approximate source row and column indexes for current source extent and resolution */ + //! \brief Get approximate source row and column indexes for current source extent and resolution inline bool approximateSrcRowCol( int theDestRow, int theDestCol, int *theSrcRow, int *theSrcCol ); - /** \brief insert rows to matrix */ + //! \brief insert rows to matrix void insertRows( const QgsCoordinateTransform& ct ); - /** \brief insert columns to matrix */ + //! \brief insert columns to matrix void insertCols( const QgsCoordinateTransform& ct ); - /** Calculate single control point in current matrix */ + //! Calculate single control point in current matrix void calcCP( int theRow, int theCol, const QgsCoordinateTransform& ct ); - /** \brief calculate matrix row */ + //! \brief calculate matrix row bool calcRow( int theRow, const QgsCoordinateTransform& ct ); - /** \brief calculate matrix column */ + //! \brief calculate matrix column bool calcCol( int theCol, const QgsCoordinateTransform& ct ); - /** \brief calculate source extent */ + //! \brief calculate source extent void calcSrcExtent(); - /** \brief calculate minimum source width and height */ + //! \brief calculate minimum source width and height void calcSrcRowsCols(); /** \brief check error along columns @@ -179,88 +179,88 @@ class ProjectorData * returns true if within threshold */ bool checkRows( const QgsCoordinateTransform& ct ); - /** Calculate array of src helper points */ + //! Calculate array of src helper points void calcHelper( int theMatrixRow, QgsPoint *thePoints ); - /** Calc / switch helper */ + //! Calc / switch helper void nextHelper(); - /** Get mCPMatrix as string */ + //! Get mCPMatrix as string QString cpToString(); /** Use approximation (requested precision is Approximate and it is possible to calculate * an approximation matrix with a sufficient precision) */ bool mApproximate; - /** Transformation from destination CRS to source CRS */ + //! Transformation from destination CRS to source CRS QgsCoordinateTransform* mInverseCt; - /** Destination extent */ + //! Destination extent QgsRectangle mDestExtent; - /** Source extent */ + //! Source extent QgsRectangle mSrcExtent; - /** Source raster extent */ + //! Source raster extent QgsRectangle mExtent; - /** Number of destination rows */ + //! Number of destination rows int mDestRows; - /** Number of destination columns */ + //! Number of destination columns int mDestCols; - /** Destination x resolution */ + //! Destination x resolution double mDestXRes; - /** Destination y resolution */ + //! Destination y resolution double mDestYRes; - /** Number of source rows */ + //! Number of source rows int mSrcRows; - /** Number of source columns */ + //! Number of source columns int mSrcCols; - /** Source x resolution */ + //! Source x resolution double mSrcXRes; - /** Source y resolution */ + //! Source y resolution double mSrcYRes; - /** Number of destination rows per matrix row */ + //! Number of destination rows per matrix row double mDestRowsPerMatrixRow; - /** Number of destination cols per matrix col */ + //! Number of destination cols per matrix col double mDestColsPerMatrixCol; - /** Grid of source control points */ + //! Grid of source control points QList< QList > mCPMatrix; - /** Grid of source control points transformation possible indicator */ + //! Grid of source control points transformation possible indicator /* Same size as mCPMatrix */ QList< QList > mCPLegalMatrix; - /** Array of source points for each destination column on top of current CPMatrix grid row */ + //! Array of source points for each destination column on top of current CPMatrix grid row /* Warning: using QList is slow on access */ QgsPoint *pHelperTop; - /** Array of source points for each destination column on bottom of current CPMatrix grid row */ + //! Array of source points for each destination column on bottom of current CPMatrix grid row /* Warning: using QList is slow on access */ QgsPoint *pHelperBottom; - /** Current mHelperTop matrix row */ + //! Current mHelperTop matrix row int mHelperTopRow; - /** Number of mCPMatrix columns */ + //! Number of mCPMatrix columns int mCPCols; - /** Number of mCPMatrix rows */ + //! Number of mCPMatrix rows int mCPRows; - /** Maximum tolerance in destination units */ + //! Maximum tolerance in destination units double mSqrTolerance; - /** Maximum source resolution */ + //! Maximum source resolution double mMaxSrcXRes; double mMaxSrcYRes; diff --git a/src/core/raster/qgsrasterpyramid.h b/src/core/raster/qgsrasterpyramid.h index 9021075ca51..eeacd6a4182 100644 --- a/src/core/raster/qgsrasterpyramid.h +++ b/src/core/raster/qgsrasterpyramid.h @@ -23,15 +23,15 @@ class CORE_EXPORT QgsRasterPyramid { public: - /** \brief The pyramid level as implemented in gdal (level 2 is half orignal raster size etc) */ + //! \brief The pyramid level as implemented in gdal (level 2 is half orignal raster size etc) int level; - /** \brief XDimension for this pyramid layer */ + //! \brief XDimension for this pyramid layer int xDim; - /** \brief YDimension for this pyramid layer */ + //! \brief YDimension for this pyramid layer int yDim; - /** \brief Whether the pyramid layer has been built yet */ + //! \brief Whether the pyramid layer has been built yet bool exists; - /** \brief Whether the pyramid should be built */ + //! \brief Whether the pyramid should be built bool build; QgsRasterPyramid() diff --git a/src/core/raster/qgsrasterrenderer.h b/src/core/raster/qgsrasterrenderer.h index d6ef8b9c8bb..c32be311932 100644 --- a/src/core/raster/qgsrasterrenderer.h +++ b/src/core/raster/qgsrasterrenderer.h @@ -81,10 +81,10 @@ class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface void setAlphaBand( int band ) { mAlphaBand = band; } int alphaBand() const { return mAlphaBand; } - /** Get symbology items if provided by renderer*/ + //! Get symbology items if provided by renderer virtual void legendSymbologyItems( QList< QPair< QString, QColor > >& symbolItems ) const { Q_UNUSED( symbolItems ); } - /** Sets base class members from xml. Usually called from create() methods of subclasses*/ + //! Sets base class members from xml. Usually called from create() methods of subclasses void readXml( const QDomElement& rendererElem ) override; /** Copies common properties like opacity / transparency data from other renderer. @@ -92,7 +92,7 @@ class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface * @note added in 2.16 */ void copyCommonProperties( const QgsRasterRenderer* other ); - /** Returns a list of band numbers used by the renderer*/ + //! Returns a list of band numbers used by the renderer virtual QList usesBands() const { return QList(); } static QString minMaxOriginName( int theOrigin ); @@ -101,14 +101,14 @@ class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface protected: - /** Write upper class info into rasterrenderer element (called by writeXml method of subclasses)*/ + //! Write upper class info into rasterrenderer element (called by writeXml method of subclasses) void _writeXml( QDomDocument& doc, QDomElement& rasterRendererElem ) const; QString mType; - /** Global alpha value (0-1)*/ + //! Global alpha value (0-1) double mOpacity; - /** Raster transparency per color or value. Overwrites global alpha value*/ + //! Raster transparency per color or value. Overwrites global alpha value QgsRasterTransparency* mRasterTransparency; /** Read alpha value from band. Is combined with value from raster transparency / global alpha value. Default: -1 (not set)*/ diff --git a/src/core/raster/qgsrasterresamplefilter.h b/src/core/raster/qgsrasterresamplefilter.h index d0b6ca44d93..6020cc95bcd 100644 --- a/src/core/raster/qgsrasterresamplefilter.h +++ b/src/core/raster/qgsrasterresamplefilter.h @@ -43,11 +43,11 @@ class CORE_EXPORT QgsRasterResampleFilter : public QgsRasterInterface QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback* feedback = nullptr ) override; - /** Set resampler for zoomed in scales. Takes ownership of the object*/ + //! Set resampler for zoomed in scales. Takes ownership of the object void setZoomedInResampler( QgsRasterResampler* r ); const QgsRasterResampler* zoomedInResampler() const { return mZoomedInResampler; } - /** Set resampler for zoomed out scales. Takes ownership of the object*/ + //! Set resampler for zoomed out scales. Takes ownership of the object void setZoomedOutResampler( QgsRasterResampler* r ); const QgsRasterResampler* zoomedOutResampler() const { return mZoomedOutResampler; } @@ -56,16 +56,16 @@ class CORE_EXPORT QgsRasterResampleFilter : public QgsRasterInterface void writeXml( QDomDocument& doc, QDomElement& parentElem ) const override; - /** Sets base class members from xml. Usually called from create() methods of subclasses*/ + //! Sets base class members from xml. Usually called from create() methods of subclasses void readXml( const QDomElement& filterElem ) override; protected: - /** Resampler used if screen resolution is higher than raster resolution (zoomed in). 0 means no resampling (nearest neighbour)*/ + //! Resampler used if screen resolution is higher than raster resolution (zoomed in). 0 means no resampling (nearest neighbour) QgsRasterResampler* mZoomedInResampler; - /** Resampler used if raster resolution is higher than raster resolution (zoomed out). 0 mean no resampling (nearest neighbour)*/ + //! Resampler used if raster resolution is higher than raster resolution (zoomed out). 0 mean no resampling (nearest neighbour) QgsRasterResampler* mZoomedOutResampler; - /** Maximum boundary for oversampling (to avoid too much data traffic). Default: 2.0*/ + //! Maximum boundary for oversampling (to avoid too much data traffic). Default: 2.0 double mMaxOversampling; private: diff --git a/src/core/raster/qgsrastershader.h b/src/core/raster/qgsrastershader.h index 4d4ee3b4086..e797923a14b 100644 --- a/src/core/raster/qgsrastershader.h +++ b/src/core/raster/qgsrastershader.h @@ -39,10 +39,10 @@ class CORE_EXPORT QgsRasterShader * Non-Static Inline methods * */ - /** \brief Return the maximum value for the raster shader */ + //! \brief Return the maximum value for the raster shader double maximumValue() { return mMaximumValue; } - /** \brief Return the minimum value for the raster shader */ + //! \brief Return the minimum value for the raster shader double minimumValue() { return mMinimumValue; } QgsRasterShaderFunction* rasterShaderFunction() { return mRasterShaderFunction; } @@ -53,20 +53,20 @@ class CORE_EXPORT QgsRasterShader * Non-Static methods * */ - /** \brief generates and new RGBA value based on one input value */ + //! \brief generates and new RGBA value based on one input value bool shade( double, int*, int*, int*, int* ); - /** \brief generates and new RGBA value based on original RGBA value */ + //! \brief generates and new RGBA value based on original RGBA value bool shade( double, double, double, double, int*, int*, int*, int* ); /** \brief A public method that allows the user to set their own shader function \note Raster shader takes ownership of the shader function instance */ void setRasterShaderFunction( QgsRasterShaderFunction* ); - /** \brief Set the maximum value */ + //! \brief Set the maximum value void setMaximumValue( double ); - /** \brief Return the minimum value */ + //! \brief Return the minimum value void setMinimumValue( double ); void writeXml( QDomDocument& doc, QDomElement& parent ) const; @@ -74,13 +74,13 @@ class CORE_EXPORT QgsRasterShader void readXml( const QDomElement& elem ); private: - /** \brief User defineable minimum value for the raster shader */ + //! \brief User defineable minimum value for the raster shader double mMinimumValue; - /** \brief user defineable maximum value for the raster shader */ + //! \brief user defineable maximum value for the raster shader double mMaximumValue; - /** \brief Pointer to the shader function */ + //! \brief Pointer to the shader function QgsRasterShaderFunction* mRasterShaderFunction; QgsRasterShader( const QgsRasterShader& rh ); diff --git a/src/core/raster/qgsrastershaderfunction.h b/src/core/raster/qgsrastershaderfunction.h index e388d4a60b3..a42896d4361 100644 --- a/src/core/raster/qgsrastershaderfunction.h +++ b/src/core/raster/qgsrastershaderfunction.h @@ -34,16 +34,16 @@ class CORE_EXPORT QgsRasterShaderFunction QgsRasterShaderFunction( double theMinimumValue = 0.0, double theMaximumValue = 255.0 ); virtual ~QgsRasterShaderFunction() {} - /** \brief Set the maximum value */ + //! \brief Set the maximum value virtual void setMaximumValue( double ); - /** \brief Return the minimum value */ + //! \brief Return the minimum value virtual void setMinimumValue( double ); - /** \brief generates and new RGBA value based on one input value */ + //! \brief generates and new RGBA value based on one input value virtual bool shade( double, int*, int*, int*, int* ); - /** \brief generates and new RGBA value based on original RGBA value */ + //! \brief generates and new RGBA value based on original RGBA value virtual bool shade( double, double, double, double, int*, int*, int*, int* ); double minimumMaximumRange() const { return mMinimumMaximumRange; } @@ -54,13 +54,13 @@ class CORE_EXPORT QgsRasterShaderFunction virtual void legendSymbologyItems( QList< QPair< QString, QColor > >& symbolItems ) const { Q_UNUSED( symbolItems ); } protected: - /** \brief User defineable maximum value for the shading function */ + //! \brief User defineable maximum value for the shading function double mMaximumValue; - /** \brief User defineable minimum value for the shading function */ + //! \brief User defineable minimum value for the shading function double mMinimumValue; - /** \brief Minimum maximum range for the shading function */ + //! \brief Minimum maximum range for the shading function double mMinimumMaximumRange; }; #endif diff --git a/src/core/raster/qgsrastertransparency.h b/src/core/raster/qgsrastertransparency.h index 9aa54fcae45..680e09a5ab7 100644 --- a/src/core/raster/qgsrastertransparency.h +++ b/src/core/raster/qgsrastertransparency.h @@ -53,31 +53,31 @@ class CORE_EXPORT QgsRasterTransparency // // Initializer, Accessor and mutator for transparency tables. // - /** \brief Accessor for transparentSingleValuePixelList */ + //! \brief Accessor for transparentSingleValuePixelList QList transparentSingleValuePixelList() const; - /** \brief Accessor for transparentThreeValuePixelList */ + //! \brief Accessor for transparentThreeValuePixelList QList transparentThreeValuePixelList() const; - /** \brief Reset to the transparency list to a single value */ + //! \brief Reset to the transparency list to a single value void initializeTransparentPixelList( double ); - /** \brief Reset to the transparency list to a single value */ + //! \brief Reset to the transparency list to a single value void initializeTransparentPixelList( double, double, double ); - /** \brief Mutator for transparentSingleValuePixelList */ + //! \brief Mutator for transparentSingleValuePixelList void setTransparentSingleValuePixelList( const QList& theNewList ); - /** \brief Mutator for transparentThreeValuePixelList */ + //! \brief Mutator for transparentThreeValuePixelList void setTransparentThreeValuePixelList( const QList& theNewList ); - /** \brief Returns the transparency value for a single value Pixel */ + //! \brief Returns the transparency value for a single value Pixel int alphaValue( double, int theGlobalTransparency = 255 ) const; - /** \brief Return the transparency value for a RGB Pixel */ + //! \brief Return the transparency value for a RGB Pixel int alphaValue( double, double, double, int theGlobalTransparency = 255 ) const; - /** True if there are no entries in the pixel lists except the nodata value*/ + //! True if there are no entries in the pixel lists except the nodata value bool isEmpty() const; void writeXml( QDomDocument& doc, QDomElement& parentElem ) const; @@ -85,10 +85,10 @@ class CORE_EXPORT QgsRasterTransparency void readXml( const QDomElement& elem ); private: - /** \brief The list to hold transparency values for RGB layers */ + //! \brief The list to hold transparency values for RGB layers QList mTransparentThreeValuePixelList; - /** \brief The list to hold transparency values for single value pixel layers */ + //! \brief The list to hold transparency values for single value pixel layers QList mTransparentSingleValuePixelList; }; diff --git a/src/core/raster/qgsrasterviewport.h b/src/core/raster/qgsrasterviewport.h index b34e1d7a69c..cb85baaa617 100644 --- a/src/core/raster/qgsrasterviewport.h +++ b/src/core/raster/qgsrasterviewport.h @@ -38,20 +38,20 @@ struct QgsRasterViewPort * of the part of the raster that is to be rendered.*/ QgsPoint mBottomRightPoint; - /** \brief Width, number of columns to be rendered */ + //! \brief Width, number of columns to be rendered int mWidth; /** \brief Distance in map units from bottom edge to top edge for the part of * the raster that is to be rendered.*/ - /** \brief Height, number of rows to be rendered */ + //! \brief Height, number of rows to be rendered int mHeight; - /** \brief Intersection of current map extent and layer extent */ + //! \brief Intersection of current map extent and layer extent QgsRectangle mDrawnExtent; - /** \brief Source coordinate system */ + //! \brief Source coordinate system QgsCoordinateReferenceSystem mSrcCRS; - /** \brief Target coordinate system */ + //! \brief Target coordinate system QgsCoordinateReferenceSystem mDestCRS; int mSrcDatumTransform; diff --git a/src/core/raster/qgssinglebandgrayrenderer.h b/src/core/raster/qgssinglebandgrayrenderer.h index 146e369ee52..3b5d1296d09 100644 --- a/src/core/raster/qgssinglebandgrayrenderer.h +++ b/src/core/raster/qgssinglebandgrayrenderer.h @@ -46,7 +46,7 @@ class CORE_EXPORT QgsSingleBandGrayRenderer: public QgsRasterRenderer int grayBand() const { return mGrayBand; } void setGrayBand( int band ) { mGrayBand = band; } const QgsContrastEnhancement* contrastEnhancement() const { return mContrastEnhancement; } - /** Takes ownership*/ + //! Takes ownership void setContrastEnhancement( QgsContrastEnhancement* ce ); void setGradient( Gradient theGradient ) { mGradient = theGradient; } diff --git a/src/core/raster/qgssinglebandpseudocolorrenderer.h b/src/core/raster/qgssinglebandpseudocolorrenderer.h index 4764ad417ab..59b64b29288 100644 --- a/src/core/raster/qgssinglebandpseudocolorrenderer.h +++ b/src/core/raster/qgssinglebandpseudocolorrenderer.h @@ -29,7 +29,7 @@ class QgsRasterShader; class CORE_EXPORT QgsSingleBandPseudoColorRenderer: public QgsRasterRenderer { public: - /** Note: takes ownership of QgsRasterShader*/ + //! Note: takes ownership of QgsRasterShader QgsSingleBandPseudoColorRenderer( QgsRasterInterface* input, int band, QgsRasterShader* shader ); ~QgsSingleBandPseudoColorRenderer(); QgsSingleBandPseudoColorRenderer * clone() const override; @@ -38,7 +38,7 @@ class CORE_EXPORT QgsSingleBandPseudoColorRenderer: public QgsRasterRenderer QgsRasterBlock* block( int bandNo, const QgsRectangle & extent, int width, int height, QgsRasterBlockFeedback* feedback = nullptr ) override; - /** Takes ownership of the shader*/ + //! Takes ownership of the shader void setShader( QgsRasterShader* shader ); QgsRasterShader* shader() { return mShader; } //! @note available in python as constShader diff --git a/src/core/symbology-ng/qgsarrowsymbollayer.h b/src/core/symbology-ng/qgsarrowsymbollayer.h index 0ab107f04e3..3b3beb8b7c4 100644 --- a/src/core/symbology-ng/qgsarrowsymbollayer.h +++ b/src/core/symbology-ng/qgsarrowsymbollayer.h @@ -28,7 +28,7 @@ class CORE_EXPORT QgsArrowSymbolLayer : public QgsLineSymbolLayer { public: - /** Simple constructor */ + //! Simple constructor QgsArrowSymbolLayer(); /** @@ -45,69 +45,69 @@ class CORE_EXPORT QgsArrowSymbolLayer : public QgsLineSymbolLayer virtual bool setSubSymbol( QgsSymbol* symbol ) override; virtual QSet usedAttributes() const override; - /** Get current arrow width */ + //! Get current arrow width double arrowWidth() const { return mArrowWidth; } - /** Set the arrow width */ + //! Set the arrow width void setArrowWidth( double width ) { mArrowWidth = width; } - /** Get the unit for the arrow width */ + //! Get the unit for the arrow width QgsUnitTypes::RenderUnit arrowWidthUnit() const { return mArrowWidthUnit; } - /** Set the unit for the arrow width */ + //! Set the unit for the arrow width void setArrowWidthUnit( QgsUnitTypes::RenderUnit unit ) { mArrowWidthUnit = unit; } - /** Get the scale for the arrow width */ + //! Get the scale for the arrow width QgsMapUnitScale arrowWidthUnitScale() const { return mArrowWidthUnitScale; } - /** Set the scale for the arrow width */ + //! Set the scale for the arrow width void setArrowWidthUnitScale( const QgsMapUnitScale& scale ) { mArrowWidthUnitScale = scale; } - /** Get current arrow start width. Only meaningfull for single headed arrows */ + //! Get current arrow start width. Only meaningfull for single headed arrows double arrowStartWidth() const { return mArrowStartWidth; } - /** Set the arrow start width */ + //! Set the arrow start width void setArrowStartWidth( double width ) { mArrowStartWidth = width; } - /** Get the unit for the arrow start width */ + //! Get the unit for the arrow start width QgsUnitTypes::RenderUnit arrowStartWidthUnit() const { return mArrowStartWidthUnit; } - /** Set the unit for the arrow start width */ + //! Set the unit for the arrow start width void setArrowStartWidthUnit( QgsUnitTypes::RenderUnit unit ) { mArrowStartWidthUnit = unit; } - /** Get the scale for the arrow start width */ + //! Get the scale for the arrow start width QgsMapUnitScale arrowStartWidthUnitScale() const { return mArrowStartWidthUnitScale; } - /** Set the scale for the arrow start width */ + //! Set the scale for the arrow start width void setArrowStartWidthUnitScale( const QgsMapUnitScale& scale ) { mArrowStartWidthUnitScale = scale; } - /** Get the current arrow head length */ + //! Get the current arrow head length double headLength() const { return mHeadLength; } - /** Set the arrow head length */ + //! Set the arrow head length void setHeadLength( double length ) { mHeadLength = length; } - /** Get the unit for the head length */ + //! Get the unit for the head length QgsUnitTypes::RenderUnit headLengthUnit() const { return mHeadLengthUnit; } - /** Set the unit for the head length */ + //! Set the unit for the head length void setHeadLengthUnit( QgsUnitTypes::RenderUnit unit ) { mHeadLengthUnit = unit; } - /** Get the scale for the head length */ + //! Get the scale for the head length QgsMapUnitScale headLengthUnitScale() const { return mHeadLengthUnitScale; } - /** Set the scale for the head length */ + //! Set the scale for the head length void setHeadLengthUnitScale( const QgsMapUnitScale& scale ) { mHeadLengthUnitScale = scale; } - /** Get the current arrow head height */ + //! Get the current arrow head height double headThickness() const { return mHeadThickness; } - /** Set the arrow head height */ + //! Set the arrow head height void setHeadThickness( double thickness ) { mHeadThickness = thickness; } - /** Get the unit for the head height */ + //! Get the unit for the head height QgsUnitTypes::RenderUnit headThicknessUnit() const { return mHeadThicknessUnit; } - /** Set the unit for the head height */ + //! Set the unit for the head height void setHeadThicknessUnit( QgsUnitTypes::RenderUnit unit ) { mHeadThicknessUnit = unit; } - /** Get the scale for the head height */ + //! Get the scale for the head height QgsMapUnitScale headThicknessUnitScale() const { return mHeadThicknessUnitScale; } - /** Set the scale for the head height */ + //! Set the scale for the head height void setHeadThicknessUnitScale( const QgsMapUnitScale& scale ) { mHeadThicknessUnitScale = scale; } - /** Return whether it is a curved arrow or a straight one */ + //! Return whether it is a curved arrow or a straight one bool isCurved() const { return mIsCurved; } - /** Set whether it is a curved arrow or a straight one */ + //! Set whether it is a curved arrow or a straight one void setIsCurved( bool isCurved ) { mIsCurved = isCurved; } - /** Return whether the arrow is repeated along the line or not */ + //! Return whether the arrow is repeated along the line or not bool isRepeated() const { return mIsRepeated; } - /** Set whether the arrow is repeated along the line */ + //! Set whether the arrow is repeated along the line void setIsRepeated( bool isRepeated ) { mIsRepeated = isRepeated; } - /** Possible head types */ + //! Possible head types enum HeadType { HeadSingle, //< One single head at the end @@ -115,12 +115,12 @@ class CORE_EXPORT QgsArrowSymbolLayer : public QgsLineSymbolLayer HeadDouble //< Two heads }; - /** Get the current head type */ + //! Get the current head type HeadType headType() const { return mHeadType; } - /** Set the head type */ + //! Set the head type void setHeadType( HeadType type ) { mHeadType = type; } - /** Possible arrow types */ + //! Possible arrow types enum ArrowType { ArrowPlain, //< Regular arrow @@ -128,9 +128,9 @@ class CORE_EXPORT QgsArrowSymbolLayer : public QgsLineSymbolLayer ArrowRightHalf //< Halved arrow, only the right side of the arrow is rendered (for straight arrows) or the side toward the interior (for curved arrows) }; - /** Get the current arrow type */ + //! Get the current arrow type ArrowType arrowType() const { return mArrowType; } - /** Set the arrow type */ + //! Set the arrow type void setArrowType( ArrowType type ) { mArrowType = type; } QgsStringMap properties() const override; @@ -142,7 +142,7 @@ class CORE_EXPORT QgsArrowSymbolLayer : public QgsLineSymbolLayer virtual QColor color() const override; private: - /** Filling sub symbol */ + //! Filling sub symbol QScopedPointer mSymbol; double mArrowWidth; diff --git a/src/core/symbology-ng/qgscategorizedsymbolrenderer.h b/src/core/symbology-ng/qgscategorizedsymbolrenderer.h index 4921c92bcf6..5a79df10cb1 100644 --- a/src/core/symbology-ng/qgscategorizedsymbolrenderer.h +++ b/src/core/symbology-ng/qgscategorizedsymbolrenderer.h @@ -212,7 +212,7 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer private: - /** Returns calculated classification value for a feature */ + //! Returns calculated classification value for a feature QVariant valueForFeature( QgsFeature& feature, QgsRenderContext &context ) const; }; diff --git a/src/core/symbology-ng/qgscptcityarchive.h b/src/core/symbology-ng/qgscptcityarchive.h index 03c64f98b44..14639e4b49b 100644 --- a/src/core/symbology-ng/qgscptcityarchive.h +++ b/src/core/symbology-ng/qgscptcityarchive.h @@ -351,13 +351,13 @@ class CORE_EXPORT QgsCptCityBrowserModel : public QAbstractItemModel virtual QModelIndex parent( const QModelIndex &index ) const override; - /** Returns a list of mime that can describe model indexes */ + //! Returns a list of mime that can describe model indexes /* virtual QStringList mimeTypes() const; */ - /** Returns an object that contains serialized items of data corresponding to the list of indexes specified */ + //! Returns an object that contains serialized items of data corresponding to the list of indexes specified /* virtual QMimeData * mimeData( const QModelIndexList &indexes ) const; */ - /** Handles the data supplied by a drag and drop operation that ended with the given action */ + //! Handles the data supplied by a drag and drop operation that ended with the given action /* virtual bool dropMimeData( const QMimeData * data, Qt::DropAction action, int row, int column, const QModelIndex & parent ); */ QgsCptCityDataItem *dataItem( const QModelIndex &idx ) const; diff --git a/src/core/symbology-ng/qgsfillsymbollayer.h b/src/core/symbology-ng/qgsfillsymbollayer.h index 837a32af348..1ab62a53512 100644 --- a/src/core/symbology-ng/qgsfillsymbollayer.h +++ b/src/core/symbology-ng/qgsfillsymbollayer.h @@ -221,11 +221,11 @@ class CORE_EXPORT QgsGradientFillSymbolLayer : public QgsFillSymbolLayer double estimateMaxBleed() const override; - /** Type of gradient, eg linear or radial*/ + //! Type of gradient, eg linear or radial GradientType gradientType() const { return mGradientType; } void setGradientType( GradientType gradientType ) { mGradientType = gradientType; } - /** Gradient color mode, controls how gradient color stops are created*/ + //! Gradient color mode, controls how gradient color stops are created GradientColorType gradientColorType() const { return mGradientColorType; } void setGradientColorType( GradientColorType gradientColorType ) { mGradientColorType = gradientColorType; } @@ -244,39 +244,39 @@ class CORE_EXPORT QgsGradientFillSymbolLayer : public QgsFillSymbolLayer */ void setColorRamp( QgsColorRamp* ramp ); - /** Color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor*/ + //! Color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor QColor color2() const { return mColor2; } void setColor2( const QColor& color2 ) { mColor2 = color2; } - /** Coordinate mode for gradient. Controls how the gradient stops are positioned.*/ + //! Coordinate mode for gradient. Controls how the gradient stops are positioned. GradientCoordinateMode coordinateMode() const { return mCoordinateMode; } void setCoordinateMode( GradientCoordinateMode coordinateMode ) { mCoordinateMode = coordinateMode; } - /** Gradient spread mode. Controls how the gradient behaves outside of the predefined stops*/ + //! Gradient spread mode. Controls how the gradient behaves outside of the predefined stops GradientSpread gradientSpread() const { return mGradientSpread; } void setGradientSpread( GradientSpread gradientSpread ) { mGradientSpread = gradientSpread; } - /** Starting point of gradient fill, in the range [0,0] - [1,1]*/ + //! Starting point of gradient fill, in the range [0,0] - [1,1] void setReferencePoint1( QPointF referencePoint ) { mReferencePoint1 = referencePoint; } QPointF referencePoint1() const { return mReferencePoint1; } - /** Sets the starting point of the gradient to be the feature centroid*/ + //! Sets the starting point of the gradient to be the feature centroid void setReferencePoint1IsCentroid( bool isCentroid ) { mReferencePoint1IsCentroid = isCentroid; } bool referencePoint1IsCentroid() const { return mReferencePoint1IsCentroid; } - /** End point of gradient fill, in the range [0,0] - [1,1]*/ + //! End point of gradient fill, in the range [0,0] - [1,1] void setReferencePoint2( QPointF referencePoint ) { mReferencePoint2 = referencePoint; } QPointF referencePoint2() const { return mReferencePoint2; } - /** Sets the end point of the gradient to be the feature centroid*/ + //! Sets the end point of the gradient to be the feature centroid void setReferencePoint2IsCentroid( bool isCentroid ) { mReferencePoint2IsCentroid = isCentroid; } bool referencePoint2IsCentroid() const { return mReferencePoint2IsCentroid; } - /** Offset for gradient fill*/ + //! Offset for gradient fill void setOffset( QPointF offset ) { mOffset = offset; } QPointF offset() const { return mOffset; } - /** Units for gradient fill offset*/ + //! Units for gradient fill offset void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } @@ -314,13 +314,13 @@ class CORE_EXPORT QgsGradientFillSymbolLayer : public QgsFillSymbolLayer //helper functions for data defined symbology void applyDataDefinedSymbology( QgsSymbolRenderContext& context, const QPolygonF& points ); - /** Applies the gradient to a brush*/ + //! Applies the gradient to a brush void applyGradient( const QgsSymbolRenderContext& context, QBrush& brush, const QColor& color, const QColor& color2, GradientColorType gradientColorType, QgsColorRamp *gradientRamp, GradientType gradientType, GradientCoordinateMode coordinateMode, GradientSpread gradientSpread, QPointF referencePoint1, QPointF referencePoint2, const double angle ); - /** Rotates a reference point by a specified angle around the point (0.5, 0.5)*/ + //! Rotates a reference point by a specified angle around the point (0.5, 0.5) QPointF rotateReferencePoint( QPointF refPoint, double angle ); }; @@ -616,12 +616,12 @@ class CORE_EXPORT QgsImageFillSymbolLayer: public QgsFillSymbolLayer QBrush mBrush; double mNextAngle; // mAngle / data defined angle - /** Outline width*/ + //! Outline width double mOutlineWidth; QgsUnitTypes::RenderUnit mOutlineWidthUnit; QgsMapUnitScale mOutlineWidthMapUnitScale; - /** Custom outline*/ + //! Custom outline QgsLineSymbol* mOutline; virtual void applyDataDefinedSettings( QgsSymbolRenderContext& context ) { Q_UNUSED( context ); } @@ -789,7 +789,7 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer protected: - /** Path to the image file*/ + //! Path to the image file QString mImageFilePath; FillCoordinateMode mCoordinateMode; double mAlpha; @@ -806,7 +806,7 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer private: - /** Applies the image pattern to the brush*/ + //! Applies the image pattern to the brush void applyPattern( QBrush& brush, const QString& imageFilePath, const double width, const double alpha, const QgsSymbolRenderContext& context ); }; @@ -886,18 +886,18 @@ class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer QgsMapUnitScale mapUnitScale() const override; protected: - /** Width of the pattern (in output units)*/ + //! Width of the pattern (in output units) double mPatternWidth; QgsUnitTypes::RenderUnit mPatternWidthUnit; QgsMapUnitScale mPatternWidthMapUnitScale; - /** SVG data*/ + //! SVG data QByteArray mSvgData; - /** Path to the svg file (or empty if constructed directly from data)*/ + //! Path to the svg file (or empty if constructed directly from data) QString mSvgFilePath; - /** SVG view box (to keep the aspect ratio */ + //! SVG view box (to keep the aspect ratio QRectF mSvgViewBox; - /** SVG pattern image */ + //! SVG pattern image QImage* mSvgPattern; //param(fill), param(outline), param(outline-width) are going @@ -910,11 +910,11 @@ class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer void applyDataDefinedSettings( QgsSymbolRenderContext& context ) override; private: - /** Helper function that gets the view box from the byte array*/ + //! Helper function that gets the view box from the byte array void storeViewBox(); void setDefaultSvgParams(); //fills mSvgFillColor, mSvgOutlineColor, mSvgOutlineWidth with default values for mSvgFilePath - /** Applies the svg pattern to the brush*/ + //! Applies the svg pattern to the brush void applyPattern( QBrush& brush, const QString& svgFilePath, double patternWidth, QgsUnitTypes::RenderUnit patternWidthUnit, const QColor& svgFillColor, const QColor& svgOutlineColor, double svgOutlineWidth, QgsUnitTypes::RenderUnit svgOutlineWidthUnit, const QgsSymbolRenderContext& context, const QgsMapUnitScale& patternWidthMapUnitScale, const QgsMapUnitScale &svgOutlineWidthMapUnitScale ); }; @@ -1027,18 +1027,18 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer QSet usedAttributes() const override; protected: - /** Distance (in mm or map units) between lines*/ + //! Distance (in mm or map units) between lines double mDistance; QgsUnitTypes::RenderUnit mDistanceUnit; QgsMapUnitScale mDistanceMapUnitScale; - /** Line width (in mm or map units)*/ + //! Line width (in mm or map units) double mLineWidth; QgsUnitTypes::RenderUnit mLineWidthUnit; QgsMapUnitScale mLineWidthMapUnitScale; QColor mColor; - /** Vector line angle in degrees (0 = horizontal, counterclockwise)*/ + //! Vector line angle in degrees (0 = horizontal, counterclockwise) double mLineAngle; - /** Offset perpendicular to line direction*/ + //! Offset perpendicular to line direction double mOffset; QgsUnitTypes::RenderUnit mOffsetUnit; QgsMapUnitScale mOffsetMapUnitScale; @@ -1046,10 +1046,10 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer void applyDataDefinedSettings( QgsSymbolRenderContext& context ) override; private: - /** Applies the svg pattern to the brush*/ + //! Applies the svg pattern to the brush void applyPattern( const QgsSymbolRenderContext& context, QBrush& brush, double lineAngle, double distance, double lineWidth, const QColor& color ); - /** Fill line*/ + //! Fill line QgsLineSymbol* mFillLineSymbol; }; diff --git a/src/core/symbology-ng/qgsheatmaprenderer.h b/src/core/symbology-ng/qgsheatmaprenderer.h index 70cea65df7d..0f80d7e442f 100644 --- a/src/core/symbology-ng/qgsheatmaprenderer.h +++ b/src/core/symbology-ng/qgsheatmaprenderer.h @@ -166,9 +166,9 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer void setWeightExpression( const QString& expression ) { mWeightExpressionString = expression; } private: - /** Private copy constructor. @see clone() */ + //! Private copy constructor. @see clone() QgsHeatmapRenderer( const QgsHeatmapRenderer& ); - /** Private assignment operator. @see clone() */ + //! Private assignment operator. @see clone() QgsHeatmapRenderer& operator=( const QgsHeatmapRenderer& ); QVector mValues; diff --git a/src/core/symbology-ng/qgsinvertedpolygonrenderer.h b/src/core/symbology-ng/qgsinvertedpolygonrenderer.h index a7e510acff2..0c5b152274c 100644 --- a/src/core/symbology-ng/qgsinvertedpolygonrenderer.h +++ b/src/core/symbology-ng/qgsinvertedpolygonrenderer.h @@ -70,9 +70,9 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer virtual QString dump() const override; - /** Proxy that will call this method on the embedded renderer. */ + //! Proxy that will call this method on the embedded renderer. virtual QSet usedAttributes() const override; - /** Proxy that will call this method on the embedded renderer. */ + //! Proxy that will call this method on the embedded renderer. virtual Capabilities capabilities() override; /** Proxy that will call this method on the embedded renderer. */ @@ -89,7 +89,7 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer /** Proxy that will call this method on the embedded renderer. */ virtual QgsSymbolList originalSymbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override; - /** Proxy that will call this method on the embedded renderer. */ + //! Proxy that will call this method on the embedded renderer. virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize ) override; /** Proxy that will call this method on the embedded renderer. * @note not available in python bindings @@ -99,7 +99,7 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer */ virtual bool willRenderFeature( QgsFeature& feat, QgsRenderContext& context ) override; - /** Creates a renderer out of an XML, for loading*/ + //! Creates a renderer out of an XML, for loading static QgsFeatureRenderer* create( QDomElement& element ); virtual QDomElement save( QDomDocument& doc ) override; @@ -113,7 +113,7 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer virtual bool legendSymbolItemChecked( const QString& key ) override; virtual void checkLegendSymbolItem( const QString& key, bool state = true ) override; - /** @returns true if the geometries are to be preprocessed (merged with an union) before rendering.*/ + //! @returns true if the geometries are to be preprocessed (merged with an union) before rendering. bool preprocessingEnabled() const { return mPreprocessingEnabled; } /** * @param enabled enables or disables the preprocessing. @@ -130,34 +130,34 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer static QgsInvertedPolygonRenderer* convertFromRenderer( const QgsFeatureRenderer* renderer ); private: - /** Private copy constructor. @see clone() */ + //! Private copy constructor. @see clone() QgsInvertedPolygonRenderer( const QgsInvertedPolygonRenderer& ); - /** Private assignment operator. @see clone() */ + //! Private assignment operator. @see clone() QgsInvertedPolygonRenderer& operator=( const QgsInvertedPolygonRenderer& ); - /** Embedded renderer */ + //! Embedded renderer QScopedPointer mSubRenderer; - /** Structure where the reversed geometry is built during renderFeature */ + //! Structure where the reversed geometry is built during renderFeature struct CombinedFeature { QList geometries; //< list of geometries QgsFeature feature; //< one feature (for attriute-based rendering) }; typedef QVector FeatureCategoryVector; - /** Where features are stored, based on the index of their symbol category @see mSymbolCategories */ + //! Where features are stored, based on the index of their symbol category @see mSymbolCategories FeatureCategoryVector mFeaturesCategories; - /** Maps a category to an index */ + //! Maps a category to an index QMap mSymbolCategories; - /** The polygon used as exterior ring that covers the current extent */ + //! The polygon used as exterior ring that covers the current extent QgsPolygon mExtentPolygon; - /** The context used for rendering */ + //! The context used for rendering QgsRenderContext mContext; - /** Fields of each feature*/ + //! Fields of each feature QgsFields mFields; /** Class used to represent features that must be rendered @@ -178,7 +178,7 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer }; QList mFeatureDecorations; - /** Whether to preprocess (merge) geometries before rendering*/ + //! Whether to preprocess (merge) geometries before rendering bool mPreprocessingEnabled; }; diff --git a/src/core/symbology-ng/qgslinesymbollayer.h b/src/core/symbology-ng/qgslinesymbollayer.h index 690a73c4541..75f708916bd 100644 --- a/src/core/symbology-ng/qgslinesymbollayer.h +++ b/src/core/symbology-ng/qgslinesymbollayer.h @@ -128,7 +128,7 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer QgsUnitTypes::RenderUnit mCustomDashPatternUnit; QgsMapUnitScale mCustomDashPatternMapUnitScale; - /** Vector with an even number of entries for the */ + //! Vector with an even number of entries for the QVector mCustomDashVector; bool mDrawInsidePolygon; diff --git a/src/core/symbology-ng/qgsmarkersymbollayer.h b/src/core/symbology-ng/qgsmarkersymbollayer.h index 97bab79f6f6..8cd79819f6b 100644 --- a/src/core/symbology-ng/qgsmarkersymbollayer.h +++ b/src/core/symbology-ng/qgsmarkersymbollayer.h @@ -44,29 +44,29 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer //! Marker symbol shapes enum Shape { - Square, /*!< Square */ - Diamond, /*!< Diamond */ - Pentagon, /*!< Pentagon */ - Hexagon, /*!< Hexagon */ - Triangle, /*!< Triangle */ - EquilateralTriangle, /*!< Equilateral triangle*/ - Star, /*!< Star*/ - Arrow, /*!< Arrow*/ - Circle, /*!< Circle*/ - Cross, /*!< Cross (lines only)*/ - CrossFill, /*!< Solid filled cross*/ - Cross2, /*!< Rotated cross (lines only), "x" shape*/ - Line, /*!< Vertical line*/ - ArrowHead, /*!< Right facing arrow head (unfilled, lines only)*/ - ArrowHeadFilled, /*!< Right facing filled arrow head*/ - SemiCircle, /*!< Semi circle (top half)*/ - ThirdCircle, /*!< One third circle (top left third)*/ - QuarterCircle, /*!< Quarter circle (top left quarter)*/ - QuarterSquare, /*!< Quarter square (top left quarter)*/ - HalfSquare, /*!< Half square (left half)*/ - DiagonalHalfSquare, /*!< Diagonal half square (bottom left half)*/ - RightHalfTriangle, /*!< Right half of triangle*/ - LeftHalfTriangle, /*!< Left half of triangle*/ + Square, //!< Square + Diamond, //!< Diamond + Pentagon, //!< Pentagon + Hexagon, //!< Hexagon + Triangle, //!< Triangle + EquilateralTriangle, //!< Equilateral triangle + Star, //!< Star + Arrow, //!< Arrow + Circle, //!< Circle + Cross, //!< Cross (lines only) + CrossFill, //!< Solid filled cross + Cross2, //!< Rotated cross (lines only), "x" shape + Line, //!< Vertical line + ArrowHead, //!< Right facing arrow head (unfilled, lines only) + ArrowHeadFilled, //!< Right facing filled arrow head + SemiCircle, //!< Semi circle (top half) + ThirdCircle, //!< One third circle (top left third) + QuarterCircle, //!< Quarter circle (top left quarter) + QuarterSquare, //!< Quarter square (top left quarter) + HalfSquare, //!< Half square (left half) + DiagonalHalfSquare, //!< Diagonal half square (bottom left half) + RightHalfTriangle, //!< Right half of triangle + LeftHalfTriangle, //!< Left half of triangle }; //! Returns a list of all available shape types. diff --git a/src/core/symbology-ng/qgspointdisplacementrenderer.h b/src/core/symbology-ng/qgspointdisplacementrenderer.h index 8a1e5cfade7..eef22c2b1a4 100644 --- a/src/core/symbology-ng/qgspointdisplacementrenderer.h +++ b/src/core/symbology-ng/qgspointdisplacementrenderer.h @@ -32,8 +32,8 @@ class CORE_EXPORT QgsPointDisplacementRenderer: public QgsPointDistanceRenderer */ enum Placement { - Ring, /*!< Place points in a single ring around group*/ - ConcentricRings /*!< Place points in concentric rings around group*/ + Ring, //!< Place points in a single ring around group + ConcentricRings //!< Place points in concentric rings around group }; /** Constructor for QgsPointDisplacementRenderer. diff --git a/src/core/symbology-ng/qgsrenderer.h b/src/core/symbology-ng/qgsrenderer.h index 2aa547305c6..881ff8324cc 100644 --- a/src/core/symbology-ng/qgsrenderer.h +++ b/src/core/symbology-ng/qgsrenderer.h @@ -186,10 +186,10 @@ class CORE_EXPORT QgsFeatureRenderer */ enum Capability { - SymbolLevels = 1, //!< rendering with symbol levels (i.e. implements symbols(), symbolForFeature()) - MoreSymbolsPerFeature = 1 << 2, //!< may use more than one symbol to render a feature: symbolsForFeature() will return them - Filter = 1 << 3, //!< features may be filtered, i.e. some features may not be rendered (categorized, rule based ...) - ScaleDependent = 1 << 4 //!< depends on scale if feature will be rendered (rule based ) + SymbolLevels = 1, //!< Rendering with symbol levels (i.e. implements symbols(), symbolForFeature()) + MoreSymbolsPerFeature = 1 << 2, //!< May use more than one symbol to render a feature: symbolsForFeature() will return them + Filter = 1 << 3, //!< Features may be filtered, i.e. some features may not be rendered (categorized, rule based ...) + ScaleDependent = 1 << 4 //!< Depends on scale if feature will be rendered (rule based ) }; Q_DECLARE_FLAGS( Capabilities, Capability ) @@ -426,9 +426,9 @@ class CORE_EXPORT QgsFeatureRenderer bool mUsingSymbolLevels; - /** The current type of editing marker */ + //! The current type of editing marker int mCurrentVertexMarkerType; - /** The current size of editing marker */ + //! The current size of editing marker int mCurrentVertexMarkerSize; QgsPaintEffect* mPaintEffect; diff --git a/src/core/symbology-ng/qgsrendererregistry.h b/src/core/symbology-ng/qgsrendererregistry.h index d34c0f11e88..4ba5e199067 100644 --- a/src/core/symbology-ng/qgsrendererregistry.h +++ b/src/core/symbology-ng/qgsrendererregistry.h @@ -106,7 +106,7 @@ class CORE_EXPORT QgsRendererMetadata : public QgsRendererAbstractMetadata { public: - /** Construct metadata */ + //! Construct metadata //! @note not available in python bindings QgsRendererMetadata( const QString& name, const QString& visibleName, diff --git a/src/core/symbology-ng/qgssvgcache.h b/src/core/symbology-ng/qgssvgcache.h index d5c51881956..2bfddeba437 100644 --- a/src/core/symbology-ng/qgssvgcache.h +++ b/src/core/symbology-ng/qgssvgcache.h @@ -76,9 +76,9 @@ class CORE_EXPORT QgsSvgCacheEntry QgsSvgCacheEntry* nextEntry; QgsSvgCacheEntry* previousEntry; - /** Don't consider image, picture, last used timestamp for comparison*/ + //! Don't consider image, picture, last used timestamp for comparison bool operator==( const QgsSvgCacheEntry& other ) const; - /** Return memory usage in bytes*/ + //! Return memory usage in bytes int dataSize() const; private: @@ -172,15 +172,15 @@ class CORE_EXPORT QgsSvgCache : public QObject bool& hasOutlineWidthParam, bool& hasDefaultOutlineWidth, double& defaultOutlineWidth, bool& hasOutlineOpacityParam, bool& hasDefaultOutlineOpacity, double& defaultOutlineOpacity ) const; - /** Get image data*/ + //! Get image data QByteArray getImageData( const QString &path ) const; - /** Get SVG content*/ + //! Get SVG content const QByteArray& svgContent( const QString& file, double size, const QColor& fill, const QColor& outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor ); signals: - /** Emit a signal to be caught by qgisapp and display a msg on status bar */ + //! Emit a signal to be caught by qgisapp and display a msg on status bar void statusChanged( const QString& theStatusQString ); protected: @@ -203,11 +203,11 @@ class CORE_EXPORT QgsSvgCache : public QObject void replaceParamsAndCacheSvg( QgsSvgCacheEntry* entry ); void cacheImage( QgsSvgCacheEntry* entry ); void cachePicture( QgsSvgCacheEntry* entry, bool forceVectorOutput = false ); - /** Returns entry from cache or creates a new entry if it does not exist already*/ + //! Returns entry from cache or creates a new entry if it does not exist already QgsSvgCacheEntry* cacheEntry( const QString& file, double size, const QColor& fill, const QColor& outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor ); - /** Removes the least used items until the maximum size is under the limit*/ + //! Removes the least used items until the maximum size is under the limit void trimToMaximumSize(); //Removes entry from the ordered list (but does not delete the entry itself) @@ -217,9 +217,9 @@ class CORE_EXPORT QgsSvgCache : public QObject void downloadProgress( qint64, qint64 ); private: - /** Entry pointers accessible by file name*/ + //! Entry pointers accessible by file name QMultiHash< QString, QgsSvgCacheEntry* > mEntryLookup; - /** Estimated total size of all images, pictures and svgContent*/ + //! Estimated total size of all images, pictures and svgContent long mTotalSize; //The svg cache keeps the entries on a double connected list, moving the current entry to the front. @@ -230,7 +230,7 @@ class CORE_EXPORT QgsSvgCache : public QObject //Maximum cache size static const long mMaximumSize = 20000000; - /** Replaces parameters in elements of a dom node and calls method for all child nodes*/ + //! Replaces parameters in elements of a dom node and calls method for all child nodes void replaceElemParams( QDomElement& elem, const QColor& fill, const QColor& outline, double outlineWidth ); void containsElemParams( const QDomElement& elem, @@ -240,16 +240,16 @@ class CORE_EXPORT QgsSvgCache : public QObject bool& hasOutlineWidthParam, bool& hasDefaultOutlineWidth, double& defaultOutlineWidth, bool& hasOutlineOpacityParam, bool& hasDefaultOutlineOpacity, double& defaultOutlineOpacity ) const; - /** Calculates scaling for rendered image sizes to SVG logical sizes*/ + //! Calculates scaling for rendered image sizes to SVG logical sizes double calcSizeScaleFactor( QgsSvgCacheEntry* entry, const QDomElement& docElem, QSizeF& viewboxSize ) const; - /** Release memory and remove cache entry from mEntryLookup*/ + //! Release memory and remove cache entry from mEntryLookup void removeCacheEntry( const QString& s, QgsSvgCacheEntry* entry ); - /** For debugging*/ + //! For debugging void printEntryList(); - /** SVG content to be rendered if SVG file was not found. */ + //! SVG content to be rendered if SVG file was not found. QByteArray mMissingSvg; //! Mutex to prevent concurrent access to the class from multiple threads at once (may corrupt the entries otherwise). diff --git a/src/core/symbology-ng/qgssymbol.h b/src/core/symbology-ng/qgssymbol.h index eebca22f909..b5c7e0f4204 100644 --- a/src/core/symbology-ng/qgssymbol.h +++ b/src/core/symbology-ng/qgssymbol.h @@ -350,7 +350,7 @@ class CORE_EXPORT QgsSymbol SymbolType mType; QgsSymbolLayerList mLayers; - /** Symbol opacity (in the range 0 - 1)*/ + //! Symbol opacity (in the range 0 - 1) qreal mAlpha; RenderHints mRenderHints; @@ -707,9 +707,9 @@ class CORE_EXPORT QgsFillSymbol : public QgsSymbol private: void renderPolygonUsingLayer( QgsSymbolLayer* layer, const QPolygonF &points, QList *rings, QgsSymbolRenderContext &context ); - /** Calculates the bounds of a polygon including rings*/ + //! Calculates the bounds of a polygon including rings QRectF polygonBounds( const QPolygonF &points, const QList *rings ) const; - /** Translates the rings in a polygon by a set distance*/ + //! Translates the rings in a polygon by a set distance QList* translateRings( const QList *rings, double dx, double dy ) const; }; diff --git a/src/core/symbology-ng/qgssymbollayer.h b/src/core/symbology-ng/qgssymbollayer.h index 963d3f8393c..fd2693e1a88 100644 --- a/src/core/symbology-ng/qgssymbollayer.h +++ b/src/core/symbology-ng/qgssymbollayer.h @@ -406,17 +406,17 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer //! Symbol horizontal anchor points enum HorizontalAnchorPoint { - Left, /*!< Align to left side of symbol */ - HCenter, /*!< Align to horizontal center of symbol */ - Right, /*!< Align to right side of symbol */ + Left, //!< Align to left side of symbol + HCenter, //!< Align to horizontal center of symbol + Right, //!< Align to right side of symbol }; //! Symbol vertical anchor points enum VerticalAnchorPoint { - Top, /*!< Align to top of symbol */ - VCenter, /*!< Align to vertical center of symbol */ - Bottom, /*!< Align to bottom of symbol */ + Top, //!< Align to top of symbol + VCenter, //!< Align to vertical center of symbol + Bottom, //!< Align to bottom of symbol }; void startRender( QgsSymbolRenderContext& context ) override; @@ -754,7 +754,7 @@ class CORE_EXPORT QgsFillSymbolLayer : public QgsSymbolLayer protected: QgsFillSymbolLayer( bool locked = false ); - /** Default method to render polygon*/ + //! Default method to render polygon void _renderPolygon( QPainter* p, const QPolygonF& points, const QList* rings, QgsSymbolRenderContext& context ); double mAngle; diff --git a/src/core/symbology-ng/qgssymbollayerregistry.h b/src/core/symbology-ng/qgssymbollayerregistry.h index 3d11884da32..42ee998dd5f 100644 --- a/src/core/symbology-ng/qgssymbollayerregistry.h +++ b/src/core/symbology-ng/qgssymbollayerregistry.h @@ -42,11 +42,11 @@ class CORE_EXPORT QgsSymbolLayerAbstractMetadata QString visibleName() const { return mVisibleName; } QgsSymbol::SymbolType type() const { return mType; } - /** Create a symbol layer of this type given the map of properties. */ + //! Create a symbol layer of this type given the map of properties. virtual QgsSymbolLayer* createSymbolLayer( const QgsStringMap& map ) = 0; - /** Create widget for symbol layer of this type. Can return NULL if there's no GUI */ + //! Create widget for symbol layer of this type. Can return NULL if there's no GUI virtual QgsSymbolLayerWidget* createSymbolLayerWidget( const QgsVectorLayer * ) { return nullptr; } - /** Create a symbol layer of this type given the map of properties. */ + //! Create a symbol layer of this type given the map of properties. virtual QgsSymbolLayer* createSymbolLayerFromSld( QDomElement & ) { return nullptr; } diff --git a/src/core/symbology-ng/qgssymbollayerutils.h b/src/core/symbology-ng/qgssymbollayerutils.h index e3e81448c0c..743c02d4c0b 100644 --- a/src/core/symbology-ng/qgssymbollayerutils.h +++ b/src/core/symbology-ng/qgssymbollayerutils.h @@ -180,7 +180,7 @@ class CORE_EXPORT QgsSymbolLayerUtils //! @note customContext parameter added in 2.6 static QPixmap symbolPreviewPixmap( QgsSymbol* symbol, QSize size, QgsRenderContext* customContext = nullptr ); - /** Returns the maximum estimated bleed for the symbol */ + //! Returns the maximum estimated bleed for the symbol static double estimateMaxSymbolBleed( QgsSymbol* symbol ); /** Attempts to load a symbol from a DOM element @@ -281,7 +281,7 @@ class CORE_EXPORT QgsSymbolLayerUtils static void labelTextToSld( QDomDocument &doc, QDomElement &element, const QString& label, const QFont &font, const QColor& color = QColor(), double size = -1 ); - /** Create ogr feature style string for pen */ + //! Create ogr feature style string for pen static QString ogrFeatureStylePen( double width, double mmScaleFactor, double mapUnitsScaleFactor, const QColor& c, Qt::PenJoinStyle joinStyle = Qt::MiterJoin, Qt::PenCapStyle capStyle = Qt::FlatCap, @@ -485,19 +485,19 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static double convertFromMapUnits( const QgsRenderContext& context, double sizeInMapUnits, QgsUnitTypes::RenderUnit outputUnit ); - /** Returns scale factor painter units -> pixel dimensions*/ + //! Returns scale factor painter units -> pixel dimensions static double pixelSizeScaleFactor( const QgsRenderContext& c, QgsUnitTypes::RenderUnit u, const QgsMapUnitScale& scale = QgsMapUnitScale() ); - /** Returns scale factor painter units -> map units*/ + //! Returns scale factor painter units -> map units static double mapUnitScaleFactor( const QgsRenderContext& c, QgsUnitTypes::RenderUnit u, const QgsMapUnitScale& scale = QgsMapUnitScale() ); - /** Creates a render context for a pixel based device*/ + //! Creates a render context for a pixel based device static QgsRenderContext createRenderContext( QPainter* p ); - /** Multiplies opacity of image pixel values with a (global) transparency value*/ + //! Multiplies opacity of image pixel values with a (global) transparency value static void multiplyImageOpacity( QImage* image, qreal alpha ); - /** Blurs an image in place, e.g. creating Qt-independent drop shadows */ + //! Blurs an image in place, e.g. creating Qt-independent drop shadows static void blurImageInPlace( QImage& image, QRect rect, int radius, bool alphaOnly ); /** Converts a QColor into a premultiplied ARGB QColor value using a specified alpha value @@ -505,9 +505,9 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static void premultiplyColor( QColor& rgb, int alpha ); - /** Sorts the passed list in requested order*/ + //! Sorts the passed list in requested order static void sortVariantList( QList& list, Qt::SortOrder order ); - /** Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point*/ + //! Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point static QPointF pointOnLineWithDistance( QPointF startPoint, QPointF directionPoint, double distance ); //! Return a list of all available svg files diff --git a/src/core/symbology-ng/qgssymbologyconversion.h b/src/core/symbology-ng/qgssymbologyconversion.h index 7831b66be9d..39a3bdf2b3f 100644 --- a/src/core/symbology-ng/qgssymbologyconversion.h +++ b/src/core/symbology-ng/qgssymbologyconversion.h @@ -29,7 +29,7 @@ class CORE_EXPORT QgsSymbologyConversion { public: - /** Read old renderer definition from XML and create matching new renderer */ + //! Read old renderer definition from XML and create matching new renderer static QgsFeatureRenderer* readOldRenderer( const QDomNode& layerNode, QgsWkbTypes::GeometryType geomType ); static QString penStyle2QString( Qt::PenStyle penstyle ); diff --git a/src/gui/attributetable/qgsattributetablefiltermodel.h b/src/gui/attributetable/qgsattributetablefiltermodel.h index 5b4d4a3e9b8..37ff2886afb 100644 --- a/src/gui/attributetable/qgsattributetablefiltermodel.h +++ b/src/gui/attributetable/qgsattributetablefiltermodel.h @@ -194,7 +194,7 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub */ QString sortExpression() const; - /** Returns the map canvas*/ + //! Returns the map canvas QgsMapCanvas* mapCanvas() const { return mCanvas; } virtual QVariant data( const QModelIndex& index, int role ) const override; diff --git a/src/gui/attributetable/qgsattributetablemodel.h b/src/gui/attributetable/qgsattributetablemodel.h index 7296318b61b..ed2b16f89e7 100644 --- a/src/gui/attributetable/qgsattributetablemodel.h +++ b/src/gui/attributetable/qgsattributetablemodel.h @@ -347,12 +347,12 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel QgsFeatureRequest mFeatureRequest; - /** The currently cached column */ + //! The currently cached column QgsExpression mSortCacheExpression; QgsAttributeList mSortCacheAttributes; - /** If it is set, a simple field is used for sorting, if it's -1 it's the mSortCacheExpression*/ + //! If it is set, a simple field is used for sorting, if it's -1 it's the mSortCacheExpression int mSortFieldIndex; - /** Allows caching of one value per column (used for sorting) */ + //! Allows caching of one value per column (used for sorting) QHash mSortCache; /** diff --git a/src/gui/attributetable/qgsdualview.h b/src/gui/attributetable/qgsdualview.h index 588d1eb9964..d4090a9b7dc 100644 --- a/src/gui/attributetable/qgsdualview.h +++ b/src/gui/attributetable/qgsdualview.h @@ -312,9 +312,9 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas */ virtual void finished(); - /** Zooms to the active feature*/ + //! Zooms to the active feature void zoomToCurrentFeature(); - /** Pans to the active feature*/ + //! Pans to the active feature void panToCurrentFeature(); private: diff --git a/src/gui/attributetable/qgsfeaturelistview.h b/src/gui/attributetable/qgsfeaturelistview.h index bf74a03e887..d344e90f592 100644 --- a/src/gui/attributetable/qgsfeaturelistview.h +++ b/src/gui/attributetable/qgsfeaturelistview.h @@ -179,7 +179,7 @@ class GUI_EXPORT QgsFeatureListView : public QListView QgsFeatureSelectionModel* mFeatureSelectionModel; QgsIFeatureSelectionManager* mFeatureSelectionManager; QgsFeatureListViewDelegate* mItemDelegate; - bool mEditSelectionDrag; // Is set to true when the user initiated a left button click over an edit button and still keeps pressing /**< TODO */ + bool mEditSelectionDrag; // Is set to true when the user initiated a left button click over an edit button and still keeps pressing //!< TODO int mRowAnchor; QItemSelectionModel::SelectionFlags mCtrlDragSelectionFlag; }; diff --git a/src/gui/auth/qgsauthauthoritieseditor.h b/src/gui/auth/qgsauthauthoritieseditor.h index 465a3dbb7d4..135ffad8edc 100644 --- a/src/gui/auth/qgsauthauthoritieseditor.h +++ b/src/gui/auth/qgsauthauthoritieseditor.h @@ -50,10 +50,10 @@ class GUI_EXPORT QgsAuthAuthoritiesEditor : public QWidget, private Ui::QgsAuthA void showCertInfo( QTreeWidgetItem *item ); - /** Pass selection change on to UI update */ + //! Pass selection change on to UI update void selectionChanged( const QItemSelection& selected, const QItemSelection& deselected ); - /** Update UI based upon current selection */ + //! Update UI based upon current selection void checkSelection(); void handleDoubleClick( QTreeWidgetItem* item, int col ); @@ -76,11 +76,11 @@ class GUI_EXPORT QgsAuthAuthoritiesEditor : public QWidget, private Ui::QgsAuthA void showTrustedCertificateAuthorities(); - /** Relay messages to widget's messagebar */ + //! Relay messages to widget's messagebar void authMessageOut( const QString& message, const QString& authtag, QgsAuthManager::MessageLevel level ); protected: - /** Overridden show event of base widget */ + //! Overridden show event of base widget void showEvent( QShowEvent *e ) override; private: diff --git a/src/gui/auth/qgsauthcertificateinfo.h b/src/gui/auth/qgsauthcertificateinfo.h index 9b725db62d1..9b41540c435 100644 --- a/src/gui/auth/qgsauthcertificateinfo.h +++ b/src/gui/auth/qgsauthcertificateinfo.h @@ -155,7 +155,7 @@ class GUI_EXPORT QgsAuthCertInfoDialog : public QDialog const QList& connectionCAs = QList() ); ~QgsAuthCertInfoDialog(); - /** Get access to embedded info widget */ + //! Get access to embedded info widget QgsAuthCertInfo *certInfoWidget() { return mCertInfoWdgt; } /** Whether the trust cache has been rebuilt diff --git a/src/gui/auth/qgsauthcertificatemanager.h b/src/gui/auth/qgsauthcertificatemanager.h index 55b5994be0d..c38e7a66d71 100644 --- a/src/gui/auth/qgsauthcertificatemanager.h +++ b/src/gui/auth/qgsauthcertificatemanager.h @@ -59,7 +59,7 @@ class GUI_EXPORT QgsAuthCertManager : public QDialog ~QgsAuthCertManager(); - /** Get access to embedded editors widget */ + //! Get access to embedded editors widget QgsAuthCertEditors *certEditorsWidget() { return mCertEditors; } private: diff --git a/src/gui/auth/qgsauthcerttrustpolicycombobox.h b/src/gui/auth/qgsauthcerttrustpolicycombobox.h index ff64c344328..620bda31919 100644 --- a/src/gui/auth/qgsauthcerttrustpolicycombobox.h +++ b/src/gui/auth/qgsauthcerttrustpolicycombobox.h @@ -40,17 +40,17 @@ class GUI_EXPORT QgsAuthCertTrustPolicyComboBox : public QComboBox QgsAuthCertUtils::CertTrustPolicy defaultpolicy = QgsAuthCertUtils::DefaultTrust ); ~QgsAuthCertTrustPolicyComboBox(); - /** Get currently set trust policy */ + //! Get currently set trust policy QgsAuthCertUtils::CertTrustPolicy trustPolicy(); - /** Get trust policy for a given index of combobox */ + //! Get trust policy for a given index of combobox QgsAuthCertUtils::CertTrustPolicy trustPolicyForIndex( int indx ); public slots: - /** Set current trust policy */ + //! Set current trust policy void setTrustPolicy( QgsAuthCertUtils::CertTrustPolicy policy ); - /** Set default trust policy */ + //! Set default trust policy void setDefaultTrustPolicy( QgsAuthCertUtils::CertTrustPolicy defaultpolicy ); private slots: diff --git a/src/gui/auth/qgsauthconfigedit.h b/src/gui/auth/qgsauthconfigedit.h index d5de322f63c..958d451c93d 100644 --- a/src/gui/auth/qgsauthconfigedit.h +++ b/src/gui/auth/qgsauthconfigedit.h @@ -34,7 +34,7 @@ class GUI_EXPORT QgsAuthConfigEdit : public QDialog, private Ui::QgsAuthConfigEd Q_OBJECT public: - /** Type of configuration validity */ + //! Type of configuration validity enum Validity { Valid, @@ -52,14 +52,14 @@ class GUI_EXPORT QgsAuthConfigEdit : public QDialog, private Ui::QgsAuthConfigEd const QString &dataprovider = QString() ); ~QgsAuthConfigEdit(); - /** Authentication config id, updated with generated id when a new config is saved to auth database */ + //! Authentication config id, updated with generated id when a new config is saved to auth database const QString configId() const { return mAuthCfg; } signals: - /** Emit generated id when a new config is saved to auth database */ + //! Emit generated id when a new config is saved to auth database void authenticationConfigStored( const QString& authcfg ); - /** Emit current id when an existing config is updated in auth database */ + //! Emit current id when an existing config is updated in auth database void authenticationConfigUpdated( const QString& authcfg ); private slots: diff --git a/src/gui/auth/qgsauthconfigeditor.h b/src/gui/auth/qgsauthconfigeditor.h index c10510685c7..370c36b36ae 100644 --- a/src/gui/auth/qgsauthconfigeditor.h +++ b/src/gui/auth/qgsauthconfigeditor.h @@ -42,45 +42,45 @@ class GUI_EXPORT QgsAuthConfigEditor : public QWidget, private Ui::QgsAuthConfig explicit QgsAuthConfigEditor( QWidget *parent = nullptr, bool showUtilities = true, bool relayMessages = true ); ~QgsAuthConfigEditor(); - /** Hide the widget's title, e.g. when embedding */ + //! Hide the widget's title, e.g. when embedding void toggleTitleVisibility( bool visible ); public slots: - /** Set whether to show the widget's utilities button, e.g. when embedding */ + //! Set whether to show the widget's utilities button, e.g. when embedding void setShowUtilitiesButton( bool show = true ); - /** Set whether to relay auth manager messages to internal message bar, e.g. when embedding */ + //! Set whether to relay auth manager messages to internal message bar, e.g. when embedding void setRelayMessages( bool relay = true ); private slots: - /** Repopulate the view with table contents */ + //! Repopulate the view with table contents void refreshTableView(); - /** Sets the cached master password (and verifies it if its hash is in authentication database) */ + //! Sets the cached master password (and verifies it if its hash is in authentication database) void setMasterPassword(); - /** Clear the currently cached master password (not its hash in database) */ + //! Clear the currently cached master password (not its hash in database) void clearCachedMasterPassword(); - /** Reset the cached master password, updating its hash in authentication database and reseting all existing configs to use it */ + //! Reset the cached master password, updating its hash in authentication database and reseting all existing configs to use it void resetMasterPassword(); - /** Clear all cached authentication configs for session */ + //! Clear all cached authentication configs for session void clearCachedAuthenticationConfigs(); - /** Remove all authentication configs */ + //! Remove all authentication configs void removeAuthenticationConfigs(); - /** Completely clear out the authentication database (configs and master password) */ + //! Completely clear out the authentication database (configs and master password) void eraseAuthenticationDatabase(); - /** Relay messages to widget's messagebar */ + //! Relay messages to widget's messagebar void authMessageOut( const QString& message, const QString& authtag, QgsAuthManager::MessageLevel level ); - /** Pass selection change on to UI update */ + //! Pass selection change on to UI update void selectionChanged( const QItemSelection& selected, const QItemSelection& deselected ); - /** Update UI based upon current selection */ + //! Update UI based upon current selection void checkSelection(); void on_btnAddConfig_clicked(); diff --git a/src/gui/auth/qgsauthconfigidedit.h b/src/gui/auth/qgsauthconfigidedit.h index 5ef6ed28e92..32241d37801 100644 --- a/src/gui/auth/qgsauthconfigidedit.h +++ b/src/gui/auth/qgsauthconfigidedit.h @@ -40,27 +40,27 @@ class GUI_EXPORT QgsAuthConfigIdEdit : public QWidget, private Ui::QgsAuthConfig explicit QgsAuthConfigIdEdit( QWidget *parent = nullptr, const QString &authcfg = QString(), bool allowEmpty = true ); ~QgsAuthConfigIdEdit(); - /** The authentication configuration ID, if valid, otherwise null QString */ + //! The authentication configuration ID, if valid, otherwise null QString QString const configId(); - /** Whether to allow no ID to be set */ + //! Whether to allow no ID to be set bool allowEmptyId() { return mAllowEmpty;} - /** Validate the widget state and ID */ + //! Validate the widget state and ID bool validate(); signals: - /** Validity of the ID has changed */ + //! Validity of the ID has changed void validityChanged( bool valid ); public slots: - /** Set the authentication configuration ID, storing it, and validating the passed value */ + //! Set the authentication configuration ID, storing it, and validating the passed value void setAuthConfigId( const QString &authcfg ); - /** Set whether to allow no ID to be set */ + //! Set whether to allow no ID to be set void setAllowEmptyId( bool allowed ); - /** Clear all of the widget's editing state and contents */ + //! Clear all of the widget's editing state and contents void clear(); private slots: diff --git a/src/gui/auth/qgsauthconfigselect.h b/src/gui/auth/qgsauthconfigselect.h index f51197d3790..736266b59af 100644 --- a/src/gui/auth/qgsauthconfigselect.h +++ b/src/gui/auth/qgsauthconfigselect.h @@ -40,27 +40,27 @@ class GUI_EXPORT QgsAuthConfigSelect : public QWidget, private Ui::QgsAuthConfig explicit QgsAuthConfigSelect( QWidget *parent = nullptr, const QString &dataprovider = QString() ); ~QgsAuthConfigSelect(); - /** Set the authentication config id for the resource */ + //! Set the authentication config id for the resource void setConfigId( const QString& authcfg ); - /** Get the authentication config id for the resource */ + //! Get the authentication config id for the resource const QString configId() const { return mAuthCfg; } - /** Set key of layer provider, if applicable */ + //! Set key of layer provider, if applicable void setDataProviderKey( const QString &key ); signals: - /** Emitted when authentication config is changed or missing */ + //! Emitted when authentication config is changed or missing void selectedConfigIdChanged( const QString& authcfg ); - /** Emitted when authentication config is removed */ + //! Emitted when authentication config is removed void selectedConfigIdRemoved( const QString& authcfg ); public slots: - /** Show a small message bar with a close button */ + //! Show a small message bar with a close button void showMessage( const QString &msg ); - /** Clear and hide small message bar */ + //! Clear and hide small message bar void clearMessage(); private slots: @@ -117,13 +117,13 @@ class GUI_EXPORT QgsAuthConfigUriEdit : public QDialog, private Ui::QgsAuthConfi const QString &dataprovider = QString() ); ~QgsAuthConfigUriEdit(); - /** Set the data source URI to parse */ + //! Set the data source URI to parse void setDataSourceUri( const QString &datauri ); - /** The returned, possibly edited data source URI */ + //! The returned, possibly edited data source URI QString dataSourceUri(); - /** Whether a string contains an authcfg ID */ + //! Whether a string contains an authcfg ID static bool hasConfigId( const QString &txt ); private slots: diff --git a/src/gui/auth/qgsautheditorwidgets.h b/src/gui/auth/qgsautheditorwidgets.h index 4fe1dd55155..7b993a9b90a 100644 --- a/src/gui/auth/qgsautheditorwidgets.h +++ b/src/gui/auth/qgsautheditorwidgets.h @@ -68,25 +68,25 @@ class GUI_EXPORT QgsAuthEditorWidgets : public QWidget, private Ui::QgsAuthEdito void on_btnCertManager_clicked(); void on_btnAuthPlugins_clicked(); - /** Sets the cached master password (and verifies it if its hash is in authentication database) */ + //! Sets the cached master password (and verifies it if its hash is in authentication database) void setMasterPassword(); - /** Clear the currently cached master password (not its hash in database) */ + //! Clear the currently cached master password (not its hash in database) void clearCachedMasterPassword(); - /** Reset the cached master password, updating its hash in authentication database and reseting all existing configs to use it */ + //! Reset the cached master password, updating its hash in authentication database and reseting all existing configs to use it void resetMasterPassword(); - /** Clear all cached authentication configs for session */ + //! Clear all cached authentication configs for session void clearCachedAuthenticationConfigs(); - /** Remove all authentication configs */ + //! Remove all authentication configs void removeAuthenticationConfigs(); - /** Completely clear out the authentication database (configs and master password) */ + //! Completely clear out the authentication database (configs and master password) void eraseAuthenticationDatabase(); - /** Relay messages to widget's messagebar */ + //! Relay messages to widget's messagebar void authMessageOut( const QString& message, const QString& authtag, QgsAuthManager::MessageLevel level ); private: diff --git a/src/gui/auth/qgsauthguiutils.h b/src/gui/auth/qgsauthguiutils.h index 3ec09b6485d..94c2c7d55e0 100644 --- a/src/gui/auth/qgsauthguiutils.h +++ b/src/gui/auth/qgsauthguiutils.h @@ -31,53 +31,53 @@ class GUI_EXPORT QgsAuthGuiUtils { public: - /** Green color representing valid, trusted, etc. certificate */ + //! Green color representing valid, trusted, etc. certificate static QColor greenColor(); - /** Orange color representing loaded component, but not stored in database */ + //! Orange color representing loaded component, but not stored in database static QColor orangeColor(); - /** Red color representing invalid, untrusted, etc. certificate */ + //! Red color representing invalid, untrusted, etc. certificate static QColor redColor(); - /** Yellow color representing caution regarding action */ + //! Yellow color representing caution regarding action static QColor yellowColor(); - /** Green text stylesheet representing valid, trusted, etc. certificate */ + //! Green text stylesheet representing valid, trusted, etc. certificate static QString greenTextStyleSheet( const QString& selector = "*" ); - /** Orange text stylesheet representing loaded component, but not stored in database */ + //! Orange text stylesheet representing loaded component, but not stored in database static QString orangeTextStyleSheet( const QString& selector = "*" ); - /** Red text stylesheet representing invalid, untrusted, etc. certificate */ + //! Red text stylesheet representing invalid, untrusted, etc. certificate static QString redTextStyleSheet( const QString& selector = "*" ); - /** Verify the authentication system is active, else notify user */ + //! Verify the authentication system is active, else notify user static bool isDisabled( QgsMessageBar *msgbar, int timeout = 0 ); - /** Sets the cached master password (and verifies it if its hash is in authentication database) */ + //! Sets the cached master password (and verifies it if its hash is in authentication database) static void setMasterPassword( QgsMessageBar *msgbar, int timeout = 0 ); - /** Clear the currently cached master password (not its hash in database) */ + //! Clear the currently cached master password (not its hash in database) static void clearCachedMasterPassword( QgsMessageBar *msgbar, int timeout = 0 ); - /** Reset the cached master password, updating its hash in authentication database and reseting all existing configs to use it */ + //! Reset the cached master password, updating its hash in authentication database and reseting all existing configs to use it static void resetMasterPassword( QgsMessageBar *msgbar, int timeout = 0, QWidget *parent = nullptr ); - /** Clear all cached authentication configs for session */ + //! Clear all cached authentication configs for session static void clearCachedAuthenticationConfigs( QgsMessageBar *msgbar, int timeout = 0 ); - /** Remove all authentication configs */ + //! Remove all authentication configs static void removeAuthenticationConfigs( QgsMessageBar *msgbar, int timeout = 0, QWidget *parent = nullptr ); - /** Completely clear out the authentication database (configs and master password) */ + //! Completely clear out the authentication database (configs and master password) static void eraseAuthenticationDatabase( QgsMessageBar *msgbar, int timeout = 0, QWidget *parent = nullptr ); - /** Color a widget via a stylesheet if a file path is found or not */ + //! Color a widget via a stylesheet if a file path is found or not static void fileFound( bool found, QWidget * widget ); - /** Open file dialog for auth associated widgets */ + //! Open file dialog for auth associated widgets static QString getOpenFileName( QWidget *parent, const QString& title, const QString& extfilter ); }; diff --git a/src/gui/auth/qgsauthidentitieseditor.h b/src/gui/auth/qgsauthidentitieseditor.h index 3ed92095859..e710df9b16d 100644 --- a/src/gui/auth/qgsauthidentitieseditor.h +++ b/src/gui/auth/qgsauthidentitieseditor.h @@ -47,10 +47,10 @@ class GUI_EXPORT QgsAuthIdentitiesEditor : public QWidget, private Ui::QgsAuthId void showCertInfo( QTreeWidgetItem *item ); - /** Pass selection change on to UI update */ + //! Pass selection change on to UI update void selectionChanged( const QItemSelection& selected, const QItemSelection& deselected ); - /** Update UI based upon current selection */ + //! Update UI based upon current selection void checkSelection(); void handleDoubleClick( QTreeWidgetItem* item, int col ); @@ -63,11 +63,11 @@ class GUI_EXPORT QgsAuthIdentitiesEditor : public QWidget, private Ui::QgsAuthId void on_btnGroupByOrg_toggled( bool checked ); - /** Relay messages to widget's messagebar */ + //! Relay messages to widget's messagebar void authMessageOut( const QString& message, const QString& authtag, QgsAuthManager::MessageLevel level ); protected: - /** Overridden show event of base widget */ + //! Overridden show event of base widget void showEvent( QShowEvent *e ) override; private: diff --git a/src/gui/auth/qgsauthimportcertdialog.h b/src/gui/auth/qgsauthimportcertdialog.h index c8de1c186f5..7ebd603d7ac 100644 --- a/src/gui/auth/qgsauthimportcertdialog.h +++ b/src/gui/auth/qgsauthimportcertdialog.h @@ -32,14 +32,14 @@ class GUI_EXPORT QgsAuthImportCertDialog : public QDialog, private Ui::QgsAuthIm Q_OBJECT public: - /** Type of filter to apply to dialog */ + //! Type of filter to apply to dialog enum CertFilter { NoFilter = 1, CaFilter = 2, }; - /** Type of inputs for certificates */ + //! Type of inputs for certificates enum CertInput { AllInputs = 1, @@ -58,19 +58,19 @@ class GUI_EXPORT QgsAuthImportCertDialog : public QDialog, private Ui::QgsAuthIm QgsAuthImportCertDialog::CertInput input = AllInputs ); ~QgsAuthImportCertDialog(); - /** Get list of certificate objects to import */ + //! Get list of certificate objects to import const QList certificatesToImport(); - /** Get the file path to a certificate to import */ + //! Get the file path to a certificate to import const QString certFileToImport(); - /** Get certificate text to import */ + //! Get certificate text to import const QString certTextToImport(); - /** Whether to allow importation of invalid certificates (so trust policy can be overridden) */ + //! Whether to allow importation of invalid certificates (so trust policy can be overridden) bool allowInvalidCerts(); - /** Defined trust policy for imported certificates */ + //! Defined trust policy for imported certificates QgsAuthCertUtils::CertTrustPolicy certTrustPolicy(); private slots: diff --git a/src/gui/auth/qgsauthimportidentitydialog.h b/src/gui/auth/qgsauthimportidentitydialog.h index 9199c2f54a6..5ea363cac45 100644 --- a/src/gui/auth/qgsauthimportidentitydialog.h +++ b/src/gui/auth/qgsauthimportidentitydialog.h @@ -33,20 +33,20 @@ class GUI_EXPORT QgsAuthImportIdentityDialog : public QDialog, private Ui::QgsAu Q_OBJECT public: - /** Type of identity being imported */ + //! Type of identity being imported enum IdentityType { CertIdentity = 0, }; - /** Type of bundles supported */ + //! Type of bundles supported enum BundleTypes { PkiPaths = 0, PkiPkcs12 = 1, }; - /** Type of certificate/bundle validity output */ + //! Type of certificate/bundle validity output enum Validity { Valid, @@ -63,7 +63,7 @@ class GUI_EXPORT QgsAuthImportIdentityDialog : public QDialog, private Ui::QgsAu QWidget *parent = nullptr ); ~QgsAuthImportIdentityDialog(); - /** Get identity type */ + //! Get identity type QgsAuthImportIdentityDialog::IdentityType identityType(); /** Get certificate/key bundle to be imported. @@ -71,7 +71,7 @@ class GUI_EXPORT QgsAuthImportIdentityDialog : public QDialog, private Ui::QgsAu */ const QPair certBundleToImport(); - /** Get certificate/key bundle to be imported as a PKI bundle object */ + //! Get certificate/key bundle to be imported as a PKI bundle object const QgsPkiBundle pkiBundleToImport() { return mPkiBundle; } private slots: diff --git a/src/gui/auth/qgsauthmethodedit.h b/src/gui/auth/qgsauthmethodedit.h index 73e6d764b0b..22a0523ec61 100644 --- a/src/gui/auth/qgsauthmethodedit.h +++ b/src/gui/auth/qgsauthmethodedit.h @@ -29,14 +29,14 @@ class GUI_EXPORT QgsAuthMethodEdit : public QWidget Q_OBJECT public: - /** Validate the configuration of subclasses */ + //! Validate the configuration of subclasses virtual bool validateConfig() = 0; - /** The configuration key-vale map of subclasses */ + //! The configuration key-vale map of subclasses virtual QgsStringMap configMap() const = 0; signals: - /** Emitted when the configuration validatity changes */ + //! Emitted when the configuration validatity changes void validityChanged( bool valid ); public slots: @@ -46,10 +46,10 @@ class GUI_EXPORT QgsAuthMethodEdit : public QWidget */ virtual void loadConfig( const QgsStringMap &configmap ) = 0; - /** Clear GUI controls in subclassed widget, optionally reloading any previously loaded config map */ + //! Clear GUI controls in subclassed widget, optionally reloading any previously loaded config map virtual void resetConfig() = 0; - /** Clear GUI controls in subclassed widget */ + //! Clear GUI controls in subclassed widget virtual void clearConfig() = 0; protected: diff --git a/src/gui/auth/qgsauthserverseditor.h b/src/gui/auth/qgsauthserverseditor.h index ed4dc6f1efd..1c410644f5e 100644 --- a/src/gui/auth/qgsauthserverseditor.h +++ b/src/gui/auth/qgsauthserverseditor.h @@ -44,10 +44,10 @@ class GUI_EXPORT QgsAuthServersEditor : public QWidget, private Ui::QgsAuthServe void refreshSslConfigsView(); - /** Pass selection change on to UI update */ + //! Pass selection change on to UI update void selectionChanged( const QItemSelection& selected, const QItemSelection& deselected ); - /** Update UI based upon current selection */ + //! Update UI based upon current selection void checkSelection(); void handleDoubleClick( QTreeWidgetItem* item, int col ); @@ -60,11 +60,11 @@ class GUI_EXPORT QgsAuthServersEditor : public QWidget, private Ui::QgsAuthServe void on_btnGroupByOrg_toggled( bool checked ); - /** Relay messages to widget's messagebar */ + //! Relay messages to widget's messagebar void authMessageOut( const QString& message, const QString& authtag, QgsAuthManager::MessageLevel level ); protected: - /** Overridden show event of base widget */ + //! Overridden show event of base widget void showEvent( QShowEvent *e ) override; private: diff --git a/src/gui/auth/qgsauthsslconfigwidget.h b/src/gui/auth/qgsauthsslconfigwidget.h index a287263c278..2f5a7001611 100644 --- a/src/gui/auth/qgsauthsslconfigwidget.h +++ b/src/gui/auth/qgsauthsslconfigwidget.h @@ -51,27 +51,27 @@ class GUI_EXPORT QgsAuthSslConfigWidget : public QWidget, private Ui::QgsAuthSsl const QList& connectionCAs = QList() ); ~QgsAuthSslConfigWidget(); - /** Access to the certificate's group box widget */ + //! Access to the certificate's group box widget QGroupBox *certificateGroupBox(); - /** Access to the SSL configuration's group box widget */ + //! Access to the SSL configuration's group box widget QGroupBox *sslConfigGroupBox(); - /** Get the SSL configuration */ + //! Get the SSL configuration const QgsAuthConfigSslServer sslCustomConfig(); - /** Get the SSL server certificate */ + //! Get the SSL server certificate const QSslCertificate sslCertificate(); - /** Get the host:port to associate with the server certificate */ + //! Get the host:port to associate with the server certificate const QString sslHost(); - /** Get the SSL protocl used for connections */ + //! Get the SSL protocl used for connections QSsl::SslProtocol sslProtocol(); - /** Get list of the SSL errors (as enums) to be ignored for connections */ + //! Get list of the SSL errors (as enums) to be ignored for connections const QList sslIgnoreErrorEnums(); - /** Get the client's peer verify mode for connections */ + //! Get the client's peer verify mode for connections QSslSocket::PeerVerifyMode sslPeerVerifyMode(); /** Get the client's peer verify depth for connections @@ -80,69 +80,69 @@ class GUI_EXPORT QgsAuthSslConfigWidget : public QWidget, private Ui::QgsAuthSsl int sslPeerVerifyDepth(); public slots: - /** Enable or disable the custom options widget */ + //! Enable or disable the custom options widget void enableSslCustomOptions( bool enable ); // may also load existing config, if found - /** Set SSl certificate and any associated host:port */ + //! Set SSl certificate and any associated host:port void setSslCertificate( const QSslCertificate& cert, const QString &hostport = QString() ); - /** Load an existing SSL server configuration */ + //! Load an existing SSL server configuration void loadSslCustomConfig( const QgsAuthConfigSslServer& config = QgsAuthConfigSslServer() ); - /** Save the current SSL server configuration to the authentication database */ + //! Save the current SSL server configuration to the authentication database void saveSslCertConfig(); - /** Clear the current SSL server configuration and disabled it */ + //! Clear the current SSL server configuration and disabled it void resetSslCertConfig(); - /** Set the SSL protocol to use in connections */ + //! Set the SSL protocol to use in connections void setSslProtocol( QSsl::SslProtocol protocol ); - /** Reset the SSL protocol to use in connections to the default */ + //! Reset the SSL protocol to use in connections to the default void resetSslProtocol(); - /** Add to SSL errors to ignore for the connection */ + //! Add to SSL errors to ignore for the connection void appendSslIgnoreErrors( const QList& errors ); - /** Set the SSL errors (as enums) to ignore for the connection */ + //! Set the SSL errors (as enums) to ignore for the connection void setSslIgnoreErrorEnums( const QList& errorenums ); - /** Set the SSL errors to ignore for the connection */ + //! Set the SSL errors to ignore for the connection void setSslIgnoreErrors( const QList& errors ); - /** Clear the SSL errors to ignore for the connection */ + //! Clear the SSL errors to ignore for the connection void resetSslIgnoreErrors(); - /** Set the client's peer verify mode for connections */ + //! Set the client's peer verify mode for connections void setSslPeerVerify( QSslSocket::PeerVerifyMode mode, int modedepth ); - /** Reset the client's peer verify mode for connections to default */ + //! Reset the client's peer verify mode for connections to default void resetSslPeerVerify(); - /** Set the host of the server */ + //! Set the host of the server void setSslHost( const QString& host ); - /** Set whether the config group box is checkable */ + //! Set whether the config group box is checkable void setConfigCheckable( bool checkable ); - /** Parse string for host:port */ + //! Parse string for host:port void validateHostPortText( const QString &txt ); - /** Verify if the configuration if ready to save */ + //! Verify if the configuration if ready to save bool readyToSave(); signals: - /** Emitted when the enabled state of the configuration changes */ + //! Emitted when the enabled state of the configuration changes void configEnabledChanged( bool enabled ); - /** Emitted when an certificate of same SHA hash is found in authentication database */ + //! Emitted when an certificate of same SHA hash is found in authentication database void certFoundInAuthDatabase( bool found ); - /** Emitted when the validity of the host:port changes */ + //! Emitted when the validity of the host:port changes void hostPortValidityChanged( bool valid ); - /** Emitted when the configuration can be saved changes */ + //! Emitted when the configuration can be saved changes void readyToSaveChanged( bool cansave ); private slots: @@ -199,11 +199,11 @@ class GUI_EXPORT QgsAuthSslConfigDialog : public QDialog const QString &hostport = QString() ); ~QgsAuthSslConfigDialog(); - /** Access the embedded SSL server configuration widget */ + //! Access the embedded SSL server configuration widget QgsAuthSslConfigWidget *sslCustomConfigWidget() { return mSslConfigWdgt; } public slots: - /** Overridden base dialog accept slot */ + //! Overridden base dialog accept slot void accept() override; private slots: diff --git a/src/gui/auth/qgsauthsslimportdialog.h b/src/gui/auth/qgsauthsslimportdialog.h index 5f0f5c453d6..0d27f3f4170 100644 --- a/src/gui/auth/qgsauthsslimportdialog.h +++ b/src/gui/auth/qgsauthsslimportdialog.h @@ -88,7 +88,7 @@ class GUI_EXPORT QgsAuthSslImportDialog : public QDialog, private Ui::QgsAuthSsl ~QgsAuthSslImportDialog(); public slots: - /** Overridden slot of base dialog */ + //! Overridden slot of base dialog void accept() override; private slots: diff --git a/src/gui/auth/qgsauthtrustedcasdialog.h b/src/gui/auth/qgsauthtrustedcasdialog.h index 89ceef1f063..a83e79fcc4e 100644 --- a/src/gui/auth/qgsauthtrustedcasdialog.h +++ b/src/gui/auth/qgsauthtrustedcasdialog.h @@ -48,10 +48,10 @@ class GUI_EXPORT QgsAuthTrustedCAsDialog : public QDialog, private Ui::QgsAuthTr void showCertInfo( QTreeWidgetItem *item ); - /** Pass selection change on to UI update */ + //! Pass selection change on to UI update void selectionChanged( const QItemSelection& selected, const QItemSelection& deselected ); - /** Update UI based upon current selection */ + //! Update UI based upon current selection void checkSelection(); void handleDoubleClick( QTreeWidgetItem* item, int col ); @@ -60,11 +60,11 @@ class GUI_EXPORT QgsAuthTrustedCAsDialog : public QDialog, private Ui::QgsAuthTr void on_btnGroupByOrg_toggled( bool checked ); - /** Relay messages to widget's messagebar */ + //! Relay messages to widget's messagebar void authMessageOut( const QString& message, const QString& authtag, QgsAuthManager::MessageLevel level ); protected: - /** Overridden widget show event */ + //! Overridden widget show event void showEvent( QShowEvent *e ) override; private: diff --git a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h index 42e5e7f1cca..5751734e81d 100644 --- a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h @@ -46,19 +46,19 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper //! @note added in QGIS 2.16 enum FilterFlag { - EqualTo = 1 << 1, /*!< Supports equal to */ - NotEqualTo = 1 << 2, /*!< Supports not equal to */ - GreaterThan = 1 << 3, /*!< Supports greater than */ - LessThan = 1 << 4, /*!< Supports less than */ - GreaterThanOrEqualTo = 1 << 5, /*!< Supports >= */ - LessThanOrEqualTo = 1 << 6, /*!< Supports <= */ - Between = 1 << 7, /*!< Supports searches between two values */ - CaseInsensitive = 1 << 8, /*!< Supports case insensitive searching */ - Contains = 1 << 9, /*!< Supports value "contains" searching */ - DoesNotContain = 1 << 10, /*!< Supports value does not contain searching */ - IsNull = 1 << 11, /*!< Supports searching for null values */ - IsNotBetween = 1 << 12, /*!< Supports searching for values outside of a set range */ - IsNotNull = 1 << 13, /*!< Supports searching for non-null values */ + EqualTo = 1 << 1, //!< Supports equal to + NotEqualTo = 1 << 2, //!< Supports not equal to + GreaterThan = 1 << 3, //!< Supports greater than + LessThan = 1 << 4, //!< Supports less than + GreaterThanOrEqualTo = 1 << 5, //!< Supports >= + LessThanOrEqualTo = 1 << 6, //!< Supports <= + Between = 1 << 7, //!< Supports searches between two values + CaseInsensitive = 1 << 8, //!< Supports case insensitive searching + Contains = 1 << 9, //!< Supports value "contains" searching + DoesNotContain = 1 << 10, //!< Supports value does not contain searching + IsNull = 1 << 11, //!< Supports searching for null values + IsNotBetween = 1 << 12, //!< Supports searching for values outside of a set range + IsNotNull = 1 << 13, //!< Supports searching for non-null values }; Q_DECLARE_FLAGS( FilterFlags, FilterFlag ) diff --git a/src/gui/editorwidgets/qgsmultiedittoolbutton.h b/src/gui/editorwidgets/qgsmultiedittoolbutton.h index b8e78042e34..c8113985acc 100644 --- a/src/gui/editorwidgets/qgsmultiedittoolbutton.h +++ b/src/gui/editorwidgets/qgsmultiedittoolbutton.h @@ -35,9 +35,9 @@ class GUI_EXPORT QgsMultiEditToolButton : public QToolButton //! Button states enum State { - Default, /*!< Default state, all features have same value for widget */ - MixedValues, /*!< Mixed state, some features have different values for the widget */ - Changed, /*!< Value for widget has changed but changes have not yet been committed */ + Default, //!< Default state, all features have same value for widget + MixedValues, //!< Mixed state, some features have different values for the widget + Changed, //!< Value for widget has changed but changes have not yet been committed }; /** Constructor for QgsMultiEditToolButton. diff --git a/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h b/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h index e0d5d545cbf..f6574a81d12 100644 --- a/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h +++ b/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h @@ -62,15 +62,15 @@ class GUI_EXPORT QgsLayerTreeEmbeddedWidgetRegistry { public: - /** Means of accessing canonical single instance */ + //! Means of accessing canonical single instance static QgsLayerTreeEmbeddedWidgetRegistry* instance(); ~QgsLayerTreeEmbeddedWidgetRegistry(); - /** Return list of all registered providers */ + //! Return list of all registered providers QStringList providers() const; - /** Get provider object from the provider's ID */ + //! Get provider object from the provider's ID QgsLayerTreeEmbeddedWidgetProvider* provider( const QString& providerId ) const; /** Register a provider, takes ownership of the object. diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h index 6cb53732617..8f3a003ade8 100644 --- a/src/gui/qgisinterface.h +++ b/src/gui/qgisinterface.h @@ -69,13 +69,13 @@ class GUI_EXPORT QgisInterface : public QObject public: - /** Constructor */ + //! Constructor QgisInterface(); - /** Virtual destructor */ + //! Virtual destructor virtual ~QgisInterface(); - /** Get pointer to legend interface */ + //! Get pointer to legend interface virtual QgsLegendInterface* legendInterface() = 0; virtual QgsPluginManagerInterface* pluginManagerInterface() = 0; @@ -206,7 +206,7 @@ class GUI_EXPORT QgisInterface : public QObject //! @note added in 2.3 virtual void addToolBar( QToolBar* toolbar, Qt::ToolBarArea area = Qt::TopToolBarArea ) = 0; - /** Return a pointer to the map canvas */ + //! Return a pointer to the map canvas virtual QgsMapCanvas * mapCanvas() = 0; /** @@ -216,19 +216,19 @@ class GUI_EXPORT QgisInterface : public QObject */ virtual QgsLayerTreeMapCanvasBridge* layerTreeCanvasBridge() = 0; - /** Return a pointer to the main window (instance of QgisApp in case of QGIS) */ + //! Return a pointer to the main window (instance of QgisApp in case of QGIS) virtual QWidget * mainWindow() = 0; - /** Return the message bar of the main app */ + //! Return the message bar of the main app virtual QgsMessageBar * messageBar() = 0; - /** Open the message log dock widget **/ + //! Open the message log dock widget * virtual void openMessageLog() = 0; - /** Adds a widget to the user input tool bar.*/ + //! Adds a widget to the user input tool bar. virtual void addUserInputWidget( QWidget* widget ) = 0; - /** Return mainwindows / composer views of running composer instances (currently only one) */ + //! Return mainwindows / composer views of running composer instances (currently only one) virtual QList activeComposers() = 0; /** Create a new composer @@ -246,10 +246,10 @@ class GUI_EXPORT QgisInterface : public QObject */ virtual QgsComposerView* duplicateComposer( QgsComposerView* composerView, const QString& title = QString() ) = 0; - /** Deletes parent composer of composer view, after closing composer window */ + //! Deletes parent composer of composer view, after closing composer window virtual void deleteComposer( QgsComposerView* composerView ) = 0; - /** Return changeable options built from settings and/or defaults */ + //! Return changeable options built from settings and/or defaults virtual QMap defaultStyleSheetOptions() = 0; /** Generate stylesheet @@ -257,52 +257,52 @@ class GUI_EXPORT QgisInterface : public QObject */ virtual void buildStyleSheet( const QMap& opts ) = 0; - /** Save changed default option keys/values to user settings */ + //! Save changed default option keys/values to user settings virtual void saveStyleSheetOptions( const QMap& opts ) = 0; - /** Get reference font for initial qApp (may not be same as QgisApp) */ + //! Get reference font for initial qApp (may not be same as QgisApp) virtual QFont defaultStyleSheetFont() = 0; - /** Add action to the plugins menu */ + //! Add action to the plugins menu virtual void addPluginToMenu( const QString& name, QAction* action ) = 0; - /** Remove action from the plugins menu */ + //! Remove action from the plugins menu virtual void removePluginMenu( const QString& name, QAction* action ) = 0; - /** Add "add layer" action to layer menu */ + //! Add "add layer" action to layer menu virtual void insertAddLayerAction( QAction *action ) = 0; - /** Remove "add layer" action from layer menu */ + //! Remove "add layer" action from layer menu virtual void removeAddLayerAction( QAction *action ) = 0; - /** Add action to the Database menu */ + //! Add action to the Database menu virtual void addPluginToDatabaseMenu( const QString& name, QAction* action ) = 0; - /** Remove action from the Database menu */ + //! Remove action from the Database menu virtual void removePluginDatabaseMenu( const QString& name, QAction* action ) = 0; - /** Add action to the Raster menu */ + //! Add action to the Raster menu virtual void addPluginToRasterMenu( const QString& name, QAction* action ) = 0; - /** Remove action from the Raster menu */ + //! Remove action from the Raster menu virtual void removePluginRasterMenu( const QString& name, QAction* action ) = 0; - /** Add action to the Vector menu */ + //! Add action to the Vector menu virtual void addPluginToVectorMenu( const QString& name, QAction* action ) = 0; - /** Remove action from the Vector menu */ + //! Remove action from the Vector menu virtual void removePluginVectorMenu( const QString& name, QAction* action ) = 0; - /** Add action to the Web menu */ + //! Add action to the Web menu virtual void addPluginToWebMenu( const QString& name, QAction* action ) = 0; - /** Remove action from the Web menu */ + //! Remove action from the Web menu virtual void removePluginWebMenu( const QString& name, QAction* action ) = 0; - /** Add a dock widget to the main window */ + //! Add a dock widget to the main window virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget * dockwidget ) = 0; - /** Remove specified dock widget from main window (doesn't delete it). */ + //! Remove specified dock widget from main window (doesn't delete it). virtual void removeDockWidget( QDockWidget * dockwidget ) = 0; /** Advanced digitizing dock widget @@ -310,10 +310,10 @@ class GUI_EXPORT QgisInterface : public QObject */ virtual QgsAdvancedDigitizingDockWidget* cadDockWidget() = 0; - /** Open layer properties dialog */ + //! Open layer properties dialog virtual void showLayerProperties( QgsMapLayer *l ) = 0; - /** Open attribute table dialog */ + //! Open attribute table dialog virtual QDialog* showAttributeTable( QgsVectorLayer *l, const QString& filterExpression = QString() ) = 0; /** Add window to Window menu. The action title is the window title @@ -324,10 +324,10 @@ class GUI_EXPORT QgisInterface : public QObject * windows which are hidden rather than deleted when closed. */ virtual void removeWindow( QAction *action ) = 0; - /** Register action to the shortcuts manager so its shortcut can be changed in GUI */ + //! Register action to the shortcuts manager so its shortcut can be changed in GUI virtual bool registerMainWindowAction( QAction* action, const QString& defaultShortcut ) = 0; - /** Unregister a previously registered action. (e.g. when plugin is going to be unloaded) */ + //! Unregister a previously registered action. (e.g. when plugin is going to be unloaded) virtual bool unregisterMainWindowAction( QAction* action ) = 0; /** Register a new tab in the vector layer properties dialog. @@ -380,7 +380,7 @@ class GUI_EXPORT QgisInterface : public QObject virtual QMenu *viewMenu() = 0; virtual QMenu *layerMenu() = 0; virtual QMenu *newLayerMenu() = 0; - /** @note added in 2.5 */ + //! @note added in 2.5 virtual QMenu *addLayerMenu() = 0; virtual QMenu *settingsMenu() = 0; virtual QMenu *pluginMenu() = 0; @@ -489,9 +489,9 @@ class GUI_EXPORT QgisInterface : public QObject virtual QAction *actionAddRasterLayer() = 0; virtual QAction *actionAddPgLayer() = 0; virtual QAction *actionAddWmsLayer() = 0; - /** Get access to the native Add ArcGIS FeatureServer action. */ + //! Get access to the native Add ArcGIS FeatureServer action. virtual QAction *actionAddAfsLayer() = 0; - /** Get access to the native Add ArcGIS MapServer action. */ + //! Get access to the native Add ArcGIS MapServer action. virtual QAction *actionAddAmsLayer() = 0; virtual QAction *actionCopyLayerStyle() = 0; virtual QAction *actionPasteLayerStyle() = 0; @@ -579,7 +579,7 @@ class GUI_EXPORT QgisInterface : public QObject * @returns list of layers in legend order, or empty list */ virtual QList editableLayers( bool modified = false ) const = 0; - /** Get timeout for timed messages: default of 5 seconds */ + //! Get timeout for timed messages: default of 5 seconds virtual int messageTimeout() = 0; signals: diff --git a/src/gui/qgsadvanceddigitizingdockwidget.h b/src/gui/qgsadvanceddigitizingdockwidget.h index 7fbcee35bff..96fe8027096 100644 --- a/src/gui/qgsadvanceddigitizingdockwidget.h +++ b/src/gui/qgsadvanceddigitizingdockwidget.h @@ -55,8 +55,8 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private enum CadCapacity { AbsoluteAngle = 1, //!< Azimuth - RelativeAngle = 2, //!< also for parallel and perpendicular - RelativeCoordinates = 4, //!< this corresponds to distance and relative coordinates + RelativeAngle = 2, //!< Also for parallel and perpendicular + RelativeCoordinates = 4, //!< This corresponds to distance and relative coordinates }; Q_DECLARE_FLAGS( CadCapacities, CadCapacity ) diff --git a/src/gui/qgsannotationitem.h b/src/gui/qgsannotationitem.h index 921932d71b0..22976f7b757 100644 --- a/src/gui/qgsannotationitem.h +++ b/src/gui/qgsannotationitem.h @@ -62,7 +62,7 @@ class GUI_EXPORT QgsAnnotationItem: public QgsMapCanvasItem, public QgsAnnotatio /** Returns the mouse move behaviour for a given position @param pos the position in scene coordinates*/ QgsAnnotationItem::MouseMoveAction moveActionForPosition( QPointF pos ) const; - /** Returns suitable cursor shape for mouse move action*/ + //! Returns suitable cursor shape for mouse move action Qt::CursorShape cursorShapeForAction( MouseMoveAction moveAction ) const; //setters and getters @@ -81,7 +81,7 @@ class GUI_EXPORT QgsAnnotationItem: public QgsMapCanvasItem, public QgsAnnotatio /** Sets the CRS of the map position. @param crs the CRS to set */ virtual void setMapPositionCrs( const QgsCoordinateReferenceSystem& crs ); - /** Returns the CRS of the map position.*/ + //! Returns the CRS of the map position. QgsCoordinateReferenceSystem mapPositionCrs() const override { return mMapPositionCrs; } void setFrameSize( QSizeF size ); @@ -90,7 +90,7 @@ class GUI_EXPORT QgsAnnotationItem: public QgsMapCanvasItem, public QgsAnnotatio void setOffsetFromReferencePoint( QPointF offset ); QPointF offsetFromReferencePoint() const { return mOffsetFromReferencePoint; } - /** Set symbol that is drawn on map position. Takes ownership*/ + //! Set symbol that is drawn on map position. Takes ownership void setMarkerSymbol( QgsMarkerSymbol* symbol ); const QgsMarkerSymbol* markerSymbol() const {return mMarkerSymbol;} @@ -134,38 +134,38 @@ class GUI_EXPORT QgsAnnotationItem: public QgsMapCanvasItem, public QgsAnnotatio void paint( QPainter* painter ) override; protected: - /** True: the item stays at the same map position, False: the item stays on same screen position*/ + //! True: the item stays at the same map position, False: the item stays on same screen position bool mMapPositionFixed; - /** Map position (in case mMapPositionFixed is true)*/ + //! Map position (in case mMapPositionFixed is true) QgsPoint mMapPosition; - /** CRS of the map position */ + //! CRS of the map position QgsCoordinateReferenceSystem mMapPositionCrs; - /** Describes the shift of the item content box to the reference point*/ + //! Describes the shift of the item content box to the reference point QPointF mOffsetFromReferencePoint; - /** Size of the frame (without balloon)*/ + //! Size of the frame (without balloon) QSizeF mFrameSize; - /** Bounding rect (including item frame and balloon)*/ + //! Bounding rect (including item frame and balloon) QRectF mBoundingRect; - /** Point symbol that is to be drawn at the map reference location*/ + //! Point symbol that is to be drawn at the map reference location QgsMarkerSymbol* mMarkerSymbol; - /** Width of the frame*/ + //! Width of the frame double mFrameBorderWidth; - /** Frame / balloon color*/ + //! Frame / balloon color QColor mFrameColor; QColor mFrameBackgroundColor; - /** Segment number where the connection to the map point is attached. -1 if no balloon needed (e.g. if point is contained in frame)*/ + //! Segment number where the connection to the map point is attached. -1 if no balloon needed (e.g. if point is contained in frame) int mBalloonSegment; - /** First segment point for drawing the connection (ccw direction)*/ + //! First segment point for drawing the connection (ccw direction) QPointF mBalloonSegmentPoint1; - /** Second segment point for drawing the balloon connection (ccw direction)*/ + //! Second segment point for drawing the balloon connection (ccw direction) QPointF mBalloonSegmentPoint2; void updateBoundingRect(); - /** Check where to attach the balloon connection between frame and map point*/ + //! Check where to attach the balloon connection between frame and map point void updateBalloon(); //! Draws the annotation frame to a destination painter @@ -177,13 +177,13 @@ class GUI_EXPORT QgsAnnotationItem: public QgsMapCanvasItem, public QgsAnnotatio //! Draws selection handles around the item void drawSelectionBoxes( QPainter* p ) const; - /** Returns frame width in painter units*/ + //! Returns frame width in painter units //double scaledFrameWidth( QPainter* p) const; - /** Gets the frame line (0 is the top line, 1 right, 2 bottom, 3 left)*/ + //! Gets the frame line (0 is the top line, 1 right, 2 bottom, 3 left) QLineF segment( int index ) const; - /** Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point*/ + //! Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point QPointF pointOnLineWithDistance( QPointF startPoint, QPointF directionPoint, double distance ) const; - /** Returns the symbol size scaled in (mapcanvas) pixels. Used for the counding rect calculation*/ + //! Returns the symbol size scaled in (mapcanvas) pixels. Used for the counding rect calculation double scaledSymbolSize() const; }; diff --git a/src/gui/qgsattributeform.h b/src/gui/qgsattributeform.h index 16b44ce09dc..c584f327a13 100644 --- a/src/gui/qgsattributeform.h +++ b/src/gui/qgsattributeform.h @@ -42,19 +42,19 @@ class GUI_EXPORT QgsAttributeForm : public QWidget //! Form modes enum Mode { - SingleEditMode, /*!< Single edit mode, for editing a single feature */ + SingleEditMode, //!< Single edit mode, for editing a single feature AddFeatureMode, /*!< Add feature mode, for setting attributes for a new feature. In this mode the dialog will be editable even with an invalid feature and will add a new feature when the form is accepted. */ - MultiEditMode, /*!< Multi edit mode, for editing fields of multiple features at once */ - SearchMode, /*!< Form values are used for searching/filtering the layer */ + MultiEditMode, //!< Multi edit mode, for editing fields of multiple features at once + SearchMode, //!< Form values are used for searching/filtering the layer }; //! Filter types enum FilterType { - ReplaceFilter, /*!< Filter should replace any existing filter */ - FilterAnd, /*!< Filter should be combined using "AND" */ - FilterOr, /*!< Filter should be combined using "OR" */ + ReplaceFilter, //!< Filter should replace any existing filter + FilterAnd, //!< Filter should be combined using "AND" + FilterOr, //!< Filter should be combined using "OR" }; explicit QgsAttributeForm( QgsVectorLayer* vl, const QgsFeature &feature = QgsFeature(), diff --git a/src/gui/qgsattributeformeditorwidget.h b/src/gui/qgsattributeformeditorwidget.h index 51cc6b5f90a..eeac24dcbb9 100644 --- a/src/gui/qgsattributeformeditorwidget.h +++ b/src/gui/qgsattributeformeditorwidget.h @@ -47,9 +47,9 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget //! Widget modes enum Mode { - DefaultMode, /*!< Default mode, only the editor widget is shown */ - MultiEditMode, /*!< Multi edit mode, both the editor widget and a QgsMultiEditToolButton is shown */ - SearchMode, /*!< Layer search/filter mode */ + DefaultMode, //!< Default mode, only the editor widget is shown + MultiEditMode, //!< Multi edit mode, both the editor widget and a QgsMultiEditToolButton is shown + SearchMode, //!< Layer search/filter mode }; /** Constructor for QgsAttributeFormEditorWidget. diff --git a/src/gui/qgscollapsiblegroupbox.h b/src/gui/qgscollapsiblegroupbox.h index b6f982bc95b..2ca22f9ce00 100644 --- a/src/gui/qgscollapsiblegroupbox.h +++ b/src/gui/qgscollapsiblegroupbox.h @@ -127,7 +127,7 @@ class GUI_EXPORT QgsCollapsibleGroupBoxBasic : public QGroupBox bool scrollOnExpand() {return mScrollOnExpand;} signals: - /** Signal emitted when groupbox collapsed/expanded state is changed, and when first shown */ + //! Signal emitted when groupbox collapsed/expanded state is changed, and when first shown void collapsedStateChanged( bool collapsed ); public slots: @@ -138,7 +138,7 @@ class GUI_EXPORT QgsCollapsibleGroupBoxBasic : public QGroupBox protected: void init(); - /** Visual fixes for when group box is collapsed/expanded */ + //! Visual fixes for when group box is collapsed/expanded void collapseExpandFixes(); void showEvent( QShowEvent *event ) override; diff --git a/src/gui/qgscolorbutton.h b/src/gui/qgscolorbutton.h index c8488ba5b55..1968ec94ac5 100644 --- a/src/gui/qgscolorbutton.h +++ b/src/gui/qgscolorbutton.h @@ -52,8 +52,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ enum Behaviour { - ShowDialog = 0, /*!< show a color picker dialog when clicked */ - SignalOnly /*!< emit colorClicked signal only, no dialog */ + ShowDialog = 0, //!< Show a color picker dialog when clicked + SignalOnly //!< Emit colorClicked signal only, no dialog }; /** Construct a new color button. diff --git a/src/gui/qgscolorwidgets.h b/src/gui/qgscolorwidgets.h index d4ffc042db4..57ca838f534 100644 --- a/src/gui/qgscolorwidgets.h +++ b/src/gui/qgscolorwidgets.h @@ -43,14 +43,14 @@ class GUI_EXPORT QgsColorWidget : public QWidget */ enum ColorComponent { - Multiple = 0, /*!< widget alters multiple color components */ - Red, /*!< red component of color */ - Green, /*!< green component of color */ - Blue, /*!< blue component of color */ - Hue, /*!< hue component of color (based on HSV model) */ - Saturation, /*!< saturation component of color (based on HSV model) */ - Value, /*!< value component of color (based on HSV model) */ - Alpha /*!< alpha component (opacity) of color */ + Multiple = 0, //!< Widget alters multiple color components + Red, //!< Red component of color + Green, //!< Green component of color + Blue, //!< Blue component of color + Hue, //!< Hue component of color (based on HSV model) + Saturation, //!< Saturation component of color (based on HSV model) + Value, //!< Value component of color (based on HSV model) + Alpha //!< Alpha component (opacity) of color }; /** Construct a new color widget. @@ -328,10 +328,10 @@ class GUI_EXPORT QgsColorWheel : public QgsColorWidget */ void createImages( const QSizeF size ); - /** Creates the hue wheel image*/ + //! Creates the hue wheel image void createWheel(); - /** Creates the inner triangle image*/ + //! Creates the inner triangle image void createTriangle(); /** Sets the widget color based on a point in the widget @@ -446,8 +446,8 @@ class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget */ enum Orientation { - Horizontal = 0, /*!< horizontal ramp */ - Vertical /*!< vertical ramp */ + Horizontal = 0, //!< Horizontal ramp + Vertical //!< Vertical ramp }; /** Construct a new color ramp widget. @@ -639,10 +639,10 @@ class GUI_EXPORT QgsColorTextWidget : public QgsColorWidget */ enum ColorTextFormat { - HexRgb = 0, /*!< \#RRGGBB in hexadecimal */ - HexRgbA, /*!< \#RRGGBBAA in hexadecimal, with alpha */ - Rgb, /*!< rgb( r, g, b ) format */ - Rgba /*!< rgba( r, g, b, a ) format, with alpha */ + HexRgb = 0, //!< \#RRGGBB in hexadecimal + HexRgbA, //!< \#RRGGBBAA in hexadecimal, with alpha + Rgb, //!< Rgb( r, g, b ) format + Rgba //!< Rgba( r, g, b, a ) format, with alpha }; QLineEdit* mLineEdit; diff --git a/src/gui/qgscomposerruler.h b/src/gui/qgscomposerruler.h index e4be28ec2a4..ac695f2a382 100644 --- a/src/gui/qgscomposerruler.h +++ b/src/gui/qgscomposerruler.h @@ -95,7 +95,7 @@ class GUI_EXPORT QgsComposerRuler: public QWidget void drawMarkerPos( QPainter *painter ); signals: - /** Is emitted when mouse cursor coordinates change*/ + //! Is emitted when mouse cursor coordinates change void cursorPosChanged( QPointF ); }; diff --git a/src/gui/qgscomposerview.h b/src/gui/qgscomposerview.h index afcb139b2e6..c2f3c762593 100644 --- a/src/gui/qgscomposerview.h +++ b/src/gui/qgscomposerview.h @@ -51,7 +51,7 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView public: - /** Current tool*/ + //! Current tool enum Tool { Select = 0, // Select/Move item @@ -97,28 +97,28 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView QgsComposerView( QWidget* parent = nullptr, const char* name = nullptr, Qt::WindowFlags f = 0 ); - /** Add an item group containing the selected items*/ + //! Add an item group containing the selected items void groupItems(); - /** Ungroups the selected items*/ + //! Ungroups the selected items void ungroupItems(); - /** Cuts or copies the selected items*/ + //! Cuts or copies the selected items void copyItems( ClipboardMode mode ); - /** Pastes items from clipboard*/ + //! Pastes items from clipboard void pasteItems( PasteMode mode ); - /** Deletes selected items*/ + //! Deletes selected items void deleteSelectedItems(); - /** Selects all items*/ + //! Selects all items void selectAll(); - /** Deselects all items*/ + //! Deselects all items void selectNone(); - /** Inverts current selection*/ + //! Inverts current selection void selectInvert(); QgsComposerView::Tool currentTool() const {return mCurrentTool;} @@ -129,22 +129,22 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView */ void setComposition( QgsComposition* c ); - /** Returns the composition or 0 in case of error*/ + //! Returns the composition or 0 in case of error QgsComposition* composition(); - /** Returns the composer main window*/ + //! Returns the composer main window QMainWindow* composerWindow(); void setPaintingEnabled( bool enabled ) { mPaintingEnabled = enabled; } bool paintingEnabled() const { return mPaintingEnabled; } - /** Update rulers with current scene rect*/ + //! Update rulers with current scene rect void updateRulers(); void setHorizontalRuler( QgsComposerRuler* r ) { mHorizontalRuler = r; } void setVerticalRuler( QgsComposerRuler* r ) { mVerticalRuler = r; } - /** Set zoom level, where a zoom level of 1.0 corresponds to 100%*/ + //! Set zoom level, where a zoom level of 1.0 corresponds to 100% void setZoomLevel( double zoomLevel ); /** Scales the view in a safe way, by limiting the acceptable range @@ -188,27 +188,27 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView void scrollContentsBy( int dx, int dy ) override; private: - /** Current composer tool*/ + //! Current composer tool QgsComposerView::Tool mCurrentTool; - /** Previous composer tool*/ + //! Previous composer tool QgsComposerView::Tool mPreviousTool; - /** Rubber band item*/ + //! Rubber band item QGraphicsRectItem* mRubberBandItem; - /** Rubber band item for arrows*/ + //! Rubber band item for arrows QGraphicsLineItem* mRubberBandLineItem; - /** Item to move content*/ + //! Item to move content QgsComposerItem* mMoveContentItem; - /** Start position of content move*/ + //! Start position of content move QPointF mMoveContentStartPos; - /** Start of rubber band creation*/ + //! Start of rubber band creation QPointF mRubberBandStartPos; - /** True if user is currently selecting by marquee*/ + //! True if user is currently selecting by marquee bool mMarqueeSelect; - /** True if user is currently zooming by marquee*/ + //! True if user is currently zooming by marquee bool mMarqueeZoom; - /** True if user is currently temporarily activating the zoom tool by holding control+space*/ + //! True if user is currently temporarily activating the zoom tool by holding control+space QgsComposerView::ToolStatus mTemporaryZoomStatus; bool mPaintingEnabled; @@ -216,10 +216,10 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView QgsComposerRuler* mHorizontalRuler; QgsComposerRuler* mVerticalRuler; - /** Draw a shape on the canvas */ + //! Draw a shape on the canvas void addShape( Tool currentTool ); - /** Point based shape stuff */ + //! Point based shape stuff void addPolygonNode( QPointF scenePoint ); void movePolygonNode( QPointF scenePoint ); void displayNodes( const bool display = true ); @@ -232,14 +232,14 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView QScopedPointer mPolygonItem; QScopedPointer mPolylineItem; - /** True if user is currently panning by clicking and dragging with the pan tool*/ + //! True if user is currently panning by clicking and dragging with the pan tool bool mToolPanning; - /** True if user is currently panning by holding the middle mouse button*/ + //! True if user is currently panning by holding the middle mouse button bool mMousePanning; - /** True if user is currently panning by holding the space key*/ + //! True if user is currently panning by holding the space key bool mKeyPanning; - /** True if user is currently dragging with the move item content tool*/ + //! True if user is currently dragging with the move item content tool bool mMovingItemContent; QPoint mMouseLastXY; @@ -248,48 +248,48 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView QgsPreviewEffect* mPreviewEffect; - /** Returns the default mouse cursor for a tool*/ + //! Returns the default mouse cursor for a tool QCursor defaultCursorForTool( Tool currentTool ); - /** Zoom composition from a mouse wheel event*/ + //! Zoom composition from a mouse wheel event void wheelZoom( QWheelEvent * event ); - /** Redraws the rectangular rubber band*/ + //! Redraws the rectangular rubber band void updateRubberBandRect( QPointF & pos, const bool constrainSquare = false, const bool fromCenter = false ); - /** Redraws the linear rubber band*/ + //! Redraws the linear rubber band void updateRubberBandLine( QPointF pos, const bool constrainAngles = false ); - /** Removes the rubber band and cleans up*/ + //! Removes the rubber band and cleans up void removeRubberBand(); - /** Starts a marquee selection*/ + //! Starts a marquee selection void startMarqueeSelect( QPointF & scenePoint ); - /** Finalises a marquee selection*/ + //! Finalises a marquee selection void endMarqueeSelect( QMouseEvent* e ); - /** Starts a zoom in marquee*/ + //! Starts a zoom in marquee void startMarqueeZoom( QPointF & scenePoint ); - /** Finalises a marquee zoom*/ + //! Finalises a marquee zoom void endMarqueeZoom( QMouseEvent* e ); //void connectAddRemoveCommandSignals( QgsAddRemoveItemCommand* c ); signals: - /** Is emitted when selected item changed. If 0, no item is selected*/ + //! Is emitted when selected item changed. If 0, no item is selected void selectedItemChanged( QgsComposerItem* selected ); - /** Is emitted when a composer item has been removed from the scene*/ + //! Is emitted when a composer item has been removed from the scene void itemRemoved( QgsComposerItem* ); /** Current action (e.g. adding composer map) has been finished. The purpose of this signal is that QgsComposer may set the selection tool again*/ void actionFinished(); - /** Is emitted when mouse cursor coordinates change*/ + //! Is emitted when mouse cursor coordinates change void cursorPosChanged( QPointF ); - /** Is emitted when the view zoom changes*/ + //! Is emitted when the view zoom changes void zoomLevelChanged(); - /** Emitted before composerview is shown*/ + //! Emitted before composerview is shown void composerViewShow( QgsComposerView* ); - /** Emitted before composerview is hidden*/ + //! Emitted before composerview is hidden void composerViewHide( QgsComposerView* ); - /** Emitted when the composition is set for the view*/ + //! Emitted when the composition is set for the view void compositionSet( QgsComposition* ); }; diff --git a/src/gui/qgscompoundcolorwidget.h b/src/gui/qgscompoundcolorwidget.h index bec73418411..d7740fa6d55 100644 --- a/src/gui/qgscompoundcolorwidget.h +++ b/src/gui/qgscompoundcolorwidget.h @@ -37,8 +37,8 @@ class GUI_EXPORT QgsCompoundColorWidget : public QgsPanelWidget, private Ui::Qgs //! Widget layout enum Layout { - LayoutDefault = 0, /*!< Use the default (rectangular) layout */ - LayoutVertical, /*!< Use a narrower, vertically stacked layout */ + LayoutDefault = 0, //!< Use the default (rectangular) layout + LayoutVertical, //!< Use a narrower, vertically stacked layout }; /** Constructor for QgsCompoundColorWidget diff --git a/src/gui/qgsdatumtransformdialog.h b/src/gui/qgsdatumtransformdialog.h index 6780859ed96..c6ac31cd4cc 100644 --- a/src/gui/qgsdatumtransformdialog.h +++ b/src/gui/qgsdatumtransformdialog.h @@ -48,7 +48,7 @@ class GUI_EXPORT QgsDatumTransformDialog : public QDialog, private Ui::QgsDatumT QgsDatumTransformDialog(); void updateTitle(); bool gridShiftTransformation( const QString& itemText ) const; - /** Returns false if the location of the grid shift files is known (PROJ_LIB) and the shift file is not there*/ + //! Returns false if the location of the grid shift files is known (PROJ_LIB) and the shift file is not there bool testGridShiftFileAvailability( QTreeWidgetItem* item, int col ) const; void load(); diff --git a/src/gui/qgsdetaileditemdelegate.h b/src/gui/qgsdetaileditemdelegate.h index e198df60b3d..013f4a088fa 100644 --- a/src/gui/qgsdetaileditemdelegate.h +++ b/src/gui/qgsdetaileditemdelegate.h @@ -37,11 +37,11 @@ class GUI_EXPORT QgsDetailedItemDelegate : public QAbstractItemDelegate public: QgsDetailedItemDelegate( QObject * parent = nullptr ); ~QgsDetailedItemDelegate(); - /** Reimplement for parent class */ + //! Reimplement for parent class void paint( QPainter * thePainter, const QStyleOptionViewItem & theOption, const QModelIndex & theIndex ) const override; - /** Reimplement for parent class */ + //! Reimplement for parent class QSize sizeHint( const QStyleOptionViewItem & theOption, const QModelIndex & theIndex ) const override; diff --git a/src/gui/qgsencodingfiledialog.h b/src/gui/qgsencodingfiledialog.h index 87fe19c4f5c..2719649f34f 100644 --- a/src/gui/qgsencodingfiledialog.h +++ b/src/gui/qgsencodingfiledialog.h @@ -31,11 +31,11 @@ class GUI_EXPORT QgsEncodingFileDialog: public QFileDialog const QString& caption = QString(), const QString& directory = QString(), const QString& filter = QString(), const QString& encoding = QString() ); ~QgsEncodingFileDialog(); - /** Returns a string describing the chosen encoding*/ + //! Returns a string describing the chosen encoding QString encoding() const; - /** Adds a 'Cancel All' button for the user to click */ + //! Adds a 'Cancel All' button for the user to click void addCancelAll(); - /** Returns true if the user clicked 'Cancel All' */ + //! Returns true if the user clicked 'Cancel All' bool cancelAll(); public slots: @@ -44,7 +44,7 @@ class GUI_EXPORT QgsEncodingFileDialog: public QFileDialog void pbnCancelAll_clicked(); private: - /** Box to choose the encoding type*/ + //! Box to choose the encoding type QComboBox* mEncodingComboBox; /* The button to click */ diff --git a/src/gui/qgsexpressionbuilderdialog.h b/src/gui/qgsexpressionbuilderdialog.h index 0e97b6d7469..faf5717fe66 100644 --- a/src/gui/qgsexpressionbuilderdialog.h +++ b/src/gui/qgsexpressionbuilderdialog.h @@ -31,7 +31,7 @@ class GUI_EXPORT QgsExpressionBuilderDialog : public QDialog, private Ui::QgsExp QgsExpressionBuilderDialog( QgsVectorLayer* layer, const QString& startText = QString(), QWidget* parent = nullptr, const QString& key = "generic", const QgsExpressionContext& context = QgsExpressionContext() ); - /** The builder widget that is used by the dialog */ + //! The builder widget that is used by the dialog QgsExpressionBuilderWidget* expressionBuilder(); void setExpressionText( const QString& text ); @@ -53,7 +53,7 @@ class GUI_EXPORT QgsExpressionBuilderDialog : public QDialog, private Ui::QgsExp */ void setExpressionContext( const QgsExpressionContext& context ); - /** Sets geometry calculator used in distance/area calculations. */ + //! Sets geometry calculator used in distance/area calculations. void setGeomCalculator( const QgsDistanceArea & da ); protected: diff --git a/src/gui/qgsexpressionbuilderwidget.h b/src/gui/qgsexpressionbuilderwidget.h index 453abb7d791..01a615ea6a8 100644 --- a/src/gui/qgsexpressionbuilderwidget.h +++ b/src/gui/qgsexpressionbuilderwidget.h @@ -148,14 +148,14 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp */ void loadFieldsAndValues( const QMap& fieldValues ); - /** Sets geometry calculator used in distance/area calculations. */ + //! Sets geometry calculator used in distance/area calculations. void setGeomCalculator( const QgsDistanceArea & da ); /** Gets the expression string that has been set in the expression area. * @returns The expression as a string. */ QString expressionText(); - /** Sets the expression string for the widget */ + //! Sets the expression string for the widget void setExpressionText( const QString& expression ); /** Returns the expression context for the widget. The context is used for the expression diff --git a/src/gui/qgsextentgroupbox.h b/src/gui/qgsextentgroupbox.h index dd7b794af19..54835617a34 100644 --- a/src/gui/qgsextentgroupbox.h +++ b/src/gui/qgsextentgroupbox.h @@ -44,9 +44,9 @@ class GUI_EXPORT QgsExtentGroupBox : public QgsCollapsibleGroupBox, private Ui:: enum ExtentState { - OriginalExtent, //!< layer's extent - CurrentExtent, //!< map canvas extent - UserExtent, //!< extent manually entered/modified by the user + OriginalExtent, //!< Layer's extent + CurrentExtent, //!< Map canvas extent + UserExtent, //!< Extent manually entered/modified by the user }; //! Setup original extent - should be called as part of initialization diff --git a/src/gui/qgsfieldmodel.h b/src/gui/qgsfieldmodel.h index b5b93e68660..22b7bba7d71 100644 --- a/src/gui/qgsfieldmodel.h +++ b/src/gui/qgsfieldmodel.h @@ -35,13 +35,13 @@ class GUI_EXPORT QgsFieldModel : public QAbstractItemModel public: enum FieldRoles { - FieldNameRole = Qt::UserRole + 1, /*!< return field name if index corresponds to a field */ - FieldIndexRole = Qt::UserRole + 2, /*!< return field index if index corresponds to a field */ - ExpressionRole = Qt::UserRole + 3, /*!< return field name or expression */ - IsExpressionRole = Qt::UserRole + 4, /*!< return if index corresponds to an expression */ - ExpressionValidityRole = Qt::UserRole + 5, /*!< return if expression is valid or not */ - FieldTypeRole = Qt::UserRole + 6, /*!< return the field type (if a field, return QVariant if expression) */ - FieldOriginRole = Qt::UserRole + 7, /*!< return the field origin (if a field, returns QVariant if expression) */ + FieldNameRole = Qt::UserRole + 1, //!< Return field name if index corresponds to a field + FieldIndexRole = Qt::UserRole + 2, //!< Return field index if index corresponds to a field + ExpressionRole = Qt::UserRole + 3, //!< Return field name or expression + IsExpressionRole = Qt::UserRole + 4, //!< Return if index corresponds to an expression + ExpressionValidityRole = Qt::UserRole + 5, //!< Return if expression is valid or not + FieldTypeRole = Qt::UserRole + 6, //!< Return the field type (if a field, return QVariant if expression) + FieldOriginRole = Qt::UserRole + 7, //!< Return the field origin (if a field, returns QVariant if expression) }; /** diff --git a/src/gui/qgsfieldproxymodel.h b/src/gui/qgsfieldproxymodel.h index 0b0b3e5a4a4..6c0b29e8a7b 100644 --- a/src/gui/qgsfieldproxymodel.h +++ b/src/gui/qgsfieldproxymodel.h @@ -34,15 +34,15 @@ class GUI_EXPORT QgsFieldProxyModel : public QSortFilterProxyModel //! Field type filters enum Filter { - String = 1, /*!< String fields */ - Int = 2, /*!< Integer fields */ - LongLong = 4, /*!< Longlong fields */ - Double = 8, /*!< Double fields */ - Numeric = Int | LongLong | Double, /*!< All numeric fields */ - Date = 16, /*!< Date or datetime fields */ - Time = 32, /*!< Time fields */ - HideReadOnly = 64, /*!< Hide read-only fields */ - AllTypes = Numeric | Date | String | Time, /*!< All field types */ + String = 1, //!< String fields + Int = 2, //!< Integer fields + LongLong = 4, //!< Longlong fields + Double = 8, //!< Double fields + Numeric = Int | LongLong | Double, //!< All numeric fields + Date = 16, //!< Date or datetime fields + Time = 32, //!< Time fields + HideReadOnly = 64, //!< Hide read-only fields + AllTypes = Numeric | Date | String | Time, //!< All field types }; Q_DECLARE_FLAGS( Filters, Filter ) diff --git a/src/gui/qgsformannotationitem.h b/src/gui/qgsformannotationitem.h index 57953d78c2b..765b3131ebe 100644 --- a/src/gui/qgsformannotationitem.h +++ b/src/gui/qgsformannotationitem.h @@ -39,10 +39,10 @@ class GUI_EXPORT QgsFormAnnotationItem: public QObject, public QgsAnnotationItem void paint( QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget = nullptr ) override; QSizeF minimumFrameSize() const override; - /** Returns the optimal frame size*/ + //! Returns the optimal frame size QSizeF preferredFrameSize() const; - /** Reimplemented from QgsAnnotationItem*/ + //! Reimplemented from QgsAnnotationItem void setMapPosition( const QgsPoint& pos ) override; void setDesignerForm( const QString& uiFile ); @@ -54,21 +54,21 @@ class GUI_EXPORT QgsFormAnnotationItem: public QObject, public QgsAnnotationItem QgsVectorLayer* vectorLayer() const { return mVectorLayer; } private slots: - /** Sets a feature for the current map position and updates the dialog*/ + //! Sets a feature for the current map position and updates the dialog void setFeatureForMapPosition(); - /** Sets visibility status based on mVectorLayer visibility*/ + //! Sets visibility status based on mVectorLayer visibility void updateVisibility(); private: QGraphicsProxyWidget* mWidgetContainer; QWidget* mDesignerWidget; - /** Associated vectorlayer (or 0 if attributes are not supposed to be replaced)*/ + //! Associated vectorlayer (or 0 if attributes are not supposed to be replaced) QgsVectorLayer* mVectorLayer; - /** True if the item is related to a vector feature*/ + //! True if the item is related to a vector feature bool mHasAssociatedFeature; - /** Associated feature*/ + //! Associated feature QgsFeatureId mFeature; - /** Path to (and including) the .ui file*/ + //! Path to (and including) the .ui file QString mDesignerForm; QWidget* createDesignerWidget( const QString& filePath ); diff --git a/src/gui/qgsgeometryrubberband.h b/src/gui/qgsgeometryrubberband.h index f09e6a501ca..67d2f3e7db5 100644 --- a/src/gui/qgsgeometryrubberband.h +++ b/src/gui/qgsgeometryrubberband.h @@ -63,23 +63,23 @@ class GUI_EXPORT QgsGeometryRubberBand: public QgsMapCanvasItem QgsGeometryRubberBand( QgsMapCanvas* mapCanvas, QgsWkbTypes::GeometryType geomType = QgsWkbTypes::LineGeometry ); ~QgsGeometryRubberBand(); - /** Sets geometry (takes ownership). Geometry is expected to be in map coordinates */ + //! Sets geometry (takes ownership). Geometry is expected to be in map coordinates void setGeometry( QgsAbstractGeometry* geom ); - /** Returns a pointer to the geometry*/ + //! Returns a pointer to the geometry const QgsAbstractGeometry* geometry() { return mGeometry; } - /** Moves vertex to new position (in map coordinates)*/ + //! Moves vertex to new position (in map coordinates) void moveVertex( QgsVertexId id, const QgsPointV2& newPos ); - /** Sets fill color for vertex markers*/ + //! Sets fill color for vertex markers void setFillColor( const QColor& c ); - /** Sets outline color for vertex markes*/ + //! Sets outline color for vertex markes void setOutlineColor( const QColor& c ); - /** Sets outline width*/ + //! Sets outline width void setOutlineWidth( int width ); - /** Sets pen style*/ + //! Sets pen style void setLineStyle( Qt::PenStyle penStyle ); - /** Sets brush style*/ + //! Sets brush style void setBrushStyle( Qt::BrushStyle brushStyle ); - /** Sets vertex marker icon type*/ + //! Sets vertex marker icon type void setIconType( IconType iconType ) { mIconType = iconType; } protected: diff --git a/src/gui/qgshighlight.h b/src/gui/qgshighlight.h index a19846a7f35..4f8ffe60aa5 100644 --- a/src/gui/qgshighlight.h +++ b/src/gui/qgshighlight.h @@ -67,7 +67,7 @@ class GUI_EXPORT QgsHighlight: public QgsMapCanvasItem * @note: added in version 2.3 */ void setFillColor( const QColor & fillColor ); - /** Set width. Ignored in feature mode. */ + //! Set width. Ignored in feature mode. void setWidth( int width ); /** Set line / outline buffer in millimeters. @@ -92,7 +92,7 @@ class GUI_EXPORT QgsHighlight: public QgsMapCanvasItem void init(); void setSymbol( QgsSymbol* symbol, const QgsRenderContext & context, const QColor & color, const QColor & fillColor ); double getSymbolWidth( const QgsRenderContext & context, double width, QgsUnitTypes::RenderUnit unit ); - /** Get renderer for current color mode and colors. The renderer should be freed by caller. */ + //! Get renderer for current color mode and colors. The renderer should be freed by caller. QgsFeatureRenderer * getRenderer( QgsRenderContext &context, const QColor & color, const QColor & fillColor ); void paintPoint( QPainter *p, const QgsPoint& point ); void paintLine( QPainter *p, QgsPolyline line ); diff --git a/src/gui/qgshtmlannotationitem.h b/src/gui/qgshtmlannotationitem.h index 718347bea16..760b3dcd84a 100644 --- a/src/gui/qgshtmlannotationitem.h +++ b/src/gui/qgshtmlannotationitem.h @@ -42,7 +42,7 @@ class GUI_EXPORT QgsHtmlAnnotationItem: public QObject, public QgsAnnotationItem QSizeF minimumFrameSize() const override; - /** Reimplemented from QgsAnnotationItem*/ + //! Reimplemented from QgsAnnotationItem void setMapPosition( const QgsPoint& pos ) override; void setHTMLPage( const QString& htmlFile ); @@ -54,9 +54,9 @@ class GUI_EXPORT QgsHtmlAnnotationItem: public QObject, public QgsAnnotationItem QgsVectorLayer* vectorLayer() const { return mVectorLayer; } private slots: - /** Sets a feature for the current map position and updates the dialog*/ + //! Sets a feature for the current map position and updates the dialog void setFeatureForMapPosition(); - /** Sets visibility status based on mVectorLayer visibility*/ + //! Sets visibility status based on mVectorLayer visibility void updateVisibility(); void javascript(); @@ -64,11 +64,11 @@ class GUI_EXPORT QgsHtmlAnnotationItem: public QObject, public QgsAnnotationItem private: QGraphicsProxyWidget* mWidgetContainer; QgsWebView* mWebView; - /** Associated vectorlayer (or 0 if attributes are not supposed to be replaced)*/ + //! Associated vectorlayer (or 0 if attributes are not supposed to be replaced) QgsVectorLayer* mVectorLayer; - /** True if the item is related to a vector feature*/ + //! True if the item is related to a vector feature bool mHasAssociatedFeature; - /** Associated feature*/ + //! Associated feature QgsFeatureId mFeatureId; QgsFeature mFeature; QString mHtmlFile; diff --git a/src/gui/qgslegendinterface.h b/src/gui/qgslegendinterface.h index 8edd75c7d5c..51cb92d3227 100644 --- a/src/gui/qgslegendinterface.h +++ b/src/gui/qgslegendinterface.h @@ -43,10 +43,10 @@ class GUI_EXPORT QgsLegendInterface : public QObject public: - /** Constructor */ + //! Constructor QgsLegendInterface(); - /** Virtual destructor */ + //! Virtual destructor virtual ~QgsLegendInterface(); //! Return a string list of groups @@ -78,7 +78,7 @@ class GUI_EXPORT QgsLegendInterface : public QObject //! Check if a layer is visible virtual bool isLayerVisible( QgsMapLayer * ml ) = 0; - /** Add action for layers in the legend */ + //! Add action for layers in the legend virtual void addLegendLayerAction( QAction* action, QString menu, QString id, QgsMapLayer::LayerType type, bool allLayers ) = 0; @@ -87,7 +87,7 @@ class GUI_EXPORT QgsLegendInterface : public QObject */ virtual void addLegendLayerActionForLayer( QAction* action, QgsMapLayer* layer ) = 0; - /** Remove action for layers in the legend */ + //! Remove action for layers in the legend virtual bool removeLegendLayerAction( QAction* action ) = 0; //! Returns the current layer if the current item is a QgsLegendLayer. diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp index ef3d67b7f42..86e0a3f7136 100644 --- a/src/gui/qgsmapcanvas.cpp +++ b/src/gui/qgsmapcanvas.cpp @@ -1540,7 +1540,7 @@ void QgsMapCanvas::mouseMoveEvent( QMouseEvent * e ) -/** Sets the map tool currently being used on the canvas */ +//! Sets the map tool currently being used on the canvas void QgsMapCanvas::setMapTool( QgsMapTool* tool ) { if ( !tool ) @@ -1596,7 +1596,7 @@ void QgsMapCanvas::unsetMapTool( QgsMapTool* tool ) } } -/** Write property of QColor bgColor. */ +//! Write property of QColor bgColor. void QgsMapCanvas::setCanvasColor( const QColor & theColor ) { // background of map's pixmap @@ -1906,7 +1906,7 @@ void QgsMapCanvas::writeProject( QDomDocument & doc ) // TODO: store only units, extent, projections, dest CRS } -/** Ask user which datum transform to use*/ +//! Ask user which datum transform to use void QgsMapCanvas::getDatumTransformInfo( const QgsMapLayer* ml, const QString& srcAuthId, const QString& destAuthId ) { if ( !ml ) diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h index 54ae4af82f0..6914e0fb7fa 100644 --- a/src/gui/qgsmapcanvas.h +++ b/src/gui/qgsmapcanvas.h @@ -91,10 +91,10 @@ class GUI_EXPORT QgsMapCanvasLayer private: QgsMapLayer* mLayer; - /** Flag whether layer is visible */ + //! Flag whether layer is visible bool mVisible; - /** Flag whether layer is shown in overview */ + //! Flag whether layer is shown in overview bool mInOverview; }; @@ -234,10 +234,10 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView @param ids the feature ids*/ void panToFeatureIds( QgsVectorLayer* layer, const QgsFeatureIds& ids ); - /** Pan to the selected features of current (vector) layer keeping same extent. */ + //! Pan to the selected features of current (vector) layer keeping same extent. void panToSelected( QgsVectorLayer* layer = nullptr ); - /** \brief Sets the map tool currently being used on the canvas */ + //! \brief Sets the map tool currently being used on the canvas void setMapTool( QgsMapTool* mapTool ); /** \brief Unset the current map tool or last non zoom tool @@ -248,19 +248,19 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ void unsetMapTool( QgsMapTool* mapTool ); - /** Returns the currently active tool*/ + //! Returns the currently active tool QgsMapTool* mapTool(); - /** Write property of QColor bgColor. */ + //! Write property of QColor bgColor. void setCanvasColor( const QColor & _newVal ); - /** Read property of QColor bgColor. */ + //! Read property of QColor bgColor. QColor canvasColor() const; - /** Set color of selected vector features */ + //! Set color of selected vector features //! @note added in 2.4 void setSelectionColor( const QColor& color ); - /** Emits signal scaleChanged to update scale in main window */ + //! Emits signal scaleChanged to update scale in main window void updateScale(); //! return the map layer at position index in the layer stack @@ -431,7 +431,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView public slots: - /** Repaints the canvas map*/ + //! Repaints the canvas map void refresh(); //! Receives signal about selection change, and pass it on with layer info @@ -451,7 +451,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! State of render suppression flag bool renderFlag() {return mRenderFlag;} - /** A simple helper method to find out if on the fly projections are enabled or not */ + //! A simple helper method to find out if on the fly projections are enabled or not bool hasCrsTransformEnabled(); //! stop rendering (if there is any right now) @@ -527,11 +527,11 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView void renderComplete( QPainter * ); // ### QGIS 3: renamte to mapRefreshFinished() - /** Emitted when canvas finished a refresh request. */ + //! Emitted when canvas finished a refresh request. void mapCanvasRefreshed(); // ### QGIS 3: rename to mapRefreshStarted() - /** Emitted when the canvas is about to be rendered. */ + //! Emitted when the canvas is about to be rendered. void renderStarting(); //! Emitted when a new set of layers has been received diff --git a/src/gui/qgsmapcanvassnapper.h b/src/gui/qgsmapcanvassnapper.h index 794e0acb5fc..455f006e99e 100644 --- a/src/gui/qgsmapcanvassnapper.h +++ b/src/gui/qgsmapcanvassnapper.h @@ -72,9 +72,9 @@ class GUI_EXPORT QgsMapCanvasSnapper void setMapCanvas( QgsMapCanvas* canvas ); private: - /** Pointer to the map canvas*/ + //! Pointer to the map canvas QgsMapCanvas* mMapCanvas; - /** The object which does the snapping operations*/ + //! The object which does the snapping operations QgsSnapper* mSnapper; QgsMapCanvasSnapper( const QgsMapCanvasSnapper& rh ); diff --git a/src/gui/qgsmaplayeractionregistry.cpp b/src/gui/qgsmaplayeractionregistry.cpp index d5cab72b7b7..017223cb052 100644 --- a/src/gui/qgsmaplayeractionregistry.cpp +++ b/src/gui/qgsmaplayeractionregistry.cpp @@ -26,7 +26,7 @@ QgsMapLayerAction::QgsMapLayerAction( const QString& name, QObject* parent, Targ { } -/** Creates a map layer action which can run only on a specific layer*/ +//! Creates a map layer action which can run only on a specific layer QgsMapLayerAction::QgsMapLayerAction( const QString& name, QObject* parent, QgsMapLayer* layer, Targets targets, const QIcon& icon ) : QAction( icon, name, parent ) , mSingleLayer( true ) @@ -37,7 +37,7 @@ QgsMapLayerAction::QgsMapLayerAction( const QString& name, QObject* parent, QgsM { } -/** Creates a map layer action which can run on a specific type of layer*/ +//! Creates a map layer action which can run on a specific type of layer QgsMapLayerAction::QgsMapLayerAction( const QString& name, QObject* parent, QgsMapLayer::LayerType layerType, Targets targets, const QIcon& icon ) : QAction( icon, name, parent ) , mSingleLayer( false ) diff --git a/src/gui/qgsmaplayeractionregistry.h b/src/gui/qgsmaplayeractionregistry.h index 574bb18c448..90dab76835b 100644 --- a/src/gui/qgsmaplayeractionregistry.h +++ b/src/gui/qgsmaplayeractionregistry.h @@ -55,31 +55,31 @@ class GUI_EXPORT QgsMapLayerAction : public QAction ~QgsMapLayerAction(); - /** True if action can run using the specified layer */ + //! True if action can run using the specified layer bool canRunUsingLayer( QgsMapLayer* layer ) const; - /** Triggers the action with the specified layer and list of feature. */ + //! Triggers the action with the specified layer and list of feature. void triggerForFeatures( QgsMapLayer* layer, const QList& featureList ); - /** Triggers the action with the specified layer and feature. */ + //! Triggers the action with the specified layer and feature. void triggerForFeature( QgsMapLayer* layer, const QgsFeature* feature ); - /** Triggers the action with the specified layer. */ + //! Triggers the action with the specified layer. void triggerForLayer( QgsMapLayer* layer ); - /** Define the targets of the action */ + //! Define the targets of the action void setTargets( Targets targets ) {mTargets = targets;} - /** Return availibity of action */ + //! Return availibity of action const Targets& targets() const {return mTargets;} signals: - /** Triggered when action has been run for a specific list of features */ + //! Triggered when action has been run for a specific list of features void triggeredForFeatures( QgsMapLayer* layer, const QList& featureList ); - /** Triggered when action has been run for a specific feature */ + //! Triggered when action has been run for a specific feature void triggeredForFeature( QgsMapLayer* layer, const QgsFeature& feature ); - /** Triggered when action has been run for a specific layer */ + //! Triggered when action has been run for a specific layer void triggeredForLayer( QgsMapLayer* layer ); private: @@ -113,18 +113,18 @@ class GUI_EXPORT QgsMapLayerActionRegistry : public QObject ~QgsMapLayerActionRegistry(); - /** Adds a map layer action to the registry*/ + //! Adds a map layer action to the registry void addMapLayerAction( QgsMapLayerAction * action ); - /** Returns the map layer actions which can run on the specified layer*/ + //! Returns the map layer actions which can run on the specified layer QList mapLayerActions( QgsMapLayer* layer, QgsMapLayerAction::Targets targets = QgsMapLayerAction::AllActions ); - /** Removes a map layer action from the registry*/ + //! Removes a map layer action from the registry bool removeMapLayerAction( QgsMapLayerAction *action ); - /** Sets the default action for a layer*/ + //! Sets the default action for a layer void setDefaultActionForLayer( QgsMapLayer* layer, QgsMapLayerAction* action ); - /** Returns the default action for a layer*/ + //! Returns the default action for a layer QgsMapLayerAction * defaultActionForLayer( QgsMapLayer* layer ); protected: @@ -134,7 +134,7 @@ class GUI_EXPORT QgsMapLayerActionRegistry : public QObject QList< QgsMapLayerAction* > mMapLayerActionList; signals: - /** Triggered when an action is added or removed from the registry */ + //! Triggered when an action is added or removed from the registry void changed(); private: diff --git a/src/gui/qgsmaplayerconfigwidgetfactory.h b/src/gui/qgsmaplayerconfigwidgetfactory.h index 6bcf8c3aaec..061e91de6e8 100644 --- a/src/gui/qgsmaplayerconfigwidgetfactory.h +++ b/src/gui/qgsmaplayerconfigwidgetfactory.h @@ -31,13 +31,13 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory { public: - /** Constructor */ + //! Constructor QgsMapLayerConfigWidgetFactory(); - /** Constructor */ + //! Constructor QgsMapLayerConfigWidgetFactory( const QString &title, const QIcon &icon ); - /** Destructor */ + //! Destructor virtual ~QgsMapLayerConfigWidgetFactory(); /** diff --git a/src/gui/qgsmapmouseevent.h b/src/gui/qgsmapmouseevent.h index a18223aa926..08642b23acb 100644 --- a/src/gui/qgsmapmouseevent.h +++ b/src/gui/qgsmapmouseevent.h @@ -37,8 +37,8 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent enum SnappingMode { NoSnapping, - SnapProjectConfig, //!< snap according to the configuration set in the snapping settings - SnapAllLayers, //!< snap to all rendered layers (tolerance and type from defaultSettings()) + SnapProjectConfig, //!< Snap according to the configuration set in the snapping settings + SnapAllLayers, //!< Snap to all rendered layers (tolerance and type from defaultSettings()) }; /** diff --git a/src/gui/qgsmaptool.h b/src/gui/qgsmaptool.h index 0baaa619403..e059e2333a7 100644 --- a/src/gui/qgsmaptool.h +++ b/src/gui/qgsmaptool.h @@ -61,8 +61,8 @@ class GUI_EXPORT QgsMapTool : public QObject Transient = 1 << 1, /*!< Indicates that this map tool performs a transient (one-off) operation. If it does, the tool can be operated once and then a previous map tool automatically restored. */ - EditTool = 1 << 2, /*!< Map tool is an edit tool, which can only be used when layer is editable*/ - AllowZoomRect = 1 << 3, /*!< Allow zooming by rectangle (by holding shift and dragging) while the tool is active*/ + EditTool = 1 << 2, //!< Map tool is an edit tool, which can only be used when layer is editable + AllowZoomRect = 1 << 3, //!< Allow zooming by rectangle (by holding shift and dragging) while the tool is active }; Q_DECLARE_FLAGS( Flags, Flag ) @@ -106,17 +106,17 @@ class GUI_EXPORT QgsMapTool : public QObject * the previously used toolbutton to pop out. */ void setAction( QAction* action ); - /** Return associated action with map tool or NULL if no action is associated */ + //! Return associated action with map tool or NULL if no action is associated QAction* action(); /** Use this to associate a button to this maptool. It has the same meaning * as setAction() function except it works with a button instead of an QAction. */ void setButton( QAbstractButton* button ); - /** Return associated button with map tool or NULL if no button is associated */ + //! Return associated button with map tool or NULL if no button is associated QAbstractButton* button(); - /** Set a user defined cursor */ + //! Set a user defined cursor virtual void setCursor( const QCursor& cursor ); //! called when set as currently active map tool diff --git a/src/gui/qgsmaptooladvanceddigitizing.h b/src/gui/qgsmaptooladvanceddigitizing.h index f4d74efd358..d5796758d5a 100644 --- a/src/gui/qgsmaptooladvanceddigitizing.h +++ b/src/gui/qgsmaptooladvanceddigitizing.h @@ -124,10 +124,10 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit //! The capture mode in which this tool operates CaptureMode mCaptureMode; - bool mSnapOnPress; //!< snap on press - bool mSnapOnRelease; //!< snap on release - bool mSnapOnMove; //!< snap on move - bool mSnapOnDoubleClick; //!< snap on double click + bool mSnapOnPress; //!< Snap on press + bool mSnapOnRelease; //!< Snap on release + bool mSnapOnMove; //!< Snap on move + bool mSnapOnDoubleClick; //!< Snap on double click private slots: /** diff --git a/src/gui/qgsmaptoolcapture.h b/src/gui/qgsmaptoolcapture.h index 1e91e9078e5..07617bdf771 100644 --- a/src/gui/qgsmaptoolcapture.h +++ b/src/gui/qgsmaptoolcapture.h @@ -49,7 +49,7 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing //! deactive the tool virtual void deactivate() override; - /** Adds a whole curve (e.g. circularstring) to the captured geometry. Curve must be in map CRS*/ + //! Adds a whole curve (e.g. circularstring) to the captured geometry. Curve must be in map CRS int addCurve( QgsCurve* c ); /** @@ -134,7 +134,7 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing */ int addVertex( const QgsPoint& mapPoint, const QgsPointLocator::Match &match ); - /** Removes the last vertex from mRubberBand and mCaptureList*/ + //! Removes the last vertex from mRubberBand and mCaptureList void undo(); /** @@ -190,16 +190,16 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing bool tracingAddVertex( const QgsPoint& point ); private: - /** Flag to indicate a map canvas capture operation is taking place */ + //! Flag to indicate a map canvas capture operation is taking place bool mCapturing; - /** Rubber band for polylines and polygons */ + //! Rubber band for polylines and polygons QgsRubberBand* mRubberBand; - /** Temporary rubber band for polylines and polygons. this connects the last added point to the mouse cursor position */ + //! Temporary rubber band for polylines and polygons. this connects the last added point to the mouse cursor position QgsRubberBand* mTempRubberBand; - /** List to store the points of digitised lines and polygons (in layer coordinates)*/ + //! List to store the points of digitised lines and polygons (in layer coordinates) QgsCompoundCurve mCaptureCurve; void validateGeometry(); diff --git a/src/gui/qgsmaptooledit.h b/src/gui/qgsmaptooledit.h index 098a5f13b12..96df2e74f04 100644 --- a/src/gui/qgsmaptooledit.h +++ b/src/gui/qgsmaptooledit.h @@ -49,7 +49,7 @@ class GUI_EXPORT QgsMapToolEdit: public QgsMapTool QgsGeometryRubberBand* createGeometryRubberBand( QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry, bool alternativeBand = false ) const; - /** Returns the current vector layer of the map canvas or 0*/ + //! Returns the current vector layer of the map canvas or 0 QgsVectorLayer* currentVectorLayer(); /** Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons. @@ -58,9 +58,9 @@ class GUI_EXPORT QgsMapToolEdit: public QgsMapTool */ int addTopologicalPoints( const QList& geom ); - /** Display a timed message bar noting the active layer is not vector. */ + //! Display a timed message bar noting the active layer is not vector. void notifyNotVectorLayer(); - /** Display a timed message bar noting the active vector layer is not editable. */ + //! Display a timed message bar noting the active vector layer is not editable. void notifyNotEditableLayer(); }; diff --git a/src/gui/qgsmaptoolidentify.h b/src/gui/qgsmaptoolidentify.h index 9a795a37046..50ee925dbc8 100644 --- a/src/gui/qgsmaptoolidentify.h +++ b/src/gui/qgsmaptoolidentify.h @@ -151,7 +151,7 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool QgsIdentifyMenu* mIdentifyMenu; - /** Call the right method depending on layer type */ + //! Call the right method depending on layer type bool identifyLayer( QList *results, QgsMapLayer *layer, const QgsPoint& point, const QgsRectangle& viewExtent, double mapUnitsPerPixel, QgsMapToolIdentify::LayerType layerType = AllLayers ); bool identifyRasterLayer( QList *results, QgsRasterLayer *layer, QgsPoint point, const QgsRectangle& viewExtent, double mapUnitsPerPixel ); diff --git a/src/gui/qgsnewgeopackagelayerdialog.h b/src/gui/qgsnewgeopackagelayerdialog.h index 8bba4fb8501..4ce0ae302e4 100644 --- a/src/gui/qgsnewgeopackagelayerdialog.h +++ b/src/gui/qgsnewgeopackagelayerdialog.h @@ -30,7 +30,7 @@ class GUI_EXPORT QgsNewGeoPackageLayerDialog: public QDialog, private Ui::QgsNew Q_OBJECT public: - /** Constructor */ + //! Constructor QgsNewGeoPackageLayerDialog( QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags ); ~QgsNewGeoPackageLayerDialog(); diff --git a/src/gui/qgsnewmemorylayerdialog.h b/src/gui/qgsnewmemorylayerdialog.h index ff62c8bae34..4bdab8fff33 100644 --- a/src/gui/qgsnewmemorylayerdialog.h +++ b/src/gui/qgsnewmemorylayerdialog.h @@ -41,13 +41,13 @@ class GUI_EXPORT QgsNewMemoryLayerDialog: public QDialog, private Ui::QgsNewMemo QgsNewMemoryLayerDialog( QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags ); ~QgsNewMemoryLayerDialog(); - /** Returns the selected geometry type*/ + //! Returns the selected geometry type QgsWkbTypes::Type selectedType() const; - /** Returns the selected crs*/ + //! Returns the selected crs QgsCoordinateReferenceSystem crs() const; - /** Returns the layer name*/ + //! Returns the layer name QString layerName() const; private: diff --git a/src/gui/qgsnewvectorlayerdialog.h b/src/gui/qgsnewvectorlayerdialog.h index 5a8530456ad..0f0a247e02e 100644 --- a/src/gui/qgsnewvectorlayerdialog.h +++ b/src/gui/qgsnewvectorlayerdialog.h @@ -38,15 +38,15 @@ class GUI_EXPORT QgsNewVectorLayerDialog: public QDialog, private Ui::QgsNewVect QgsNewVectorLayerDialog( QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags ); ~QgsNewVectorLayerDialog(); - /** Returns the selected geometry type*/ + //! Returns the selected geometry type QgsWkbTypes::Type selectedType() const; - /** Appends the chosen attribute names and types to at*/ + //! Appends the chosen attribute names and types to at void attributes( QList< QPair >& at ) const; - /** Returns the file format for storage*/ + //! Returns the file format for storage QString selectedFileFormat() const; - /** Returns the file format for storage*/ + //! Returns the file format for storage QString selectedFileEncoding() const; - /** Returns the selected crs id*/ + //! Returns the selected crs id int selectedCrsId() const; protected slots: diff --git a/src/gui/qgsowssourceselect.h b/src/gui/qgsowssourceselect.h index c3898f5fa87..aefec6659bb 100644 --- a/src/gui/qgsowssourceselect.h +++ b/src/gui/qgsowssourceselect.h @@ -49,7 +49,7 @@ class GUI_EXPORT QgsOWSSourceSelect : public QDialog, public Ui::QgsOWSSourceSel Q_OBJECT public: - /** Formats supported by provider */ + //! Formats supported by provider struct SupportedFormat { QString format; diff --git a/src/gui/qgsprojectbadlayerguihandler.h b/src/gui/qgsprojectbadlayerguihandler.h index a773bb4fea8..bf3e97cd4a7 100644 --- a/src/gui/qgsprojectbadlayerguihandler.h +++ b/src/gui/qgsprojectbadlayerguihandler.h @@ -32,11 +32,11 @@ class GUI_EXPORT QgsProjectBadLayerGuiHandler : public QObject, public QgsProjec virtual void handleBadLayers( const QList& layers ) override; - /** Flag to store the Ignore button press of MessageBox used by QgsLegend */ + //! Flag to store the Ignore button press of MessageBox used by QgsLegend static bool mIgnore; protected: - /** This is used to locate files that have moved or otherwise are missing */ + //! This is used to locate files that have moved or otherwise are missing bool findMissingFile( const QString& fileFilters, QDomNode& layerNode ); /** diff --git a/src/gui/qgsprojectionselectionwidget.h b/src/gui/qgsprojectionselectionwidget.h index 32830c5966b..25019b5d791 100644 --- a/src/gui/qgsprojectionselectionwidget.h +++ b/src/gui/qgsprojectionselectionwidget.h @@ -41,11 +41,11 @@ class GUI_EXPORT QgsProjectionSelectionWidget : public QWidget */ enum CrsOption { - LayerCrs, /*!< optional layer CRS */ - ProjectCrs, /*!< current project CRS (if OTF reprojection enabled) */ - CurrentCrs, /*!< current user selected CRS */ - DefaultCrs, /*!< global default QGIS CRS */ - RecentCrs /*!< recently used CRS */ + LayerCrs, //!< Optional layer CRS + ProjectCrs, //!< Current project CRS (if OTF reprojection enabled) + CurrentCrs, //!< Current user selected CRS + DefaultCrs, //!< Global default QGIS CRS + RecentCrs //!< Recently used CRS }; explicit QgsProjectionSelectionWidget( QWidget *parent = nullptr ); diff --git a/src/gui/qgsprojectionselector.h b/src/gui/qgsprojectionselector.h index 5ffc59f8f95..720f9cf153c 100644 --- a/src/gui/qgsprojectionselector.h +++ b/src/gui/qgsprojectionselector.h @@ -108,10 +108,10 @@ class GUI_EXPORT QgsProjectionSelector : public QWidget, private Ui::QgsProjecti void pushProjectionToFront(); protected: - /** Used to ensure the projection list view is actually populated */ + //! Used to ensure the projection list view is actually populated void showEvent( QShowEvent * theEvent ) override; - /** Used to manage column sizes */ + //! Used to manage column sizes void resizeEvent( QResizeEvent * theEvent ) override; private: @@ -147,7 +147,7 @@ class GUI_EXPORT QgsProjectionSelector : public QWidget, private Ui::QgsProjecti */ QString getSelectedExpression( const QString& e ); - /** Show the user a warning if the srs database could not be found */ + //! Show the user a warning if the srs database could not be found void showDBMissingWarning( const QString& theFileName ); // List view nodes for the tree view of projections //! User defined projections node diff --git a/src/gui/qgsrubberband.h b/src/gui/qgsrubberband.h index 9de42aa49fc..38dba39a312 100644 --- a/src/gui/qgsrubberband.h +++ b/src/gui/qgsrubberband.h @@ -33,7 +33,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem { public: - /** Icons */ + //! Icons enum IconType { /** @@ -247,10 +247,10 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem QBrush mBrush; QPen mPen; - /** The size of the icon for points. */ + //! The size of the icon for points. int mIconSize; - /** Icon to be shown. */ + //! Icon to be shown. IconType mIconType; /** diff --git a/src/gui/qgssearchquerybuilder.cpp b/src/gui/qgssearchquerybuilder.cpp index 905c58a2b94..51e589479cb 100644 --- a/src/gui/qgssearchquerybuilder.cpp +++ b/src/gui/qgssearchquerybuilder.cpp @@ -130,7 +130,7 @@ void QgsSearchQueryBuilder::getFieldValues( int limit ) mModelValues->blockSignals( true ); lstValues->setUpdatesEnabled( false ); - /** MH: keep already inserted values in a set. Querying is much faster compared to QStandardItemModel::findItems*/ + //! MH: keep already inserted values in a set. Querying is much faster compared to QStandardItemModel::findItems QSet insertedValues; while ( fit.nextFeature( feat ) && diff --git a/src/gui/qgssourceselectdialog.cpp b/src/gui/qgssourceselectdialog.cpp index 09b16433a79..bbe33ca1869 100644 --- a/src/gui/qgssourceselectdialog.cpp +++ b/src/gui/qgssourceselectdialog.cpp @@ -43,7 +43,7 @@ class QgsSourceSelectItemDelegate : public QItemDelegate { public: - /** Constructor */ + //! Constructor QgsSourceSelectItemDelegate( QObject *parent = 0 ) : QItemDelegate( parent ) { } QSize sizeHint( const QStyleOptionViewItem &option, const QModelIndex &index ) const override; }; diff --git a/src/gui/qgssourceselectdialog.h b/src/gui/qgssourceselectdialog.h index 2718fdafca7..c5738b3da30 100644 --- a/src/gui/qgssourceselectdialog.h +++ b/src/gui/qgssourceselectdialog.h @@ -33,20 +33,20 @@ class GUI_EXPORT QgsSourceSelectDialog : public QDialog, protected Ui::QgsSource Q_OBJECT public: - /** Whether the dialog is for a map service or a feature service */ + //! Whether the dialog is for a map service or a feature service enum ServiceType { MapService, FeatureService }; - /** Constructor */ + //! Constructor QgsSourceSelectDialog( const QString& serviceName, ServiceType serviceType, QWidget* parent, Qt::WindowFlags fl ); - /** Destructor */ + //! Destructor ~QgsSourceSelectDialog(); - /** Sets the current extent and CRS. Used to select an appropriate CRS and possibly to retrieve data only in the current extent */ + //! Sets the current extent and CRS. Used to select an appropriate CRS and possibly to retrieve data only in the current extent void setCurrentExtentAndCrs( const QgsRectangle& canvasExtent, const QgsCoordinateReferenceSystem& canvasCrs ); signals: - /** Emitted when a layer is added from the dialog */ + //! Emitted when a layer is added from the dialog void addLayer( QString uri, QString typeName ); - /** Emitted when the connections for the service were changed */ + //! Emitted when the connections for the service were changed void connectionsChanged(); protected: @@ -63,20 +63,20 @@ class GUI_EXPORT QgsSourceSelectDialog : public QDialog, protected Ui::QgsSource QgsRectangle mCanvasExtent; QgsCoordinateReferenceSystem mCanvasCrs; - /** To be implemented in the child class. Called when a new connection is initiated. */ + //! To be implemented in the child class. Called when a new connection is initiated. virtual bool connectToService( const QgsOwsConnection& connection ) = 0; - /** May be implemented in child classes for services which support customized queries. */ + //! May be implemented in child classes for services which support customized queries. virtual void buildQuery( const QgsOwsConnection&, const QModelIndex& ) {} - /** To be implemented in the child class. Constructs an URI for the specified service layer. */ + //! To be implemented in the child class. Constructs an URI for the specified service layer. virtual QString getLayerURI( const QgsOwsConnection& connection, const QString& layerTitle, const QString& layerName, const QString& crs = QString(), const QString& filter = QString(), const QgsRectangle& bBox = QgsRectangle() ) const = 0; - /** Updates the UI for the list of available image encodings from the specified list. */ + //! Updates the UI for the list of available image encodings from the specified list. void populateImageEncodings( const QStringList& availableEncodings ); - /** Returns the selected image encoding. */ + //! Returns the selected image encoding. QString getSelectedImageEncoding() const; private: diff --git a/src/gui/qgssublayersdialog.h b/src/gui/qgssublayersdialog.h index 4a024c01873..992975c7c71 100644 --- a/src/gui/qgssublayersdialog.h +++ b/src/gui/qgssublayersdialog.h @@ -41,10 +41,10 @@ class GUI_EXPORT QgsSublayersDialog : public QDialog, private Ui::QgsSublayersDi { LayerDefinition() : layerId( -1 ), count( -1 ) {} - int layerId; //!< identifier of the layer (one unique layer id may have multiple types though) - QString layerName; //!< name of the layer (not necessarily unique) - int count; //!< number of features (might be unused) - QString type; //!< extra type depending on the use (e.g. geometry type for vector sublayers) + int layerId; //!< Identifier of the layer (one unique layer id may have multiple types though) + QString layerName; //!< Name of the layer (not necessarily unique) + int count; //!< Number of features (might be unused) + QString type; //!< Extra type depending on the use (e.g. geometry type for vector sublayers) } LayerDefinition; //! List of layer definitions for the purpose of this dialog @@ -69,8 +69,8 @@ class GUI_EXPORT QgsSublayersDialog : public QDialog, private Ui::QgsSublayersDi protected: QString mName; QStringList mSelectedSubLayers; - bool mShowCount; //!< whether to show number of features in the table - bool mShowType; //!< whether to show type in the table + bool mShowCount; //!< Whether to show number of features in the table + bool mShowType; //!< Whether to show type in the table }; #endif diff --git a/src/gui/qgstextannotationitem.h b/src/gui/qgstextannotationitem.h index a30b7218923..0f402ab9a4a 100644 --- a/src/gui/qgstextannotationitem.h +++ b/src/gui/qgstextannotationitem.h @@ -29,9 +29,9 @@ class GUI_EXPORT QgsTextAnnotationItem: public QgsAnnotationItem QgsTextAnnotationItem( QgsMapCanvas* canvas ); ~QgsTextAnnotationItem(); - /** Returns document (caller takes ownership)*/ + //! Returns document (caller takes ownership) QTextDocument* document() const; - /** Sets document (does not take ownership)*/ + //! Sets document (does not take ownership) void setDocument( const QTextDocument* doc ); void writeXml( QDomDocument& doc ) const override; diff --git a/src/gui/qgstreewidgetitem.h b/src/gui/qgstreewidgetitem.h index 9232b7eb930..70304919312 100644 --- a/src/gui/qgstreewidgetitem.h +++ b/src/gui/qgstreewidgetitem.h @@ -144,14 +144,14 @@ class GUI_EXPORT QgsTreeWidgetItemObject: public QObject, public QgsTreeWidgetIt */ explicit QgsTreeWidgetItemObject( int type = Type ); - /** Constructs a tree widget item of the specified type and appends it to the items in the given parent. */ + //! Constructs a tree widget item of the specified type and appends it to the items in the given parent. explicit QgsTreeWidgetItemObject( QTreeWidget * parent, int type = Type ); - /** Sets the value for the item's column and role to the given value. */ + //! Sets the value for the item's column and role to the given value. virtual void setData( int column, int role, const QVariant & value ); signals: - /** This signal is emitted when the contents of the column in the specified item has been edited by the user. */ + //! This signal is emitted when the contents of the column in the specified item has been edited by the user. void itemEdited( QTreeWidgetItem* item, int column ); }; diff --git a/src/gui/qgsunitselectionwidget.h b/src/gui/qgsunitselectionwidget.h index 3fd8ae789fd..e752021d099 100644 --- a/src/gui/qgsunitselectionwidget.h +++ b/src/gui/qgsunitselectionwidget.h @@ -164,7 +164,7 @@ class GUI_EXPORT QgsUnitSelectionWidget : public QWidget, private Ui::QgsUnitSel */ void setUnits( const QgsUnitTypes::RenderUnitList& units ); - /** Get the selected unit index */ + //! Get the selected unit index int getUnit() const { return mUnitCombo->currentIndex(); } /** Returns the current predefined selected unit (if applicable). @@ -184,10 +184,10 @@ class GUI_EXPORT QgsUnitSelectionWidget : public QWidget, private Ui::QgsUnitSel */ void setUnit( QgsUnitTypes::RenderUnit unit ); - /** Returns the map unit scale */ + //! Returns the map unit scale QgsMapUnitScale getMapUnitScale() const { return mMapUnitScale; } - /** Sets the map unit scale */ + //! Sets the map unit scale void setMapUnitScale( const QgsMapUnitScale& scale ) { mMapUnitScale = scale; } /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current diff --git a/src/gui/raster/qgsmultibandcolorrendererwidget.h b/src/gui/raster/qgsmultibandcolorrendererwidget.h index b23f9836e90..6c121ac0df7 100644 --- a/src/gui/raster/qgsmultibandcolorrendererwidget.h +++ b/src/gui/raster/qgsmultibandcolorrendererwidget.h @@ -62,7 +62,7 @@ class GUI_EXPORT QgsMultiBandColorRendererWidget: public QgsRasterRendererWidget void createValidators(); void setCustomMinMaxValues( QgsMultiBandColorRenderer* r, const QgsRasterDataProvider* provider, int redBand, int GreenBand, int blueBand ); - /** Reads min/max values from contrast enhancement and fills values into the min/max line edits*/ + //! Reads min/max values from contrast enhancement and fills values into the min/max line edits void setMinMaxValue( const QgsContrastEnhancement* ce, QLineEdit* minEdit, QLineEdit* maxEdit ); QgsRasterMinMaxWidget * mMinMaxWidget; }; diff --git a/src/gui/raster/qgsrasterhistogramwidget.h b/src/gui/raster/qgsrasterhistogramwidget.h index b56bc32717b..171685fcae7 100644 --- a/src/gui/raster/qgsrasterhistogramwidget.h +++ b/src/gui/raster/qgsrasterhistogramwidget.h @@ -45,52 +45,52 @@ class GUI_EXPORT QgsRasterHistogramWidget : public QgsMapLayerConfigWidget, priv QgsRasterHistogramWidget( QgsRasterLayer *lyr, QWidget *parent = nullptr ); ~QgsRasterHistogramWidget(); - /** Save the histogram as an image to disk */ + //! Save the histogram as an image to disk bool histoSaveAsImage( const QString& theFilename, int width = 600, int height = 600, int quality = -1 ); - /** Set the renderer widget (or just its name if there is no widget) */ + //! Set the renderer widget (or just its name if there is no widget) void setRendererWidget( const QString& name, QgsRasterRendererWidget* rendererWidget = nullptr ); - /** Activate the histogram widget */ + //! Activate the histogram widget void setActive( bool theActiveFlag ); - /** \brief Compute the histogram on demand. */ + //! \brief Compute the histogram on demand. bool computeHistogram( bool forceComputeFlag ); - /** Apply a histoActionTriggered() event. */ + //! Apply a histoActionTriggered() event. void histoAction( const QString &actionName, bool actionFlag = true ); - /** Apply a histoActionTriggered() event. */ + //! Apply a histoActionTriggered() event. void setSelectedBand( int index ); public slots: - /** \brief slot executed when user wishes to refresh raster histogramwidget */ + //! \brief slot executed when user wishes to refresh raster histogramwidget void refreshHistogram(); - /** This slot lets you save the histogram as an image to disk */ + //! This slot lets you save the histogram as an image to disk void on_mSaveAsImageButton_clicked(); void apply() override; private slots: - /** Used when the histogram band selector changes, or when tab is loaded. */ + //! Used when the histogram band selector changes, or when tab is loaded. void on_cboHistoBand_currentIndexChanged( int ); - /** Applies the selected min/max values to the renderer widget. */ + //! Applies the selected min/max values to the renderer widget. void applyHistoMin(); void applyHistoMax(); - /** Button to activate picking of the min/max value on the graph. */ + //! Button to activate picking of the min/max value on the graph. void on_btnHistoMin_toggled(); void on_btnHistoMax_toggled(); - /** Called when a selection has been made using the plot picker. */ + //! Called when a selection has been made using the plot picker. void histoPickerSelected( QPointF ); /** Called when a selection has been made using the plot picker (for qwt5 only). @note not available in python bindings */ void histoPickerSelectedQwt5( QwtDoublePoint ); - /** Various actions that are stored in btnHistoActions. */ + //! Various actions that are stored in btnHistoActions. void histoActionTriggered( QAction* ); - /** Draw the min/max markers on the histogram plot. */ + //! Draw the min/max markers on the histogram plot. void updateHistoMarkers(); - /** Button to compute the histogram, appears when no cached histogram is available. */ + //! Button to compute the histogram, appears when no cached histogram is available. void on_btnHistoCompute_clicked(); private: @@ -102,11 +102,11 @@ class GUI_EXPORT QgsRasterHistogramWidget : public QgsMapLayerConfigWidget, priv ShowRGB = 2 }; - /** \brief Pointer to the raster layer that this property dilog changes the behaviour of. */ + //! \brief Pointer to the raster layer that this property dilog changes the behaviour of. QgsRasterLayer * mRasterLayer; - /** \brief Pointer to the renderer widget, to get/set min/max. */ + //! \brief Pointer to the renderer widget, to get/set min/max. QgsRasterRendererWidget* mRendererWidget; - /** \brief Name of the renderer widget (see QgsRasterRendererRegistry). */ + //! \brief Name of the renderer widget (see QgsRasterRendererRegistry). QString mRendererName; QwtPlotPicker* mHistoPicker; @@ -122,9 +122,9 @@ class GUI_EXPORT QgsRasterHistogramWidget : public QgsMapLayerConfigWidget, priv bool mHistoDrawLines; /* bool mHistoLoadApplyAll; */ HistoShowBands mHistoShowBands; - /** \brief Returns a list of selected bands in the histogram widget- or empty if there is no selection restriction. */ + //! \brief Returns a list of selected bands in the histogram widget- or empty if there is no selection restriction. QList< int > histoSelectedBands(); - /** \brief Returns a list of selected bands in the renderer widget. */ + //! \brief Returns a list of selected bands in the renderer widget. QList< int > rendererSelectedBands(); QPair< QString, QString > rendererMinMax( int theBandNo ); }; diff --git a/src/gui/raster/qgsrasterminmaxwidget.h b/src/gui/raster/qgsrasterminmaxwidget.h index 8b96c56ddc5..b1087c9619d 100644 --- a/src/gui/raster/qgsrasterminmaxwidget.h +++ b/src/gui/raster/qgsrasterminmaxwidget.h @@ -64,7 +64,7 @@ class GUI_EXPORT QgsRasterMinMaxWidget: public QWidget, private Ui::QgsRasterMin */ QgsRectangle extent(); - /** Return the selected sample size. */ + //! Return the selected sample size. int sampleSize() { return cboAccuracy->currentIndex() == 0 ? 250000 : 0; } // Load programmaticaly with current values diff --git a/src/gui/raster/qgsrasterrendererwidget.h b/src/gui/raster/qgsrasterrendererwidget.h index a795aa6ed84..2ddfde59293 100644 --- a/src/gui/raster/qgsrasterrendererwidget.h +++ b/src/gui/raster/qgsrasterrendererwidget.h @@ -90,10 +90,10 @@ class GUI_EXPORT QgsRasterRendererWidget: public QWidget protected: QgsRasterLayer* mRasterLayer; - /** Returns a band name for display. First choice is color name, otherwise band number*/ + //! Returns a band name for display. First choice is color name, otherwise band number QString displayBandName( int band ) const; - /** Current extent */ + //! Current extent QgsRectangle mExtent; //! Associated map canvas diff --git a/src/gui/raster/qgsrastertransparencywidget.h b/src/gui/raster/qgsrastertransparencywidget.h index de06b834693..600f5152d4e 100644 --- a/src/gui/raster/qgsrastertransparencywidget.h +++ b/src/gui/raster/qgsrastertransparencywidget.h @@ -56,36 +56,36 @@ class GUI_EXPORT QgsRasterTransparencyWidget : public QgsMapLayerConfigWidget, p void pixelSelected( const QgsPoint& canvasPoint ); - /** Transparency cell changed */ + //! Transparency cell changed void transparencyCellTextEdited( const QString & text ); - /** \brief slot executed when the transparency level changes. */ + //! \brief slot executed when the transparency level changes. void sliderTransparency_valueChanged( int theValue ); - /** \brief slot executed when user presses "Add Values From Display" button on the transparency page */ + //! \brief slot executed when user presses "Add Values From Display" button on the transparency page void on_pbnAddValuesFromDisplay_clicked(); - /** \brief slot executed when user presses "Add Values Manually" button on the transparency page */ + //! \brief slot executed when user presses "Add Values Manually" button on the transparency page void on_pbnAddValuesManually_clicked(); - /** \brief slot executed when user wishes to reset noNoDataValue and transparencyTable to default value */ + //! \brief slot executed when user wishes to reset noNoDataValue and transparencyTable to default value void on_pbnDefaultValues_clicked(); - /** \brief slot executed when user wishes to export transparency values */ + //! \brief slot executed when user wishes to export transparency values void on_pbnExportTransparentPixelValues_clicked(); - /** \brief slow executed when user wishes to import transparency values */ + //! \brief slow executed when user wishes to import transparency values void on_pbnImportTransparentPixelValues_clicked(); - /** \brief slot executed when user presses "Remove Selected Row" button on the transparency page */ + //! \brief slot executed when user presses "Remove Selected Row" button on the transparency page void on_pbnRemoveSelectedRow_clicked(); private: - /** \brief A constant that signals property not used */ + //! \brief A constant that signals property not used const QString TRSTRING_NOT_SET; bool rasterIsMultiBandColor(); - /** \brief Clear the current transparency table and populate the table with the correct types for current drawing mode and data type*/ + //! \brief Clear the current transparency table and populate the table with the correct types for current drawing mode and data type void populateTransparencyTable( QgsRasterRenderer* renderer ); void setupTransparencyTable( int nBands ); diff --git a/src/gui/raster/qgsrendererrasterpropertieswidget.h b/src/gui/raster/qgsrendererrasterpropertieswidget.h index 1c59290960d..42ce972ed13 100644 --- a/src/gui/raster/qgsrendererrasterpropertieswidget.h +++ b/src/gui/raster/qgsrendererrasterpropertieswidget.h @@ -70,13 +70,13 @@ class GUI_EXPORT QgsRendererRasterPropertiesWidget : public QgsMapLayerConfigWid void syncToLayer( QgsRasterLayer *layer ); private slots: - /** Slot to reset all color rendering options to default */ + //! Slot to reset all color rendering options to default void on_mResetColorRenderingBtn_clicked(); - /** Enable or disable saturation controls depending on choice of grayscale mode */ + //! Enable or disable saturation controls depending on choice of grayscale mode void toggleSaturationControls( int grayscaleMode ); - /** Enable or disable colorize controls depending on checkbox */ + //! Enable or disable colorize controls depending on checkbox void toggleColorizeControls( bool colorizeEnabled ); private: void setRendererWidget( const QString& rendererName ); diff --git a/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp b/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp index 437711a42c0..b1d5de8ba0c 100644 --- a/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp +++ b/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp @@ -218,7 +218,7 @@ void QgsSingleBandPseudoColorRendererWidget::autoLabel() } } -/** Extract the unit out of the current labels and set the unit field. */ +//! Extract the unit out of the current labels and set the unit field. void QgsSingleBandPseudoColorRendererWidget::setUnitFromLabels() { QgsColorRampShader::ColorRamp_TYPE interpolation = static_cast< QgsColorRampShader::ColorRamp_TYPE >( mColorInterpolationComboBox->currentData().toInt() ); @@ -761,7 +761,7 @@ void QgsSingleBandPseudoColorRendererWidget::on_mColormapTreeWidget_itemDoubleCl } } -/** Update the colormap table after manual edit. */ +//! Update the colormap table after manual edit. void QgsSingleBandPseudoColorRendererWidget::mColormapTreeWidget_itemEdited( QTreeWidgetItem* item, int column ) { Q_UNUSED( item ); diff --git a/src/gui/symbology-ng/qgsarrowsymbollayerwidget.h b/src/gui/symbology-ng/qgsarrowsymbollayerwidget.h index f6c1f298e03..11303e80005 100644 --- a/src/gui/symbology-ng/qgsarrowsymbollayerwidget.h +++ b/src/gui/symbology-ng/qgsarrowsymbollayerwidget.h @@ -39,9 +39,9 @@ class GUI_EXPORT QgsArrowSymbolLayerWidget: public QgsSymbolLayerWidget, private */ static QgsSymbolLayerWidget* create( const QgsVectorLayer* layer ) { return new QgsArrowSymbolLayerWidget( layer ); } - /** Set the symbol layer */ + //! Set the symbol layer virtual void setSymbolLayer( QgsSymbolLayer* layer ) override; - /** Get the current symbol layer */ + //! Get the current symbol layer virtual QgsSymbolLayer* symbolLayer() override; private: diff --git a/src/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.h b/src/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.h index 70861dacebf..e2f95eafb7d 100644 --- a/src/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.h +++ b/src/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.h @@ -100,13 +100,13 @@ class GUI_EXPORT QgsGraduatedSymbolRendererWidget : public QgsRendererWidget, pr void rangesClicked( const QModelIndex & idx ); void changeCurrentValue( QStandardItem * item ); - /** Adds a class manually to the classification*/ + //! Adds a class manually to the classification void addClass(); - /** Removes currently selected classes */ + //! Removes currently selected classes void deleteClasses(); - /** Removes all classes from the classification*/ + //! Removes all classes from the classification void deleteAllClasses(); - /** Toggle the link between classes boundaries */ + //! Toggle the link between classes boundaries void toggleBoundariesLink( bool linked ); void labelFormatChanged(); diff --git a/src/gui/symbology-ng/qgsheatmaprendererwidget.h b/src/gui/symbology-ng/qgsheatmaprendererwidget.h index cce959a500e..18cff757992 100644 --- a/src/gui/symbology-ng/qgsheatmaprendererwidget.h +++ b/src/gui/symbology-ng/qgsheatmaprendererwidget.h @@ -43,7 +43,7 @@ class GUI_EXPORT QgsHeatmapRendererWidget : public QgsRendererWidget, private Ui */ QgsHeatmapRendererWidget( QgsVectorLayer* layer, QgsStyle* style, QgsFeatureRenderer* renderer ); - /** @returns the current feature renderer */ + //! @returns the current feature renderer virtual QgsFeatureRenderer* renderer() override; virtual void setContext( const QgsSymbolWidgetContext& context ) override; diff --git a/src/gui/symbology-ng/qgsinvertedpolygonrendererwidget.h b/src/gui/symbology-ng/qgsinvertedpolygonrendererwidget.h index 526ac40a328..938d83f98ee 100644 --- a/src/gui/symbology-ng/qgsinvertedpolygonrendererwidget.h +++ b/src/gui/symbology-ng/qgsinvertedpolygonrendererwidget.h @@ -45,15 +45,15 @@ class GUI_EXPORT QgsInvertedPolygonRendererWidget : public QgsRendererWidget, pr */ QgsInvertedPolygonRendererWidget( QgsVectorLayer* layer, QgsStyle* style, QgsFeatureRenderer* renderer ); - /** @returns the current feature renderer */ + //! @returns the current feature renderer virtual QgsFeatureRenderer* renderer() override; void setContext( const QgsSymbolWidgetContext& context ) override; protected: - /** The mask renderer */ + //! The mask renderer QScopedPointer mRenderer; - /** The widget used to represent the mask's embedded renderer */ + //! The widget used to represent the mask's embedded renderer QScopedPointer mEmbeddedRendererWidget; private slots: diff --git a/src/gui/symbology-ng/qgsrendererwidget.h b/src/gui/symbology-ng/qgsrendererwidget.h index aa92910d9fa..07ef7ece517 100644 --- a/src/gui/symbology-ng/qgsrendererwidget.h +++ b/src/gui/symbology-ng/qgsrendererwidget.h @@ -100,17 +100,17 @@ class GUI_EXPORT QgsRendererWidget : public QgsPanelWidget protected slots: void contextMenuViewCategories( QPoint p ); - /** Change color of selected symbols*/ + //! Change color of selected symbols void changeSymbolColor(); - /** Change opacity of selected symbols*/ + //! Change opacity of selected symbols void changeSymbolTransparency(); - /** Change units mm/map units of selected symbols*/ + //! Change units mm/map units of selected symbols void changeSymbolUnit(); - /** Change line widths of selected symbols*/ + //! Change line widths of selected symbols void changeSymbolWidth(); - /** Change marker sizes of selected symbols*/ + //! Change marker sizes of selected symbols void changeSymbolSize(); - /** Change marker angles of selected symbols*/ + //! Change marker angles of selected symbols void changeSymbolAngle(); virtual void copy() {} diff --git a/src/gui/symbology-ng/qgssvgselectorwidget.h b/src/gui/symbology-ng/qgssvgselectorwidget.h index af56928b51f..89f3c0a203a 100644 --- a/src/gui/symbology-ng/qgssvgselectorwidget.h +++ b/src/gui/symbology-ng/qgssvgselectorwidget.h @@ -246,7 +246,7 @@ class GUI_EXPORT QgsSvgSelectorWidget : public QWidget, private Ui::WidgetSvgSel QLayout* selectorLayout() { return this->layout(); } public slots: - /** Accepts absolute and relative paths */ + //! Accepts absolute and relative paths void setSvgPath( const QString& svgPath ); signals: diff --git a/src/gui/symbology-ng/qgssymbolslistwidget.h b/src/gui/symbology-ng/qgssymbolslistwidget.h index dd880936401..3e65c4255b4 100644 --- a/src/gui/symbology-ng/qgssymbolslistwidget.h +++ b/src/gui/symbology-ng/qgssymbolslistwidget.h @@ -97,9 +97,9 @@ class GUI_EXPORT QgsSymbolsListWidget : public QWidget, private Ui::SymbolsListW void updateSymbolColor(); void updateSymbolInfo(); - /** Displays alpha value as transparency in mTransparencyLabel*/ + //! Displays alpha value as transparency in mTransparencyLabel void displayTransparency( double alpha ); - /** Recursive function to create the group tree in the widget */ + //! Recursive function to create the group tree in the widget void populateGroups( const QString& parent = "", const QString& prepend = "" ); QgsSymbolWidgetContext mContext; diff --git a/src/plugins/evis/databaseconnection/evisdatabaseconnection.h b/src/plugins/evis/databaseconnection/evisdatabaseconnection.h index bea78e35fb4..1240323c6d2 100644 --- a/src/plugins/evis/databaseconnection/evisdatabaseconnection.h +++ b/src/plugins/evis/databaseconnection/evisdatabaseconnection.h @@ -42,7 +42,7 @@ class eVisDatabaseConnection public: - /** \brief Enum containting the type of database supported by this class */ + //! \brief Enum containting the type of database supported by this class enum DATABASE_TYPE { UNDEFINED, @@ -53,72 +53,72 @@ class eVisDatabaseConnection QSQLITE } mDatabaseType; - /** \brief Constructor */ + //! \brief Constructor eVisDatabaseConnection( const QString&, int, const QString&, const QString&, const QString&, DATABASE_TYPE ); - /** \brief Public method that finalizes a connection to a databse */ + //! \brief Public method that finalizes a connection to a databse bool connect(); - /** \brief Public method that passes an SQL statement to the database for execution */ + //! \brief Public method that passes an SQL statement to the database for execution QSqlQuery* query( const QString& ); - /** \brief Public method for resetting the database connection parameters - equivalent to re running the constructor */ + //! \brief Public method for resetting the database connection parameters - equivalent to re running the constructor void resetConnectionParameters( const QString&, int, const QString&, const QString&, const QString&, DATABASE_TYPE ); - /** \brief Returns a list of tables in the current database */ + //! \brief Returns a list of tables in the current database QStringList tables(); - /** \brief Accessor to the database type */ + //! \brief Accessor to the database type DATABASE_TYPE databaseType() { return mDatabaseType; } - /** \brief Public method for closing the current database connection */ + //! \brief Public method for closing the current database connection void close() { mDatabase.close(); } - /** \brief Public method for requesting the last error reported by the database connect or query */ + //! \brief Public method for requesting the last error reported by the database connect or query QString lastError() { return mLastError; } - /** \brief Mutator for database type */ + //! \brief Mutator for database type void setDatabaseType( DATABASE_TYPE connectionType ) { mDatabaseType = connectionType; } protected: - /** \brief Variable used to store the query results */ + //! \brief Variable used to store the query results QSqlQuery mQuery; private: - /** \brief Host name for the database server */ + //! \brief Host name for the database server QString mHostName; - /** \brief Port number the database server is listenting to */ + //! \brief Port number the database server is listenting to int mPort; - /** \brief Database name, can also be a filename in the case of SQLite or MSAccess */ + //! \brief Database name, can also be a filename in the case of SQLite or MSAccess QString mDatabaseName; - /** \brief Username for accessing the database */ + //! \brief Username for accessing the database QString mUsername; - /** \brief Password associated with the username for accessing the database */ + //! \brief Password associated with the username for accessing the database QString mPassword; - /** \brief QString containing the last reported error message */ + //! \brief QString containing the last reported error message QString mLastError; - /** \brief The database object */ + //! \brief The database object QSqlDatabase mDatabase; - /** \brief Sets the error messages */ + //! \brief Sets the error messages void setLastError( const QString& error ) { mLastError = error; diff --git a/src/plugins/evis/databaseconnection/evisdatabaseconnectiongui.h b/src/plugins/evis/databaseconnection/evisdatabaseconnectiongui.h index c82fd4a4dd2..34512fc93c5 100644 --- a/src/plugins/evis/databaseconnection/evisdatabaseconnectiongui.h +++ b/src/plugins/evis/databaseconnection/evisdatabaseconnectiongui.h @@ -49,27 +49,27 @@ class eVisDatabaseConnectionGui : public QDialog, private Ui::eVisDatabaseConnec Q_OBJECT public: - /** \brief Constructor */ + //! \brief Constructor eVisDatabaseConnectionGui( QList*, QWidget* parent = nullptr, Qt::WindowFlags fl = 0 ); - /** \brief Destructor */ + //! \brief Destructor ~eVisDatabaseConnectionGui(); private: - /** \brief Pointer to a database connection */ + //! \brief Pointer to a database connection eVisDatabaseConnection* mDatabaseConnection; - /** \brief Pointer to a temporary file which will hold the results of our query */ + //! \brief Pointer to a temporary file which will hold the results of our query QList* mTempOutputFileList; - /** \brief Pointer to another GUI component that will select which fields contain x, y coordinates */ + //! \brief Pointer to another GUI component that will select which fields contain x, y coordinates eVisDatabaseLayerFieldSelectionGui* mDatabaseLayerFieldSelector; - /** \brief Pointer to a QMap which will hold the definition of preexisting query that can be loaded from an xml file */ + //! \brief Pointer to a QMap which will hold the definition of preexisting query that can be loaded from an xml file QMap* mQueryDefinitionMap; private slots: - /** \brief Slot called after the user selects the x, y fields in the field selection gui component */ + //! \brief Slot called after the user selects the x, y fields in the field selection gui component void drawNewVectorLayer( const QString&, const QString&, const QString& ); void on_buttonBox_accepted(); @@ -83,7 +83,7 @@ class eVisDatabaseConnectionGui : public QDialog, private Ui::eVisDatabaseConnec void on_pbtnRunQuery_clicked(); signals: - /** \brief signal emitted by the drawNewVectorLayer slot */ + //! \brief signal emitted by the drawNewVectorLayer slot void drawVectorLayer( const QString&, const QString&, const QString& ); }; diff --git a/src/plugins/evis/databaseconnection/evisdatabaselayerfieldselectiongui.h b/src/plugins/evis/databaseconnection/evisdatabaselayerfieldselectiongui.h index d3edc44a546..2f59955ca23 100644 --- a/src/plugins/evis/databaseconnection/evisdatabaselayerfieldselectiongui.h +++ b/src/plugins/evis/databaseconnection/evisdatabaselayerfieldselectiongui.h @@ -41,10 +41,10 @@ class eVisDatabaseLayerFieldSelectionGui : public QDialog, private Ui::eVisDatab Q_OBJECT public: - /** \brief Constructor */ + //! \brief Constructor eVisDatabaseLayerFieldSelectionGui( QWidget* parent, Qt::WindowFlags fl ); - /** \brief Public method that sets the contents of the combo boxes with the available field names */ + //! \brief Public method that sets the contents of the combo boxes with the available field names void setFieldList( QStringList* ); public slots: @@ -52,7 +52,7 @@ class eVisDatabaseLayerFieldSelectionGui : public QDialog, private Ui::eVisDatab void on_buttonBox_rejected(); signals: - /** \brief Signal emitted when the user has entered the layername, selected the field names, and pressed the accept button */ + //! \brief Signal emitted when the user has entered the layername, selected the field names, and pressed the accept button void eVisDatabaseLayerFieldsSelected( const QString&, const QString&, const QString& ); }; #endif diff --git a/src/plugins/evis/databaseconnection/evisquerydefinition.h b/src/plugins/evis/databaseconnection/evisquerydefinition.h index 6b13cd1f5a7..35fc2fae7ce 100644 --- a/src/plugins/evis/databaseconnection/evisquerydefinition.h +++ b/src/plugins/evis/databaseconnection/evisquerydefinition.h @@ -42,67 +42,67 @@ class eVisQueryDefinition { public: - /** \brief Constructor */ + //! \brief Constructor eVisQueryDefinition(); - /** \brief Accessor for query description */ + //! \brief Accessor for query description QString description() { return mDescription; } - /** \brief Accessor for query short description */ + //! \brief Accessor for query short description QString shortDescription() { return mShortDescription; } - /** \brief Accessor for database type */ + //! \brief Accessor for database type QString databaseType() { return mDatabaseType; } - /** \brief Accessor for database host name */ + //! \brief Accessor for database host name QString databaseHost() { return mDatabaseHost; } - /** \brief Accessor for database port */ + //! \brief Accessor for database port int databasePort() { return mDatabasePort; } - /** \brief Accessor for database name */ + //! \brief Accessor for database name QString databaseName() { return mDatabaseName; } - /** \brief Accessor for database username */ + //! \brief Accessor for database username QString databaseUsername() { return mDatabaseUsername; } - /** \brief Accessor for database password */ + //! \brief Accessor for database password QString databasePassword() { return mDatabasePassword; } - /** \brief Accessor for SQL statement */ + //! \brief Accessor for SQL statement QString sqlStatement() { return mSqlStatement; } - /** \brief Accessor for auto connection flag */ + //! \brief Accessor for auto connection flag bool autoConnect() { return mAutoConnect; } - /** \brief Mutator for query description */ + //! \brief Mutator for query description void setDescription( const QString& description ) { mDescription = description; } - /** \brief Mutator for query short description */ + //! \brief Mutator for query short description void setShortDescription( const QString& description ) { mShortDescription = description; } - /** \brief Mutator for database type */ + //! \brief Mutator for database type void setDatabaseType( const QString& type ) { mDatabaseType = type; } - /** \brief Mutator for database host name */ + //! \brief Mutator for database host name void setDatabaseHost( const QString& host ) { mDatabaseHost = host; } - /** \brief Mutator for database port */ + //! \brief Mutator for database port void setDatabasePort( int port ) { mDatabasePort = port; } - /** \brief Mutator for database name */ + //! \brief Mutator for database name void setDatabaseName( const QString& name ) { mDatabaseName = name; } - /** \brief Mutator for database username */ + //! \brief Mutator for database username void setDatabaseUsername( const QString& username ) { mDatabaseUsername = username; } - /** \brief Mutator for database password */ + //! \brief Mutator for database password void setDatabasePassword( const QString& password ) { mDatabasePassword = password; } - /** \brief Mutator for SQL statement */ + //! \brief Mutator for SQL statement void setSqlStatement( const QString& statement ) { mSqlStatement = statement; } - /** \brief Mutator for auto connection flag */ + //! \brief Mutator for auto connection flag void setAutoConnect( const QString& autoconnect ) { if ( autoconnect.startsWith( QLatin1String( "true" ), Qt::CaseInsensitive ) ) @@ -117,34 +117,34 @@ class eVisQueryDefinition private: - /** \brief Detailed description for the query */ + //! \brief Detailed description for the query QString mDescription; - /** \brief Short description for the query */ + //! \brief Short description for the query QString mShortDescription; - /** \brief The database type to which a connection should be made */ + //! \brief The database type to which a connection should be made QString mDatabaseType; - /** \brief The database host to which a connection should be made */ + //! \brief The database host to which a connection should be made QString mDatabaseHost; - /** \brief The port/socket on the database host to which a connection should be made */ + //! \brief The port/socket on the database host to which a connection should be made int mDatabasePort; - /** \brief The name, or filename, of the database to which a connection should be made */ + //! \brief The name, or filename, of the database to which a connection should be made QString mDatabaseName; - /** \brief Username for the database, if required */ + //! \brief Username for the database, if required QString mDatabaseUsername; - /** \brief Password for the username, if require */ + //! \brief Password for the username, if require QString mDatabasePassword; - /** \brief The SQL statement to execute upon successful connection to a database */ + //! \brief The SQL statement to execute upon successful connection to a database QString mSqlStatement; - /** \brief Boolean to allow for automated connection to the database when query definition is successfully loaded */ + //! \brief Boolean to allow for automated connection to the database when query definition is successfully loaded bool mAutoConnect; }; #endif diff --git a/src/plugins/evis/eventbrowser/evisgenericeventbrowsergui.h b/src/plugins/evis/eventbrowser/evisgenericeventbrowsergui.h index 432c2032a3f..21403f61351 100644 --- a/src/plugins/evis/eventbrowser/evisgenericeventbrowsergui.h +++ b/src/plugins/evis/eventbrowser/evisgenericeventbrowsergui.h @@ -55,13 +55,13 @@ class eVisGenericEventBrowserGui : public QDialog, private Ui::eVisGenericEventB Q_OBJECT public: - /** \brief Constructor called when button is pressed in the plugin toolbar */ + //! \brief Constructor called when button is pressed in the plugin toolbar eVisGenericEventBrowserGui( QWidget* parent, QgisInterface* interface, Qt::WindowFlags fl ); - /** \brief Constructor called when new browser is requested by the eVisEventIdTool */ + //! \brief Constructor called when new browser is requested by the eVisEventIdTool eVisGenericEventBrowserGui( QWidget* parent, QgsMapCanvas* canvas, Qt::WindowFlags fl ); - /** \Brief Destructor */ + //! \Brief Destructor ~eVisGenericEventBrowserGui(); protected: @@ -69,86 +69,86 @@ class eVisGenericEventBrowserGui : public QDialog, private Ui::eVisGenericEventB private: //Variables - /** \brief A flag to bypass some signal/slots during gui initialization */ + //! \brief A flag to bypass some signal/slots during gui initialization bool mIgnoreEvent; - /** \brief Pointer to the main configurations object */ + //! \brief Pointer to the main configurations object eVisConfiguration mConfiguration; - /** \brief Flag indicating if the browser fully initialized */ + //! \brief Flag indicating if the browser fully initialized bool mBrowserInitialized; - /** \brief Index of the attribute field name that closest 'matches' configuration of the parameter */ + //! \brief Index of the attribute field name that closest 'matches' configuration of the parameter int mDefaultCompassBearingField; - /** \brief Index of the attribute field name that closest 'matches' configuration of the parameter */ + //! \brief Index of the attribute field name that closest 'matches' configuration of the parameter int mDefaultCompassOffsetField; - /** \brief Index of the attribute field name that closest 'matches' configuration of the parameter */ + //! \brief Index of the attribute field name that closest 'matches' configuration of the parameter int mDefaultEventImagePathField; - /** \brief Pointer to the QgisInferface */ + //! \brief Pointer to the QgisInferface QgisInterface* mInterface; - /** \brief Pointer to the map canvas */ + //! \brief Pointer to the map canvas QgsMapCanvas* mCanvas; - /** \brief Pointer to the vector layer */ + //! \brief Pointer to the vector layer QgsVectorLayer* mVectorLayer; - /** \brief Pointer to the vector data provider */ + //! \brief Pointer to the vector data provider QgsVectorDataProvider* mDataProvider; - /** \brief QPixmap holding the default highlighting symbol */ + //! \brief QPixmap holding the default highlighting symbol QPixmap mHighlightSymbol; - /** \brief QPixmap holding the pointer highlighting symbol */ + //! \brief QPixmap holding the pointer highlighting symbol QPixmap mPointerSymbol; - /** \brief Compass bearing value for the current feature */ + //! \brief Compass bearing value for the current feature double mCompassBearing; - /** \brief Compass bearing offset retrieved from attribute */ + //! \brief Compass bearing offset retrieved from attribute double mCompassOffset; - /** \brief QString holding the path to the image for the current feature */ + //! \brief QString holding the path to the image for the current feature QString mEventImagePath; - /** \brief List of current select featured ids*/ + //! \brief List of current select featured ids QList mFeatureIds; - /** \brief Index of selected feature being viewed, used to access mFeatureIds */ + //! \brief Index of selected feature being viewed, used to access mFeatureIds int mCurrentFeatureIndex; - /** \brief Current feature being viewed */ + //! \brief Current feature being viewed QgsFeature mFeature; //Methods - /** \brief Applies parameters on the Options tabs and saves the configuration */ + //! \brief Applies parameters on the Options tabs and saves the configuration void accept() override; - /** \brief Modifies the Event Image Path according to the local and global settings */ + //! \brief Modifies the Event Image Path according to the local and global settings void buildEventImagePath(); - /** \brief Method that loads the image in the browser */ + //! \brief Method that loads the image in the browser void displayImage(); - /** \brief Generic method to get a feature by id. Access mLocalFeatureList when layer is of type delimitedtext otherwise calls existing methods in mDataProvider */ + //! \brief Generic method to get a feature by id. Access mLocalFeatureList when layer is of type delimitedtext otherwise calls existing methods in mDataProvider QgsFeature* featureAtId( QgsFeatureId ); - /** \brief Functionality common to both constructors */ + //! \brief Functionality common to both constructors bool initBrowser(); - /** \brief Set all of the gui objects based on the current configuration*/ + //! \brief Set all of the gui objects based on the current configuration void initOptionsTab(); - /** \brief Method called to load data into the browser */ + //! \brief Method called to load data into the browser void loadRecord(); - /** \brief Reset all gui items on the options tab to a 'system default' */ + //! \brief Reset all gui items on the options tab to a 'system default' void restoreDefaultOptions(); - /** \brief Sets the base path to the path of the data source */ + //! \brief Sets the base path to the path of the data source void setBasePathToDataSource(); private slots: @@ -176,7 +176,7 @@ class eVisGenericEventBrowserGui : public QDialog, private Ui::eVisGenericEventB void on_pbtnResetUseOnlyFilenameData_clicked(); void on_rbtnManualCompassOffset_toggled( bool ); void on_tableFileTypeAssociations_cellDoubleClicked( int, int ); - /** \brief Slot called when the map canvas is done refreshing. Draws the highlighting symbol over the current selected feature */ + //! \brief Slot called when the map canvas is done refreshing. Draws the highlighting symbol over the current selected feature void renderSymbol( QPainter* ); }; #endif diff --git a/src/plugins/evis/eventbrowser/evisimagedisplaywidget.h b/src/plugins/evis/eventbrowser/evisimagedisplaywidget.h index d7f5fab5ee0..512a1ca6ff4 100644 --- a/src/plugins/evis/eventbrowser/evisimagedisplaywidget.h +++ b/src/plugins/evis/eventbrowser/evisimagedisplaywidget.h @@ -52,26 +52,26 @@ class eVisImageDisplayWidget : public QWidget Q_OBJECT public: - /** \brief Constructor */ + //! \brief Constructor eVisImageDisplayWidget( QWidget* parent = nullptr, Qt::WindowFlags fl = 0 ); - /** \brief Destructor */ + //! \brief Destructor ~eVisImageDisplayWidget(); - /** \brief Load an image from disk and display */ + //! \brief Load an image from disk and display void displayImage( const QString& ); - /** \brief Load an image from a remote location using http and display */ + //! \brief Load an image from a remote location using http and display void displayUrlImage( const QString& ); /* * There needs to be more logic around setting the zoom steps as you could change it mid display * and end up getting not being able to zoom in or out */ - /** \brief Accessor for ZOOM_STEPS */ + //! \brief Accessor for ZOOM_STEPS int getZoomSteps() { return ZOOM_STEPS; } - /** \brief Mutator for ZOON_STEPS */ + //! \brief Mutator for ZOON_STEPS void setZoomSteps( int steps ) { ZOOM_STEPS = steps; } protected: @@ -79,64 +79,64 @@ class eVisImageDisplayWidget : public QWidget private: - /** \brief Used to hold the http request to match the correct emits with the correct result */ + //! \brief Used to hold the http request to match the correct emits with the correct result int mCurrentHttpImageRequestId; - /** \brief CUrrent Zoom level */ + //! \brief CUrrent Zoom level int mCurrentZoomStep; - /** \brief widget to display the image in */ + //! \brief widget to display the image in QScrollArea* mDisplayArea; - /** \brief Method that acually display the image in the widget */ + //! \brief Method that acually display the image in the widget void displayImage(); - /** \brief Pointer to the http buffer */ + //! \brief Pointer to the http buffer QBuffer* mHttpBuffer; // TODO: Update to QNetworkAccessManager #if QT_VERSION < 0x050000 - /** \brief Pointer to the http connection if needed */ + //! \brief Pointer to the http connection if needed QHttp* mHttpConnection; #endif - /** \brief This is a point to the actual image being displayed */ + //! \brief This is a point to the actual image being displayed QPixmap* mImage; - /** \brief Label to hold the image */ + //! \brief Label to hold the image QLabel* mImageLabel; - /** \brief Flag to indicate the success of the last load request */ + //! \brief Flag to indicate the success of the last load request bool mImageLoaded; - /** \brief Ratio if height to width or width to height for the original image, which ever is smaller */ + //! \brief Ratio if height to width or width to height for the original image, which ever is smaller double mImageSizeRatio; - /** \brief Boolean to indicate which feature the mImageSizeRation corresponds to */ + //! \brief Boolean to indicate which feature the mImageSizeRation corresponds to bool mScaleByHeight; - /** \brief Boolean to indicate which feature the mImageSizeRation corresponds to */ + //! \brief Boolean to indicate which feature the mImageSizeRation corresponds to bool mScaleByWidth; - /** \brief The increment by which the image is scaled during each scaling event */ + //! \brief The increment by which the image is scaled during each scaling event double mScaleFactor; - /** \brief The single factor by which the original image needs to be scaled to fit into current display area */ + //! \brief The single factor by which the original image needs to be scaled to fit into current display area double mScaleToFit; - /** \brief Zoom in button */ + //! \brief Zoom in button QPushButton* pbtnZoomIn; - /** \brief Zoom out button */ + //! \brief Zoom out button QPushButton* pbtnZoomOut; - /** \brief Zoom to full extent button */ + //! \brief Zoom to full extent button QPushButton* pbtnZoomFull; - /** \brief Method called to compute the various scaling parameters */ + //! \brief Method called to compute the various scaling parameters void setScalers(); - /** \brief The number of steps between the scale to fit image and full resolution */ + //! \brief The number of steps between the scale to fit image and full resolution int ZOOM_STEPS; private slots: @@ -146,7 +146,7 @@ class eVisImageDisplayWidget : public QWidget void on_pbtnZoomFull_clicked(); - /** \brief Slot called when the http request is completed */ + //! \brief Slot called when the http request is completed void displayUrlImage( int, bool ); }; #endif diff --git a/src/plugins/evis/idtool/eviseventidtool.h b/src/plugins/evis/idtool/eviseventidtool.h index b13e9b8a9f2..e050cb5adc9 100644 --- a/src/plugins/evis/idtool/eviseventidtool.h +++ b/src/plugins/evis/idtool/eviseventidtool.h @@ -48,18 +48,18 @@ class eVisEventIdTool : public QgsMapTool Q_OBJECT public: - /** \brief Constructor */ + //! \brief Constructor explicit eVisEventIdTool( QgsMapCanvas* ); - /** \brief Method to handle mouse release, i.e., select, event */ + //! \brief Method to handle mouse release, i.e., select, event void canvasReleaseEvent( QgsMapMouseEvent* ) override; private: - /** \brief Pointer to a generic event browser */ + //! \brief Pointer to a generic event browser eVisGenericEventBrowserGui* mBrowser; - /** \brief Selection routine called by the mouse release event */ + //! \brief Selection routine called by the mouse release event void select( const QgsPoint& ); }; #endif diff --git a/src/plugins/geometry_checker/ui/qgsgeometrycheckerresulttab.cpp b/src/plugins/geometry_checker/ui/qgsgeometrycheckerresulttab.cpp index c1b1b3ad661..8c35860ded3 100644 --- a/src/plugins/geometry_checker/ui/qgsgeometrycheckerresulttab.cpp +++ b/src/plugins/geometry_checker/ui/qgsgeometrycheckerresulttab.cpp @@ -448,7 +448,7 @@ void QgsGeometryCheckerResultTab::openAttributeTable() void QgsGeometryCheckerResultTab::fixErrors( bool prompt ) { - /** Collect errors to fix **/ + //! Collect errors to fix * QModelIndexList rows = ui.tableWidgetErrors->selectionModel()->selectedRows(); if ( rows.isEmpty() ) { @@ -473,13 +473,13 @@ void QgsGeometryCheckerResultTab::fixErrors( bool prompt ) return; } - /** Reset statistics, clear rubberbands **/ + //! Reset statistics, clear rubberbands * mStatistics = QgsGeometryCheckerFixSummaryDialog::Statistics(); qDeleteAll( mCurrentRubberBands ); mCurrentRubberBands.clear(); - /** Fix errors **/ + //! Fix errors * mCloseable = false; if ( prompt ) { diff --git a/src/plugins/geometry_checker/ui/qgsgeometrycheckersetuptab.cpp b/src/plugins/geometry_checker/ui/qgsgeometrycheckersetuptab.cpp index fbcab8b1a2c..5413176dc42 100644 --- a/src/plugins/geometry_checker/ui/qgsgeometrycheckersetuptab.cpp +++ b/src/plugins/geometry_checker/ui/qgsgeometrycheckersetuptab.cpp @@ -169,7 +169,7 @@ void QgsGeometryCheckerSetupTab::selectOutputFile() void QgsGeometryCheckerSetupTab::runChecks() { - /** Get selected layer **/ + //! Get selected layer * QgsVectorLayer* layer = getSelectedLayer(); if ( !layer ) return; @@ -188,14 +188,14 @@ void QgsGeometryCheckerSetupTab::runChecks() } bool selectedOnly = ui.checkBoxInputSelectedOnly->isChecked(); - /** Set window busy **/ + //! Set window busy * setCursor( Qt::WaitCursor ); mRunButton->setEnabled( false ); ui.labelStatus->setText( tr( "Preparing output..." ) ); ui.labelStatus->show(); QApplication::processEvents( QEventLoop::ExcludeUserInputEvents ); - /** Duplicate if necessary **/ + //! Duplicate if necessary * if ( ui.radioButtonOutputNew->isChecked() ) { // Write selected feature ids to new layer @@ -272,7 +272,7 @@ void QgsGeometryCheckerSetupTab::runChecks() } } - /** Setup checker **/ + //! Setup checker * ui.labelStatus->setText( tr( "Building spatial index..." ) ); QApplication::processEvents( QEventLoop::ExcludeUserInputEvents ); QgsFeaturePool* featurePool = new QgsFeaturePool( layer, selectedOnly ); @@ -292,14 +292,14 @@ void QgsGeometryCheckerSetupTab::runChecks() emit checkerStarted( checker, featurePool ); - /** Add result layer (do this after checkerStarted, otherwise warning about removing of result layer may appear) **/ + //! Add result layer (do this after checkerStarted, otherwise warning about removing of result layer may appear) * layer->setReadOnly( true ); if ( ui.radioButtonOutputNew->isChecked() ) { QgsMapLayerRegistry::instance()->addMapLayers( QList() << layer ); } - /** Run **/ + //! Run * ui.buttonBox->addButton( mAbortButton, QDialogButtonBox::ActionRole ); mRunButton->hide(); ui.progressBar->setRange( 0, 0 ); @@ -318,7 +318,7 @@ void QgsGeometryCheckerSetupTab::runChecks() ui.progressBar->setRange( 0, maxSteps ); evLoop.exec(); - /** Restore window **/ + //! Restore window * unsetCursor(); mAbortButton->setEnabled( true ); ui.buttonBox->removeButton( mAbortButton ); @@ -328,7 +328,7 @@ void QgsGeometryCheckerSetupTab::runChecks() ui.labelStatus->hide(); ui.widgetInputs->setEnabled( true ); - /** Show result **/ + //! Show result * emit checkerFinished( !futureWatcher.isCanceled() ); } diff --git a/src/plugins/geometry_snapper/qgsgeometrysnapperdialog.cpp b/src/plugins/geometry_snapper/qgsgeometrysnapperdialog.cpp index f9a364e21e1..18b5ebad12a 100644 --- a/src/plugins/geometry_snapper/qgsgeometrysnapperdialog.cpp +++ b/src/plugins/geometry_snapper/qgsgeometrysnapperdialog.cpp @@ -183,7 +183,7 @@ void QgsGeometrySnapperDialog::selectOutputFile() void QgsGeometrySnapperDialog::run() { - /** Get layers **/ + //! Get layers * QgsVectorLayer* layer = getInputLayer(); QgsVectorLayer* referenceLayer = getReferenceLayer(); if ( !layer || !referenceLayer ) @@ -201,7 +201,7 @@ void QgsGeometrySnapperDialog::run() bool selectedOnly = checkBoxInputSelectedOnly->isChecked(); - /** Duplicate if necessary **/ + //! Duplicate if necessary * if ( radioButtonOutputNew->isChecked() ) { QString filename = lineEditOutput->text(); @@ -278,7 +278,7 @@ void QgsGeometrySnapperDialog::run() QgsMapLayerRegistry::instance()->addMapLayers( QList() << layer ); } - /** Run **/ + //! Run * QEventLoop evLoop; QFutureWatcher futureWatcher; connect( &futureWatcher, SIGNAL( finished() ), &evLoop, SLOT( quit() ) ); @@ -298,7 +298,7 @@ void QgsGeometrySnapperDialog::run() futureWatcher.setFuture( snapper.processFeatures() ); evLoop.exec(); - /** Restore window **/ + //! Restore window * unsetCursor(); buttonBox->button( QDialogButtonBox::Abort )->hide(); mRunButton->show(); @@ -307,10 +307,10 @@ void QgsGeometrySnapperDialog::run() layer->setReadOnly( false ); - /** Trigger layer repaint **/ + //! Trigger layer repaint * layer->triggerRepaint(); - /** Show errors **/ + //! Show errors * if ( !snapper.getErrors().isEmpty() ) { QMessageBox::warning( this, tr( "Errors occurred" ), tr( "

The following errors occurred:

  • %1
" ).arg( snapper.getErrors().join( QStringLiteral( "
  • " ) ) ) ); diff --git a/src/plugins/georeferencer/qgsgcpcanvasitem.h b/src/plugins/georeferencer/qgsgcpcanvasitem.h index 41cedef8402..b7e92462117 100644 --- a/src/plugins/georeferencer/qgsgcpcanvasitem.h +++ b/src/plugins/georeferencer/qgsgcpcanvasitem.h @@ -36,7 +36,7 @@ class QgsGCPCanvasItem : public QgsMapCanvasItem void updatePosition() override; - /** Calls prepareGeometryChange()*/ + //! Calls prepareGeometryChange() void checkBoundingRectChange(); private: @@ -52,9 +52,9 @@ class QgsGCPCanvasItem : public QgsMapCanvasItem QRectF mTextBoxRect; void drawResidualArrow( QPainter* p, const QgsRenderContext& context ); - /** Calculates scale factor for residual display*/ + //! Calculates scale factor for residual display double residualToScreenFactor() const; - /** Calculates pixel size for a font point size*/ + //! Calculates pixel size for a font point size double fontSizePainterUnits( double points, const QgsRenderContext& c ); }; diff --git a/src/plugins/georeferencer/qgsgeorefdescriptiondialog.h b/src/plugins/georeferencer/qgsgeorefdescriptiondialog.h index 8d5d0166233..066ae1a4492 100644 --- a/src/plugins/georeferencer/qgsgeorefdescriptiondialog.h +++ b/src/plugins/georeferencer/qgsgeorefdescriptiondialog.h @@ -21,7 +21,7 @@ #include "ui_qgsgeorefdescriptiondialogbase.h" #include -/** Dialog that shows logo and description of the georef plugin*/ +//! Dialog that shows logo and description of the georef plugin class QgsGeorefDescriptionDialog: public QDialog, private Ui::QgsGeorefDescriptionDialogBase { Q_OBJECT diff --git a/src/plugins/georeferencer/qgsgeorefplugingui.h b/src/plugins/georeferencer/qgsgeorefplugingui.h index 5a67bb68f2f..a90adf79b1a 100644 --- a/src/plugins/georeferencer/qgsgeorefplugingui.h +++ b/src/plugins/georeferencer/qgsgeorefplugingui.h @@ -197,7 +197,7 @@ class QgsGeorefPluginGui : public QMainWindow, private Ui::QgsGeorefPluginGuiBas */ bool calculateMeanError( double& error ) const; - /** Docks / undocks this window*/ + //! Docks / undocks this window void dockThisWindow( bool dock ); QGridLayout* mCentralLayout; diff --git a/src/plugins/georeferencer/qgsgeoreftoolmovepoint.h b/src/plugins/georeferencer/qgsgeoreftoolmovepoint.h index 3c3565f7906..992745eb73e 100644 --- a/src/plugins/georeferencer/qgsgeoreftoolmovepoint.h +++ b/src/plugins/georeferencer/qgsgeoreftoolmovepoint.h @@ -41,10 +41,10 @@ class QgsGeorefToolMovePoint : public QgsMapTool void pointReleased( QPoint p ); private: - /** Start point of the move in map coordinates*/ + //! Start point of the move in map coordinates QPoint mStartPointMapCoords; - /** Rubberband that shows the feature being moved*/ + //! Rubberband that shows the feature being moved QRubberBand *mRubberBand; }; diff --git a/src/plugins/georeferencer/qgsgeoreftransform.h b/src/plugins/georeferencer/qgsgeoreftransform.h index f99da9fd6c5..046edbc8989 100644 --- a/src/plugins/georeferencer/qgsgeoreftransform.h +++ b/src/plugins/georeferencer/qgsgeoreftransform.h @@ -98,7 +98,7 @@ class QgsGeorefTransform : public QgsGeorefTransformInterface //! \brief The transform parametrisation currently in use. TransformParametrisation transformParametrisation() const; - /** True for linear, Helmert, first order polynomial*/ + //! True for linear, Helmert, first order polynomial bool providesAccurateInverseTransformation() const; //! \returns whether the parameters of this transform have been initialized by \ref updateParametersFromGCPs diff --git a/src/plugins/georeferencer/qgsresidualplotitem.h b/src/plugins/georeferencer/qgsresidualplotitem.h index 74f6dae6c6a..2d0a05030e3 100644 --- a/src/plugins/georeferencer/qgsresidualplotitem.h +++ b/src/plugins/georeferencer/qgsresidualplotitem.h @@ -30,7 +30,7 @@ class QgsResidualPlotItem: public QgsComposerItem explicit QgsResidualPlotItem( QgsComposition* c ); ~QgsResidualPlotItem(); - /** \brief Reimplementation of QCanvasItem::paint*/ + //! \brief Reimplementation of QCanvasItem::paint virtual void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override; void setGCPList( const QgsGCPList& list ) { mGCPList = list; } @@ -50,13 +50,13 @@ class QgsResidualPlotItem: public QgsComposerItem QgsGCPList mGCPList; QgsRectangle mExtent; - /** True if the scale bar units should be converted to map units. This can be done for transformation where the scaling in all directions is the same (helmert)*/ + //! True if the scale bar units should be converted to map units. This can be done for transformation where the scaling in all directions is the same (helmert) bool mConvertScaleToMapUnits; - /** Calculates maximal possible mm to pixel ratio such that the residual arrow is still inside the frame*/ + //! Calculates maximal possible mm to pixel ratio such that the residual arrow is still inside the frame double maxMMToPixelRatioForGCP( const QgsGeorefDataPoint* p, double pixelXMM, double pixelYMM ); - /** Returns distance between two points*/ + //! Returns distance between two points double dist( QPointF p1, QPointF p2 ) const; }; diff --git a/src/plugins/grass/qgsgrassmapcalc.h b/src/plugins/grass/qgsgrassmapcalc.h index 898b3a2431f..0cbaaf29f34 100644 --- a/src/plugins/grass/qgsgrassmapcalc.h +++ b/src/plugins/grass/qgsgrassmapcalc.h @@ -70,32 +70,32 @@ class QgsGrassMapcalc: public QMainWindow, private Ui::QgsGrassMapcalcBase, bool hasOutput( int type ) override { Q_UNUSED( type ); return true; } - /** \brief receives contentsMousePressEvent from view */ + //! \brief receives contentsMousePressEvent from view void mousePressEvent( QMouseEvent* ) override; - /** \brief receives contentsMouseReleaseEvent from view */ + //! \brief receives contentsMouseReleaseEvent from view void mouseReleaseEvent( QMouseEvent* ) override; - /** \brief receives contentsMouseMoveEvent from view */ + //! \brief receives contentsMouseMoveEvent from view void mouseMoveEvent( QMouseEvent* ) override; void keyPressEvent( QKeyEvent * e ) override; - /** Cut coordinates by current canvas extent */ + //! Cut coordinates by current canvas extent void limit( QPoint* ); - /** Grow canvas and move items */ + //! Grow canvas and move items void growCanvas( int left, int right, int top, int bottom ); - /** Grow automaticaly if an item is near border */ + //! Grow automaticaly if an item is near border void autoGrow(); void resizeCanvas( int width, int height ); - /** Show/hide options for tool */ + //! Show/hide options for tool void showOptions( int tool ); - /** Set option for selected object */ + //! Set option for selected object void setOption( void ); public slots: diff --git a/src/plugins/grass/qgsgrassmoduleinput.h b/src/plugins/grass/qgsgrassmoduleinput.h index d5989a062ef..999e09b7457 100644 --- a/src/plugins/grass/qgsgrassmoduleinput.h +++ b/src/plugins/grass/qgsgrassmoduleinput.h @@ -64,14 +64,14 @@ class QgsGrassModuleInputModel : public QStandardItemModel explicit QgsGrassModuleInputModel( QObject *parent = 0 ); ~QgsGrassModuleInputModel(); - /** Get singleton instance of this class. */ + //! Get singleton instance of this class. static QgsGrassModuleInputModel* instance(); QVariant data( const QModelIndex & index, int role = Qt::DisplayRole ) const override; public slots: - /** Reload current mapset */ + //! Reload current mapset void reload(); void onMapsetChanged(); diff --git a/src/plugins/grass/qgsgrassregion.cpp b/src/plugins/grass/qgsgrassregion.cpp index 6af9b218fde..3856e4e8965 100644 --- a/src/plugins/grass/qgsgrassregion.cpp +++ b/src/plugins/grass/qgsgrassregion.cpp @@ -33,7 +33,7 @@ #include -/** Map tool which uses rubber band for changing grass region */ +//! Map tool which uses rubber band for changing grass region QgsGrassRegionEdit::QgsGrassRegionEdit( QgsMapCanvas* canvas ) : QgsMapTool( canvas ) { @@ -129,7 +129,7 @@ void QgsGrassRegionEdit::setTransform() void QgsGrassRegionEdit::transform( QgsMapCanvas *canvas, QVector &points, const QgsCoordinateTransform& coordinateTransform, QgsCoordinateTransform::TransformDirection direction ) { - /** Coordinate transform */ + //! Coordinate transform if ( canvas->hasCrsTransformEnabled() ) { //QgsDebugMsg ( "srcCrs = " + coordinateTransform->sourceCrs().toWkt() ); diff --git a/src/plugins/grass/qgsgrassregion.h b/src/plugins/grass/qgsgrassregion.h index 22121c94a63..362fc7f6b65 100644 --- a/src/plugins/grass/qgsgrassregion.h +++ b/src/plugins/grass/qgsgrassregion.h @@ -127,7 +127,7 @@ class QgsGrassRegion: public QWidget, private Ui::QgsGrassRegionBase QgsGrassRegionEdit* mRegionEdit; }; -/** Map tool which uses rubber band for changing grass region */ +//! Map tool which uses rubber band for changing grass region class QgsGrassRegionEdit : public QgsMapTool { Q_OBJECT diff --git a/src/plugins/heatmap/heatmapgui.h b/src/plugins/heatmap/heatmapgui.h index ea125fa01af..f87ce3e96c7 100644 --- a/src/plugins/heatmap/heatmapgui.h +++ b/src/plugins/heatmap/heatmapgui.h @@ -37,58 +37,58 @@ class HeatmapGui : public QDialog, private Ui::HeatmapGuiBase MapUnits }; - /** Returns whether to apply weighted heat */ + //! Returns whether to apply weighted heat bool weighted() const; - /** Returns whether the radius is static or based on a field */ + //! Returns whether the radius is static or based on a field bool variableRadius() const; - /** Returns the fixed radius value */ + //! Returns the fixed radius value double radius() const; - /** Return the radius unit (layer/map units) */ + //! Return the radius unit (layer/map units) int radiusUnit() const; - /** Return the selected kernel shape */ + //! Return the selected kernel shape Heatmap::KernelShape kernelShape() const; - /** Return the selected output values setting */ + //! Return the selected output values setting Heatmap::OutputValues outputValues() const; - /** Return the decay ratio */ + //! Return the decay ratio double decayRatio() const; - /** Return the attribute field for variable radius */ + //! Return the attribute field for variable radius int radiusField() const; - /** Returns the attrinute field for weighted heat */ + //! Returns the attrinute field for weighted heat int weightField() const; - /** Returns state of the add to canvas checkbox*/ + //! Returns state of the add to canvas checkbox bool addToCanvas() const; - /** Returns the output filename/path */ + //! Returns the output filename/path QString outputFilename() const; - /** Returns the GDAL Format for output raster */ + //! Returns the GDAL Format for output raster QString outputFormat() const; - /** Returns the input Vector layer */ + //! Returns the input Vector layer QgsVectorLayer* inputVectorLayer() const; - /** Returns the no of rows for the raster */ + //! Returns the no of rows for the raster int rows() const { return mRows; } - /** Returns the no of columns in the raster */ + //! Returns the no of columns in the raster int columns() const { return mColumns; } - /** Returns the cell size X value */ + //! Returns the cell size X value double cellSizeX() const { return mXcellsize; } - /** Returns the cell size Y valuue */ + //! Returns the cell size Y valuue double cellSizeY() const { return mYcellsize; } - /** Return the BBox */ + //! Return the BBox QgsRectangle bbox() const { return mBBox; } private: @@ -101,28 +101,28 @@ class HeatmapGui : public QDialog, private Ui::HeatmapGuiBase double mXcellsize, mYcellsize; int mRows, mColumns; - /** Restores control values */ + //! Restores control values void restoreSettings( bool usingLastInputLayer ); - /** Saves control values */ + //! Saves control values void saveSettings(); - /** Blocks/unblocks signals for controls */ + //! Blocks/unblocks signals for controls void blockAllSignals( bool b ); - /** Function to check wether all constrains are satisfied and enable the OK button */ + //! Function to check wether all constrains are satisfied and enable the OK button void enableOrDisableOkButton(); - /** Set the mBBox value - mainly used for updation purpose */ + //! Set the mBBox value - mainly used for updation purpose void updateBBox(); - /** Update the LineEdits cellsize and row&col values */ + //! Update the LineEdits cellsize and row&col values void updateSize(); - /** Convert layer distance value to the corresponding map units based on layer projection */ + //! Convert layer distance value to the corresponding map units based on layer projection double mapUnitsOf( double dist, const QgsCoordinateReferenceSystem& layerCrs ) const; - /** Estimate a reasonable starting value for the radius field */ + //! Estimate a reasonable starting value for the radius field double estimateRadius(); inline double max( double a, double b ) diff --git a/src/plugins/interpolation/qgsidwinterpolatordialog.h b/src/plugins/interpolation/qgsidwinterpolatordialog.h index 6e59c3cf4fc..6866bac1912 100644 --- a/src/plugins/interpolation/qgsidwinterpolatordialog.h +++ b/src/plugins/interpolation/qgsidwinterpolatordialog.h @@ -21,7 +21,7 @@ #include "ui_qgsidwinterpolatordialogbase.h" #include "qgsinterpolatordialog.h" -/** A class that takes the input parameter for inverse distance weighting*/ +//! A class that takes the input parameter for inverse distance weighting class QgsIDWInterpolatorDialog: public QgsInterpolatorDialog, private Ui::QgsIDWInterpolatorDialogBase { Q_OBJECT diff --git a/src/plugins/interpolation/qgsinterpolationdialog.h b/src/plugins/interpolation/qgsinterpolationdialog.h index 126f5ad18a9..2625da4c309 100644 --- a/src/plugins/interpolation/qgsinterpolationdialog.h +++ b/src/plugins/interpolation/qgsinterpolationdialog.h @@ -56,22 +56,22 @@ class QgsInterpolationDialog: public QDialog, private Ui::QgsInterpolationDialog private: QgisInterface* mIface; - /** Dialog to get input for the current interpolation method*/ + //! Dialog to get input for the current interpolation method QgsInterpolatorDialog* mInterpolatorDialog; /** Returns the vector layer object with the given name Returns a pointer to the vector layer or 0 in case of error.*/ QgsVectorLayer* vectorLayerFromName( const QString& name ); - /** Enables or disables the Ok button depending on the availability of input layers and the output file*/ + //! Enables or disables the Ok button depending on the availability of input layers and the output file void enableOrDisableOkButton(); /** Get the current output bounding box (might be different to the compound layers bounding box because of user edits) @return the bounding box or an empty bounding box in case of error*/ QgsRectangle currentBoundingBox(); - /** Returns the compound bounding box of the inserted layers*/ + //! Returns the compound bounding box of the inserted layers QgsRectangle boundingBoxOfLayers(); - /** Inserts the compound bounding box of the input layers into the line edits for the output bounding box*/ + //! Inserts the compound bounding box of the input layers into the line edits for the output bounding box void setLayersBoundingBox(); - /** Set cellsizes according to nex bounding box and number of columns / rows */ + //! Set cellsizes according to nex bounding box and number of columns / rows void setNewCellsizeOnBoundingBoxChange(); void setNewCellsizeXOnNColumnsChange(); void setNewCellsizeYOnNRowschange(); diff --git a/src/plugins/interpolation/qgsinterpolationplugin.h b/src/plugins/interpolation/qgsinterpolationplugin.h index 4379ecbb0d2..47a1bea8a9c 100644 --- a/src/plugins/interpolation/qgsinterpolationplugin.h +++ b/src/plugins/interpolation/qgsinterpolationplugin.h @@ -33,9 +33,9 @@ class QgsInterpolationPlugin: public QObject, public QgisPlugin public: explicit QgsInterpolationPlugin( QgisInterface* iface ); ~QgsInterpolationPlugin(); - /** Initialize connection to GUI*/ + //! Initialize connection to GUI void initGui() override; - /** Unload the plugin and cleanup the GUI*/ + //! Unload the plugin and cleanup the GUI void unload() override; private slots: diff --git a/src/plugins/interpolation/qgsinterpolatordialog.h b/src/plugins/interpolation/qgsinterpolatordialog.h index b4b8831b63a..ccec979b58b 100644 --- a/src/plugins/interpolation/qgsinterpolatordialog.h +++ b/src/plugins/interpolation/qgsinterpolatordialog.h @@ -25,7 +25,7 @@ class QgsVectorLayer; class QgisInterface; -/** Abstract base class for dialogs that allow entering the options for interpolators*/ +//! Abstract base class for dialogs that allow entering the options for interpolators class QgsInterpolatorDialog: public QDialog { Q_OBJECT @@ -41,10 +41,10 @@ class QgsInterpolatorDialog: public QDialog void setInputData( const QList< QgsInterpolator::LayerData >& inputData ); protected: - /** Pointer to the running QGIS instance. This may be necessary to show interpolator properties on the map (e.g. triangulation)*/ + //! Pointer to the running QGIS instance. This may be necessary to show interpolator properties on the map (e.g. triangulation) QgisInterface* mInterface; - /** A list of input data layers, their interpolation attribute and their type (point, structure lines, breaklines)*/ + //! A list of input data layers, their interpolation attribute and their type (point, structure lines, breaklines) QList< QgsInterpolator::LayerData > mInputData; }; diff --git a/src/plugins/offline_editing/offline_editing_plugin_gui.h b/src/plugins/offline_editing/offline_editing_plugin_gui.h index db966d8040a..9698487796b 100644 --- a/src/plugins/offline_editing/offline_editing_plugin_gui.h +++ b/src/plugins/offline_editing/offline_editing_plugin_gui.h @@ -50,7 +50,7 @@ class QgsOfflineEditingPluginGui : public QDialog, private Ui::QgsOfflineEditing bool onlySelected() const; public slots: - /** Change the selection of layers in the list */ + //! Change the selection of layers in the list void selectAll(); void unSelectAll(); diff --git a/src/plugins/raster_terrain_analysis/qgsrasterterrainanalysisdialog.h b/src/plugins/raster_terrain_analysis/qgsrasterterrainanalysisdialog.h index e281c4e6ebd..3f92f369bfc 100644 --- a/src/plugins/raster_terrain_analysis/qgsrasterterrainanalysisdialog.h +++ b/src/plugins/raster_terrain_analysis/qgsrasterterrainanalysisdialog.h @@ -58,7 +58,7 @@ class QgsRasterTerrainAnalysisDialog: public QDialog, private Ui::QgsRasterTerra void on_mButtonBox_accepted(); private: - /** Stores relation between driver name and extension*/ + //! Stores relation between driver name and extension QMap mDriverExtensionMap; }; diff --git a/src/plugins/raster_terrain_analysis/qgsrasterterrainanalysisplugin.h b/src/plugins/raster_terrain_analysis/qgsrasterterrainanalysisplugin.h index cdc42ee81be..8cd34103aee 100644 --- a/src/plugins/raster_terrain_analysis/qgsrasterterrainanalysisplugin.h +++ b/src/plugins/raster_terrain_analysis/qgsrasterterrainanalysisplugin.h @@ -25,7 +25,7 @@ class QgsInterface; class QAction; class QMenu; -/** A plugin for raster based terrain analysis (e.g. slope, aspect, ruggedness)*/ +//! A plugin for raster based terrain analysis (e.g. slope, aspect, ruggedness) class QgsRasterTerrainAnalysisPlugin: public QObject, public QgisPlugin { Q_OBJECT @@ -33,9 +33,9 @@ class QgsRasterTerrainAnalysisPlugin: public QObject, public QgisPlugin explicit QgsRasterTerrainAnalysisPlugin( QgisInterface* iface ); ~QgsRasterTerrainAnalysisPlugin(); - /** Initialize connection to GUI*/ + //! Initialize connection to GUI void initGui() override; - /** Unload the plugin and cleanup the GUI*/ + //! Unload the plugin and cleanup the GUI void unload() override; private slots: diff --git a/src/plugins/zonal_statistics/qgszonalstatisticsdialog.h b/src/plugins/zonal_statistics/qgszonalstatisticsdialog.h index 4a7e5d260e1..d85d80688a2 100644 --- a/src/plugins/zonal_statistics/qgszonalstatisticsdialog.h +++ b/src/plugins/zonal_statistics/qgszonalstatisticsdialog.h @@ -42,11 +42,11 @@ class QgsZonalStatisticsDialog: public QDialog, private Ui::QgsZonalStatisticsDi private: QgsZonalStatisticsDialog(); - /** Fills the available raster and polygon layers into the combo boxes*/ + //! Fills the available raster and polygon layers into the combo boxes void insertAvailableLayers(); - /** Propose a valid prefix for the attributes*/ + //! Propose a valid prefix for the attributes QString proposeAttributePrefix() const; - /** Check if a prefix can be used for the count, sum and mean attribute*/ + //! Check if a prefix can be used for the count, sum and mean attribute bool prefixIsValid( const QString& prefix ) const; QgisInterface* mIface; diff --git a/src/plugins/zonal_statistics/qgszonalstatisticsplugin.h b/src/plugins/zonal_statistics/qgszonalstatisticsplugin.h index fccd58050ce..3dee4bc9a07 100644 --- a/src/plugins/zonal_statistics/qgszonalstatisticsplugin.h +++ b/src/plugins/zonal_statistics/qgszonalstatisticsplugin.h @@ -31,13 +31,13 @@ class QgsZonalStatisticsPlugin: public QObject, public QgisPlugin explicit QgsZonalStatisticsPlugin( QgisInterface* iface ); ~QgsZonalStatisticsPlugin(); - /** Initialize connection to GUI*/ + //! Initialize connection to GUI void initGui() override; - /** Unload the plugin and cleanup the GUI*/ + //! Unload the plugin and cleanup the GUI void unload() override; private slots: - /** Select input file, output file, format and analysis method*/ + //! Select input file, output file, format and analysis method void run(); private: diff --git a/src/providers/db2/qgsdb2newconnection.cpp b/src/providers/db2/qgsdb2newconnection.cpp index acef07d17c2..f9250bf1359 100644 --- a/src/providers/db2/qgsdb2newconnection.cpp +++ b/src/providers/db2/qgsdb2newconnection.cpp @@ -79,7 +79,7 @@ QgsDb2NewConnection::QgsDb2NewConnection( QWidget *parent, const QString& connNa } } -/** Autoconnected SLOTS **/ +//! Autoconnected SLOTS * void QgsDb2NewConnection::accept() { QSettings settings; @@ -147,7 +147,7 @@ void QgsDb2NewConnection::on_cb_trustedConnection_clicked() } -/** End Autoconnected SLOTS **/ +//! End Autoconnected SLOTS * QgsDb2NewConnection::~QgsDb2NewConnection() { diff --git a/src/providers/db2/qgsdb2provider.h b/src/providers/db2/qgsdb2provider.h index 12b89af8b9a..ad08ee661a9 100644 --- a/src/providers/db2/qgsdb2provider.h +++ b/src/providers/db2/qgsdb2provider.h @@ -108,19 +108,19 @@ class QgsDb2Provider : public QgsVectorDataProvider */ virtual QgsVectorDataProvider::Capabilities capabilities() const override; - /** Writes a list of features to the database*/ + //! Writes a list of features to the database virtual bool addFeatures( QgsFeatureList & flist ) override; - /** Deletes a feature*/ + //! Deletes a feature virtual bool deleteFeatures( const QgsFeatureIds & id ) override; - /** Changes attribute values of existing features */ + //! Changes attribute values of existing features virtual bool changeAttributeValues( const QgsChangedAttributesMap &attr_map ) override; - /** Changes existing geometries*/ + //! Changes existing geometries virtual bool changeGeometryValues( const QgsGeometryMap &geometry_map ) override; - /** Import a vector layer into the database */ + //! Import a vector layer into the database static QgsVectorLayerImport::ImportError createEmptyLayer( const QString& uri, const QgsFields &fields, @@ -132,14 +132,14 @@ class QgsDb2Provider : public QgsVectorDataProvider const QMap *options = nullptr ); - /** Convert a QgsField to work with DB2 */ + //! Convert a QgsField to work with DB2 static bool convertField( QgsField &field ); - /** Convert a QgsField to work with DB2 */ + //! Convert a QgsField to work with DB2 static QString qgsFieldToDb2Field( const QgsField &field ); protected: - /** Loads fields from input file to member attributeFields */ + //! Loads fields from input file to member attributeFields QVariant::Type decodeSqlType( int typeId ); void loadMetadata(); void loadFields(); diff --git a/src/providers/db2/qgsdb2sourceselect.cpp b/src/providers/db2/qgsdb2sourceselect.cpp index 0296d376cd0..af5b3877e53 100644 --- a/src/providers/db2/qgsdb2sourceselect.cpp +++ b/src/providers/db2/qgsdb2sourceselect.cpp @@ -41,7 +41,7 @@ #include #include -/** Used to create an editor for when the user tries to change the contents of a cell */ +//! Used to create an editor for when the user tries to change the contents of a cell QWidget *QgsDb2SourceSelectDelegate::createEditor( QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index ) const { Q_UNUSED( option ); @@ -208,7 +208,7 @@ QgsDb2SourceSelect::QgsDb2SourceSelect( QWidget *parent, Qt::WindowFlags fl, boo cbxAllowGeometrylessTables->setDisabled( true ); } -/** Autoconnected SLOTS **/ +//! Autoconnected SLOTS * // Slot for adding a new connection void QgsDb2SourceSelect::on_btnNew_clicked() { @@ -285,7 +285,7 @@ void QgsDb2SourceSelect::on_btnEdit_clicked() delete nc; } -/** End Autoconnected SLOTS **/ +//! End Autoconnected SLOTS * // Remember which database is selected void QgsDb2SourceSelect::on_cmbConnections_activated( int ) diff --git a/src/providers/db2/qgsdb2tablemodel.h b/src/providers/db2/qgsdb2tablemodel.h index 23a8886f3aa..189b3d093b7 100644 --- a/src/providers/db2/qgsdb2tablemodel.h +++ b/src/providers/db2/qgsdb2tablemodel.h @@ -22,7 +22,7 @@ #include #include "qgis.h" -/** Layer Property structure */ +//! Layer Property structure struct QgsDb2LayerProperty { QString type; @@ -50,17 +50,17 @@ class QgsDb2TableModel : public QStandardItemModel QgsDb2TableModel(); ~QgsDb2TableModel(); - /** Adds entry for one database table to the model*/ + //! Adds entry for one database table to the model void addTableEntry( const QgsDb2LayerProperty &property ); - /** Sets an sql statement that belongs to a cell specified by a model index*/ + //! Sets an sql statement that belongs to a cell specified by a model index void setSql( const QModelIndex& index, const QString& sql ); /** Sets one or more geometry types to a row. In case of several types, additional rows are inserted. This is for tables where the type is dectected later by thread*/ void setGeometryTypesForTable( QgsDb2LayerProperty layerProperty ); - /** Returns the number of tables in the model*/ + //! Returns the number of tables in the model int tableCount() const { return mTableCount; } enum columns @@ -85,7 +85,7 @@ class QgsDb2TableModel : public QStandardItemModel static QgsWkbTypes::Type wkbTypeFromDb2( QString dbType, int dim = 2 ); private: - /** Number of tables in the model*/ + //! Number of tables in the model int mTableCount; }; #endif diff --git a/src/providers/delimitedtext/qgsdelimitedtextfile.h b/src/providers/delimitedtext/qgsdelimitedtextfile.h index 670d825726a..26dbe0d5084 100644 --- a/src/providers/delimitedtext/qgsdelimitedtextfile.h +++ b/src/providers/delimitedtext/qgsdelimitedtextfile.h @@ -323,9 +323,9 @@ class QgsDelimitedTextFile : public QObject */ void resetDefinition(); - /** Parse reqular expression delimited fields */ + //! Parse reqular expression delimited fields Status parseRegexp( QString &buffer, QStringList &fields ); - /** Parse quote delimited fields, where quote and escape are different */ + //! Parse quote delimited fields, where quote and escape are different Status parseQuoted( QString &buffer, QStringList &fields ); /** Return the next line from the data file. If skipBlank is true then diff --git a/src/providers/gdal/qgsgdalprovider.h b/src/providers/gdal/qgsgdalprovider.h index 982bf04d19b..3a43b587903 100644 --- a/src/providers/gdal/qgsgdalprovider.h +++ b/src/providers/gdal/qgsgdalprovider.h @@ -67,7 +67,7 @@ class QgsGdalProvider : public QgsRasterDataProvider, QgsGdalProviderBase */ QgsGdalProvider( QString const & uri = QString(), bool update = false ); - /** Create invalid provider with error */ + //! Create invalid provider with error QgsGdalProvider( QString const & uri, QgsError error ); //! Destructor @@ -160,7 +160,7 @@ class QgsGdalProvider : public QgsRasterDataProvider, QgsGdalProviderBase QString generateBandName( int theBandNumber ) const override; - /** Reimplemented from QgsRasterDataProvider to bypass second resampling (more efficient for local file based sources)*/ + //! Reimplemented from QgsRasterDataProvider to bypass second resampling (more efficient for local file based sources) QgsRasterBlock *block( int theBandNo, const QgsRectangle &theExtent, int theWidth, int theHeight, QgsRasterBlockFeedback* feedback = nullptr ) override; void readBlock( int bandNo, int xBlock, int yBlock, void *data ) override; @@ -181,7 +181,7 @@ class QgsGdalProvider : public QgsRasterDataProvider, QgsGdalProviderBase */ QString metadata() override; - /** \brief Returns the sublayers of this layer - Useful for providers that manage their own layers, such as WMS */ + //! \brief Returns the sublayers of this layer - Useful for providers that manage their own layers, such as WMS QStringList subLayers() const override; static QStringList subLayers( GDALDatasetH dataset ); @@ -217,21 +217,21 @@ class QgsGdalProvider : public QgsRasterDataProvider, QgsGdalProviderBase const QStringList & theCreateOptions = QStringList() ) override; QList buildPyramidList( QList overviewList = QList() ) override; - /** \brief Close data set and release related data */ + //! \brief Close data set and release related data void closeDataset(); - /** Emit a signal to notify of the progress event. */ + //! Emit a signal to notify of the progress event. void emitProgress( int theType, double theProgress, const QString &theMessage ); void emitProgressUpdate( int theProgress ); static QMap supportedMimes(); - /** Writes into the provider datasource*/ + //! Writes into the provider datasource bool write( void* data, int band, int width, int height, int xOffset, int yOffset ) override; bool setNoDataValue( int bandNo, double noDataValue ) override; - /** Remove dataset*/ + //! Remove dataset bool remove() override; QString validateCreationOptions( const QStringList& createOptions, const QString& format ) override; @@ -245,7 +245,7 @@ class QgsGdalProvider : public QgsRasterDataProvider, QgsGdalProviderBase // initialize CRS from wkt bool crsFromWkt( const char *wkt ); - /** Do some initialization on the dataset (e.g. handling of south-up datasets)*/ + //! Do some initialization on the dataset (e.g. handling of south-up datasets) void initBaseDataset(); /** @@ -253,7 +253,7 @@ class QgsGdalProvider : public QgsRasterDataProvider, QgsGdalProviderBase */ bool mValid; - /** \brief Whether this raster has overviews / pyramids or not */ + //! \brief Whether this raster has overviews / pyramids or not bool mHasPyramids; /** \brief Gdal data types used to represent data in in QGIS, @@ -276,20 +276,20 @@ class QgsGdalProvider : public QgsRasterDataProvider, QgsGdalProviderBase // List of estimated max values, index 0 for band 1 //mutable QList mMaximum; - /** \brief Pointer to the gdaldataset */ + //! \brief Pointer to the gdaldataset GDALDatasetH mGdalBaseDataset; - /** \brief Pointer to the gdaldataset (possibly warped vrt) */ + //! \brief Pointer to the gdaldataset (possibly warped vrt) GDALDatasetH mGdalDataset; - /** \brief Values for mapping pixel to world coordinates. Contents of this array are the same as the GDAL adfGeoTransform */ + //! \brief Values for mapping pixel to world coordinates. Contents of this array are the same as the GDAL adfGeoTransform double mGeoTransform[6]; QgsCoordinateReferenceSystem mCrs; QList mPyramidList; - /** \brief sublayers list saved for subsequent access */ + //! \brief sublayers list saved for subsequent access QStringList mSubLayers; }; diff --git a/src/providers/gdal/qgsgdalproviderbase.h b/src/providers/gdal/qgsgdalproviderbase.h index 2bd1e87d81e..9595112eb96 100644 --- a/src/providers/gdal/qgsgdalproviderbase.h +++ b/src/providers/gdal/qgsgdalproviderbase.h @@ -42,16 +42,16 @@ class QgsGdalProviderBase public: QgsGdalProviderBase(); - /** \brief ensures that GDAL drivers are registered, but only once */ + //! \brief ensures that GDAL drivers are registered, but only once static void registerGdalDrivers(); - /** Wrapper function for GDALOpen to get around possible bugs in GDAL */ + //! Wrapper function for GDALOpen to get around possible bugs in GDAL static GDALDatasetH gdalOpen( const char *pszFilename, GDALAccess eAccess ); - /** Wrapper function for GDALRasterIO to get around possible bugs in GDAL */ + //! Wrapper function for GDALRasterIO to get around possible bugs in GDAL static CPLErr gdalRasterIO( GDALRasterBandH hBand, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize, int nYSize, void * pData, int nBufXSize, int nBufYSize, GDALDataType eBufType, int nPixelSpace, int nLineSpace, QgsRasterBlockFeedback* feedback = nullptr ); - /** Wrapper function for GDALRasterIO to get around possible bugs in GDAL */ + //! Wrapper function for GDALRasterIO to get around possible bugs in GDAL static int gdalGetOverviewCount( GDALRasterBandH hBand ); protected: diff --git a/src/providers/gpx/gpsdata.h b/src/providers/gpx/gpsdata.h index b4681877a9a..ef5117d46aa 100644 --- a/src/providers/gpx/gpsdata.h +++ b/src/providers/gpx/gpsdata.h @@ -80,7 +80,7 @@ typedef QgsGPSPoint QgsRoutepoint; typedef QgsGPSPoint QgsTrackpoint; -/** This is the waypoint class. It is a GPSPoint with an ID. */ +//! This is the waypoint class. It is a GPSPoint with an ID. class QgsWaypoint : public QgsGPSPoint { public: @@ -128,11 +128,11 @@ class QgsGPSData { public: - /** This iterator type is used to iterate over waypoints. */ + //! This iterator type is used to iterate over waypoints. typedef QList::iterator WaypointIterator; - /** This iterator type is used to iterate over routes. */ + //! This iterator type is used to iterate over routes. typedef QList::iterator RouteIterator; - /** This iterator type is used to iterate over tracks. */ + //! This iterator type is used to iterate over tracks. typedef QList::iterator TrackIterator; @@ -145,25 +145,25 @@ class QgsGPSData yourself. */ QgsRectangle getExtent() const; - /** Sets a default sensible extent. Only applies when there are no actual data. */ + //! Sets a default sensible extent. Only applies when there are no actual data. void setNoDataExtent(); - /** Returns the number of waypoints in this dataset. */ + //! Returns the number of waypoints in this dataset. int getNumberOfWaypoints() const; - /** Returns the number of waypoints in this dataset. */ + //! Returns the number of waypoints in this dataset. int getNumberOfRoutes() const; - /** Returns the number of waypoints in this dataset. */ + //! Returns the number of waypoints in this dataset. int getNumberOfTracks() const; - /** This function returns an iterator that points to the first waypoint. */ + //! This function returns an iterator that points to the first waypoint. WaypointIterator waypointsBegin(); - /** This function returns an iterator that points to the first route. */ + //! This function returns an iterator that points to the first route. RouteIterator routesBegin(); - /** This function returns an iterator that points to the first track. */ + //! This function returns an iterator that points to the first track. TrackIterator tracksBegin(); /** This function returns an iterator that points to the end of the @@ -198,13 +198,13 @@ class QgsGPSData TrackIterator addTrack( const QgsTrack& trk ); - /** This function removes the waypoints whose IDs are in the list. */ + //! This function removes the waypoints whose IDs are in the list. void removeWaypoints( const QgsFeatureIds & ids ); - /** This function removes the routes whose IDs are in the list. */ + //! This function removes the routes whose IDs are in the list. void removeRoutes( const QgsFeatureIds & ids ); - /** This function removes the tracks whose IDs are in the list. */ + //! This function removes the tracks whose IDs are in the list. void removeTracks( const QgsFeatureIds & ids ); /** This function will write the contents of this GPSData object as XML to @@ -229,7 +229,7 @@ class QgsGPSData static void releaseData( const QString& fileName ); - /** Operator<< is our friend. For debugging, not for file I/O. */ + //! Operator<< is our friend. For debugging, not for file I/O. //friend std::ostream& operator<<(std::ostream& os, const GPSData& d); protected: @@ -241,7 +241,7 @@ class QgsGPSData double xMin, xMax, yMin, yMax; - /** This is used internally to store GPS data objects (one per file). */ + //! This is used internally to store GPS data objects (one per file). typedef QMap > DataMap; /** This is the static container that maps file names to GPSData objects and @@ -308,7 +308,7 @@ class QgsGPXHandler ParsingUnknown }; - /** This is used to keep track of what kind of data we are parsing. */ + //! This is used to keep track of what kind of data we are parsing. QStack parseModes; QgsGPSData& mData; diff --git a/src/providers/gpx/qgsgpxprovider.h b/src/providers/gpx/qgsgpxprovider.h index 7535331460a..4c74f657fce 100644 --- a/src/providers/gpx/qgsgpxprovider.h +++ b/src/providers/gpx/qgsgpxprovider.h @@ -101,10 +101,10 @@ class QgsGPXProvider : public QgsVectorDataProvider virtual QgsRectangle extent() const override; virtual bool isValid() const override; - /** Return a provider name */ + //! Return a provider name virtual QString name() const override; - /** Return description */ + //! Return description virtual QString description() const override; virtual QgsCoordinateReferenceSystem crs() const override; @@ -115,7 +115,7 @@ class QgsGPXProvider : public QgsVectorDataProvider void changeAttributeValues( QgsGPSObject& obj, const QgsAttributeMap& attrs ); - /** Adds one feature (used by addFeatures()) */ + //! Adds one feature (used by addFeatures()) bool addFeature( QgsFeature& f ); diff --git a/src/providers/grass/qgsgrass.h b/src/providers/grass/qgsgrass.h index 624ca857384..b67e722ebb1 100644 --- a/src/providers/grass/qgsgrass.h +++ b/src/providers/grass/qgsgrass.h @@ -178,10 +178,10 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject QgsGrass(); - /** Get singleton instance of this class. Used as signals proxy between provider and plugin. */ + //! Get singleton instance of this class. Used as signals proxy between provider and plugin. static QgsGrass* instance(); - /** Global GRASS library lock */ + //! Global GRASS library lock static void lock(); static void unlock(); @@ -236,18 +236,18 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject */ bool isMapsetInSearchPath( const QString &mapset ); - /** Add mapset to search path of currently open mapset */ + //! Add mapset to search path of currently open mapset void addMapsetToSearchPath( const QString & mapset, QString& error ); - /** Add mapset to search path of currently open mapset */ + //! Add mapset to search path of currently open mapset void removeMapsetFromSearchPath( const QString & mapset, QString& error ); //! Error codes returned by error() enum GERROR { - OK, /*!< OK. No error. */ - WARNING, /*!< Warning, non fatal error. Should be printed by application. */ - FATAL /*!< Fatal error */ + OK, //!< OK. No error. + WARNING, //!< Warning, non fatal error. Should be printed by application. + FATAL //!< Fatal error }; //! Reset error code (to OK). Call this before a piece of code where an error is expected @@ -262,7 +262,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject //! Get initialization error static QString initError() { return mInitError; } - /** Test is current user is owner of mapset */ + //! Test is current user is owner of mapset static bool isOwner( const QString& gisdbase, const QString& location, const QString& mapset ); /** Open existing GRASS mapset. @@ -280,10 +280,10 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject */ static QString closeMapset(); - /** \brief Save current mapset to project file. */ + //! \brief Save current mapset to project file. static void saveMapset(); - /** Create new mapset in existing location */ + //! Create new mapset in existing location static void createMapset( const QString& gisdbase, const QString& location, const QString& mapset, QString& error ); @@ -498,21 +498,21 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject * @param error */ static void createVectorMap( const QgsGrassObject & object, QString &error ); - /** Create new table. Throws QgsGrass::Exception */ + //! Create new table. Throws QgsGrass::Exception static void createTable( dbDriver *driver, const QString &tableName, const QgsFields &fields ); - /** Insert row to table. Throws QgsGrass::Exception */ + //! Insert row to table. Throws QgsGrass::Exception static void insertRow( dbDriver *driver, const QString &tableName, const QgsAttributes& attributes ); - /** Returns true if object is link to external data (created by r.external) */ + //! Returns true if object is link to external data (created by r.external) static bool isExternal( const QgsGrassObject & object ); /** Adjust cell header, G_adjust_Cell_head wrapper * @throws QgsGrass::Exception */ static void adjustCellHead( struct Cell_head *cellhd, int row_flag, int col_flag ); - /** Get map of vector types / names */ + //! Get map of vector types / names static QMap vectorTypeMap(); /** Get GRASS vector type from name @@ -583,7 +583,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject static QPen regionPen(); - /** Store region pen in settings, emits regionPenChanged */ + //! Store region pen in settings, emits regionPenChanged void setRegionPen( const QPen & pen ); // Modules UI debug @@ -592,10 +592,10 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject // Switch modules UI debug void setModulesDebug( bool debug ); - /** Show warning dialog with message */ + //! Show warning dialog with message static void warning( const QString &message ); - /** Show warning dialog with exception message */ + //! Show warning dialog with exception message static void warning( QgsGrass::Exception &e ); /** Set mute mode, if set, warning() does not open dialog but prints only @@ -621,31 +621,31 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject static ModuleOutput parseModuleOutput( const QString & input, QString &text, QString &html, int &value ); public slots: - /** Close mapset and show warning if closing failed */ + //! Close mapset and show warning if closing failed bool closeMapsetWarn(); void openOptions(); - /** Read mapset search path from GRASS location */ + //! Read mapset search path from GRASS location void loadMapsetSearchPath(); void setMapsetSearchPathWatcher(); void onSearchPathFileChanged( const QString & path ); signals: - /** Signal emitted when user changed GISBASE */ + //! Signal emitted when user changed GISBASE void gisbaseChanged(); - /** Signal emitted after mapset was opened */ + //! Signal emitted after mapset was opened void mapsetChanged(); - /** Signal emitted when mapset search path changed (SEARCH_PATH file changed and it was loaded to mMapsetSearchPath) */ + //! Signal emitted when mapset search path changed (SEARCH_PATH file changed and it was loaded to mMapsetSearchPath) void mapsetSearchPathChanged(); - /** Emitted when path to modules config dir changed */ + //! Emitted when path to modules config dir changed void modulesConfigChanged(); - /** Emitted when modules debug mode changed */ + //! Emitted when modules debug mode changed void modulesDebugChanged(); /** Emitted when current region changed @@ -654,7 +654,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject */ void regionChanged(); - /** Emitted when region pen changed */ + //! Emitted when region pen changed void regionPenChanged(); /** Request from browser to open a new layer for editing, the plugin should connect diff --git a/src/providers/grass/qgsgrassfeatureiterator.h b/src/providers/grass/qgsgrassfeatureiterator.h index 297b0dd965e..205beb9e56b 100644 --- a/src/providers/grass/qgsgrassfeatureiterator.h +++ b/src/providers/grass/qgsgrassfeatureiterator.h @@ -37,8 +37,8 @@ class GRASS_LIB_EXPORT QgsGrassFeatureSource : public QgsAbstractFeatureSource enum Selection { - NotSelected = 0, /*!< not selected */ - Selected = 1, /*!< line/area selected */ + NotSelected = 0, //!< Not selected + Selected = 1, //!< Line/area selected Used = 2 /*!< the line was already used to create feature read in this cycle. * The codes Used must be reset to Selected if getFirstFeature() or select() is called. * Distinction between Selected and Used is used if attribute table exists, in which case @@ -110,7 +110,7 @@ class GRASS_LIB_EXPORT QgsGrassFeatureIterator : public QObject, public QgsAbstr //void lock(); //void unlock(); - /** Reset selection */ + //! Reset selection void resetSelection( bool value ); void setSelectionRect( const QgsRectangle& rect, bool useIntersect ); @@ -130,10 +130,10 @@ class GRASS_LIB_EXPORT QgsGrassFeatureIterator : public QObject, public QgsAbstr */ void setFeatureAttributes( int cat, QgsFeature *feature, const QgsAttributeList & attlist, QgsGrassVectorMap::TopoSymbol symbol ); - /** Canceled -> close when possible */ + //! Canceled -> close when possible bool mCanceled; - /** Selection array */ + //! Selection array QBitArray mSelection; // !UPDATE! // Edit mode is using mNextLid + mNextCidx diff --git a/src/providers/grass/qgsgrassgislib.h b/src/providers/grass/qgsgrassgislib.h index 59f768eb727..bb677e30af7 100644 --- a/src/providers/grass/qgsgrassgislib.h +++ b/src/providers/grass/qgsgrassgislib.h @@ -110,20 +110,20 @@ class GRASS_LIB_EXPORT QgsGrassGisLib int G_get_ellipsoid_parameters( double *a, double *e2 ); - /** Get QGIS raster type for GRASS raster type */ + //! Get QGIS raster type for GRASS raster type Qgis::DataType qgisRasterType( RASTER_MAP_TYPE grassType ); - /** Get GRASS raster type for QGIS raster type */ + //! Get GRASS raster type for QGIS raster type RASTER_MAP_TYPE grassRasterType( Qgis::DataType qgisType ); - /** Get no data value for GRASS data type */ + //! Get no data value for GRASS data type double noDataValueForGrassType( RASTER_MAP_TYPE grassType ); /** Grass does not seem to have any function to init Cell_head, * initialization is done in G__read_Cell_head_array */ void initCellHead( struct Cell_head *cellhd ); - /** Get raster from map of opened rasters, open it if it is not yet open */ + //! Get raster from map of opened rasters, open it if it is not yet open Raster raster( QString name ); void * resolve( const char * symbol ); @@ -136,32 +136,32 @@ class GRASS_LIB_EXPORT QgsGrassGisLib void warning( QString msg ); private: - /** Pointer to canonical Singleton object */ + //! Pointer to canonical Singleton object static QgsGrassGisLib* _instance; - /** Original GRASS library handle */ + //! Original GRASS library handle QLibrary mLibrary; - /** Raster maps, key is fake file descriptor */ + //! Raster maps, key is fake file descriptor QMap mRasters; - /** Region to be used for data processing and output */ + //! Region to be used for data processing and output struct Cell_head mWindow; - /** Current region extent */ + //! Current region extent QgsRectangle mExtent; - /** Current region rows */ + //! Current region rows int mRows; - /** Current region columns */ + //! Current region columns int mColumns; - /** X resolution */ + //! X resolution double mXRes; - /** Y resolution */ + //! Y resolution double mYRes; - /** Current coordinate reference system */ + //! Current coordinate reference system QgsCoordinateReferenceSystem mCrs; QgsDistanceArea mDistanceArea; - /** Lat1, lat2 used for geodesic distance calculation */ + //! Lat1, lat2 used for geodesic distance calculation double mLat1, mLat2; }; diff --git a/src/providers/grass/qgsgrassprovider.h b/src/providers/grass/qgsgrassprovider.h index daef91fec2d..07ce0521fa2 100644 --- a/src/providers/grass/qgsgrassprovider.h +++ b/src/providers/grass/qgsgrassprovider.h @@ -93,7 +93,7 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider // ! Key (category) field index int keyField(); - /** Restart reading features from previous select operation */ + //! Restart reading features from previous select operation void rewind(); QVariant minimumValue( int index ) const override; @@ -108,7 +108,7 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider */ void update(); - /** Load info (mNumberFeatures, mCidxFieldIndex, mCidxFieldNumCats) from map */ + //! Load info (mNumberFeatures, mCidxFieldIndex, mCidxFieldNumCats) from map void loadMapInfo(); bool isValid() const override; @@ -155,10 +155,10 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider //void startEditing( QgsVectorLayerEditBuffer* buffer ); void startEditing( QgsVectorLayer *vectorLayer ); - /** Freeze vector. */ + //! Freeze vector. void freeze(); - /** Thaw vector. */ + //! Thaw vector. void thaw(); /** Close editing. Rebuild topology, GMAP.update = false @@ -324,16 +324,16 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider /* Following functions work only until first edit operation! (category index used) */ - /** Get number of fields in category index */ + //! Get number of fields in category index int cidxGetNumFields( void ); - /** Get field number for index */ + //! Get field number for index int cidxGetFieldNumber( int idx ); - /** Get maximum category for field index */ + //! Get maximum category for field index int cidxGetMaxCat( int idx ); - /** Returns GRASS layer number */ + //! Returns GRASS layer number int grassLayer(); /** Returns GRASS layer number for given layer name or -1 if cannot @@ -346,10 +346,10 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider */ static int grassLayerType( const QString & ); - /** Return a provider name */ + //! Return a provider name QString name() const override; - /** Return description */ + //! Return description QString description() const override; // Layer type (layerType) @@ -432,10 +432,10 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider */ static char *attribute( int layerId, int cat, int column ); - /** Check if provider is outdated and update if necessary */ + //! Check if provider is outdated and update if necessary void ensureUpdated() const; - /** Check if layer is topology layer TOPO_POINT, TOPO_NODE, TOPO_LINE */ + //! Check if layer is topology layer TOPO_POINT, TOPO_NODE, TOPO_LINE bool isTopoType() const; static bool isTopoType( int layerType ); @@ -447,7 +447,7 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider // Get other edited layer, returns 0 if layer does not exist QgsGrassVectorMapLayer * otherEditLayer( int layerField ); - /** Fields used for topo layers */ + //! Fields used for topo layers QgsFields mTopoFields; //QgsFields mEditFields; diff --git a/src/providers/grass/qgsgrassvector.h b/src/providers/grass/qgsgrassvector.h index a714fe2ea25..2596989586a 100644 --- a/src/providers/grass/qgsgrassvector.h +++ b/src/providers/grass/qgsgrassvector.h @@ -36,19 +36,19 @@ class GRASS_LIB_EXPORT QgsGrassVectorLayer : public QObject QgsGrassObject grassObject() const { return mGrassObject; } - /** Layer number (field) */ + //! Layer number (field) int number() { return mNumber; } - /** Set number of elements of given type. */ + //! Set number of elements of given type. void setTypeCount( int type, int count ) { mTypeCounts[type] = count; } - /** Get number of elements of given type. Types may be combined by bitwise or)*/ + //! Get number of elements of given type. Types may be combined by bitwise or) int typeCount( int type ) const; - /** Get all types in the layer (combined by bitwise or)*/ + //! Get all types in the layer (combined by bitwise or) int type() const; - /** Get all types in the layer as list */ + //! Get all types in the layer as list QList types() const; QgsFields fields(); @@ -84,27 +84,27 @@ class GRASS_LIB_EXPORT QgsGrassVector : public QObject QgsGrassVector( const QgsGrassObject& grassObject, QObject *parent = 0 ); - /** Open header and read layers/types */ + //! Open header and read layers/types bool openHead(); - /** Get list of layers. The layers exist until the vector is deleted or reloaded */ + //! Get list of layers. The layers exist until the vector is deleted or reloaded QList layers() const { return mLayers; } /** Get numbers of primitives * @return type/count pairs */ QMap typeCounts() const {return mTypeCounts; } - /** Get total number of primitives of given type. Types may be combined by bitwise or) */ + //! Get total number of primitives of given type. Types may be combined by bitwise or) int typeCount( int type ) const; /** Maximum layer number (field). * @return max layer number or 0 if no layer exists */ int maxLayerNumber() const; - /** Get number of nodes */ + //! Get number of nodes int nodeCount() const { return mNodeCount; } - /** Return error message */ + //! Return error message QString error() const { return mError; } signals: diff --git a/src/providers/grass/qgsgrassvectormap.h b/src/providers/grass/qgsgrassvectormap.h index 13115c4faea..4f707bb6502 100644 --- a/src/providers/grass/qgsgrassvectormap.h +++ b/src/providers/grass/qgsgrassvectormap.h @@ -93,19 +93,19 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject QgsAbstractGeometry * nodeGeometry( int id ); QgsAbstractGeometry * areaGeometry( int id ); - /** Open map if not yet open. Open/close lock */ + //! Open map if not yet open. Open/close lock bool open(); - /** Close map. All iterators are closed first. Open/close lock. */ + //! Close map. All iterators are closed first. Open/close lock. void close(); - /** Open GRASS map, no open/close locking */ + //! Open GRASS map, no open/close locking bool openMap(); - /** Close GRASS map, no open/close locking */ + //! Close GRASS map, no open/close locking void closeMap(); - /** Reload layers from (reopened) map. The layers keep field/type. */ + //! Reload layers from (reopened) map. The layers keep field/type. void reloadLayers(); bool startEdit(); @@ -136,7 +136,7 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject */ bool attributesOutdated(); - /** Map descripton for debugging */ + //! Map descripton for debugging QString toString(); /** Get topology symbol code @@ -153,14 +153,14 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject * Qt::DirectConnection (non blocking) */ void cancelIterators(); - /** Close all iterators. Connected to iterators in different threads with Qt::BlockingQueuedConnection */ + //! Close all iterators. Connected to iterators in different threads with Qt::BlockingQueuedConnection void closeIterators(); - /** Emitted when data were reloaded */ + //! Emitted when data were reloaded void dataChanged(); private: - /** Close iterators, blocking */ + //! Close iterators, blocking void closeAllIterators(); QgsGrassObject mGrassObject; @@ -231,7 +231,7 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapStore QgsGrassVectorMap * openMap( const QgsGrassObject & grassObject ); private: - /** Open vector maps */ + //! Open vector maps QList mMaps; // Lock open/close map diff --git a/src/providers/grass/qgsgrassvectormaplayer.h b/src/providers/grass/qgsgrassvectormaplayer.h index 4ea54fe92e2..f1ca5520746 100644 --- a/src/providers/grass/qgsgrassvectormaplayer.h +++ b/src/providers/grass/qgsgrassvectormaplayer.h @@ -54,10 +54,10 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapLayer : public QObject bool isValid() const { return mValid; } QgsGrassVectorMap *map() { return mMap; } - /** Category index index */ + //! Category index index int cidxFieldIndex(); - /** Current number of cats in cat index, changing during editing */ + //! Current number of cats in cat index, changing during editing int cidxFieldNumCats(); /** Original fields before editing started + topo field if edited. @@ -86,13 +86,13 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapLayer : public QObject void addUser(); void removeUser(); - /** Load attributes from the map. Old sources are released. */ + //! Load attributes from the map. Old sources are released. void load(); - /** Clear all cached data */ + //! Clear all cached data void clear(); - /** Decrease number of users and clear if no more users */ + //! Decrease number of users and clear if no more users void close(); void startEdit(); @@ -156,7 +156,7 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapLayer : public QObject void deleteColumn( const QgsField &field, QString &error ); - /** Insert records for all existing categories to the table */ + //! Insert records for all existing categories to the table void insertCats( QString &error ); // update fields to real state diff --git a/src/providers/memory/qgsmemoryprovider.h b/src/providers/memory/qgsmemoryprovider.h index 7beb40298c0..88e6adf39f5 100644 --- a/src/providers/memory/qgsmemoryprovider.h +++ b/src/providers/memory/qgsmemoryprovider.h @@ -110,7 +110,7 @@ class QgsMemoryProvider : public QgsVectorDataProvider QString subsetString() const override; - /** Mutator for sql where clause used to limit dataset size */ + //! Mutator for sql where clause used to limit dataset size bool setSubsetString( const QString& theSQL, bool updateFeatureCount = true ) override; virtual bool supportsSubsetString() const override { return true; } diff --git a/src/providers/mssql/qgsmssqlnewconnection.cpp b/src/providers/mssql/qgsmssqlnewconnection.cpp index 1b090d9d176..5fd8099c3a1 100644 --- a/src/providers/mssql/qgsmssqlnewconnection.cpp +++ b/src/providers/mssql/qgsmssqlnewconnection.cpp @@ -66,7 +66,7 @@ QgsMssqlNewConnection::QgsMssqlNewConnection( QWidget *parent, const QString& co } on_cb_trustedConnection_clicked(); } -/** Autoconnected SLOTS **/ +//! Autoconnected SLOTS * void QgsMssqlNewConnection::accept() { QSettings settings; @@ -140,7 +140,7 @@ void QgsMssqlNewConnection::on_cb_trustedConnection_clicked() } } -/** End Autoconnected SLOTS **/ +//! End Autoconnected SLOTS * QgsMssqlNewConnection::~QgsMssqlNewConnection() { diff --git a/src/providers/mssql/qgsmssqlprovider.h b/src/providers/mssql/qgsmssqlprovider.h index 982b2be960f..916cf6fc06a 100644 --- a/src/providers/mssql/qgsmssqlprovider.h +++ b/src/providers/mssql/qgsmssqlprovider.h @@ -91,14 +91,14 @@ class QgsMssqlProvider : public QgsVectorDataProvider */ virtual long featureCount() const override; - /** Update the extent, feature count, wkb type and srid for this layer */ + //! Update the extent, feature count, wkb type and srid for this layer void UpdateStatistics( bool estimate ) const; virtual QgsFields fields() const override; QString subsetString() const override; - /** Mutator for sql where clause used to limit dataset size */ + //! Mutator for sql where clause used to limit dataset size bool setSubsetString( const QString& theSQL, bool updateFeatureCount = true ) override; virtual bool supportsSubsetString() const override { return true; } @@ -146,10 +146,10 @@ class QgsMssqlProvider : public QgsVectorDataProvider virtual bool isSaveAndLoadStyleToDBSupported() const override { return true; } - /** Writes a list of features to the database*/ + //! Writes a list of features to the database virtual bool addFeatures( QgsFeatureList & flist ) override; - /** Deletes a feature*/ + //! Deletes a feature virtual bool deleteFeatures( const QgsFeatureIds & id ) override; /** @@ -166,10 +166,10 @@ class QgsMssqlProvider : public QgsVectorDataProvider */ virtual bool deleteAttributes( const QgsAttributeIds &attributes ) override; - /** Changes attribute values of existing features */ + //! Changes attribute values of existing features virtual bool changeAttributeValues( const QgsChangedAttributesMap &attr_map ) override; - /** Changes existing geometries*/ + //! Changes existing geometries virtual bool changeGeometryValues( const QgsGeometryMap &geometry_map ) override; /** @@ -177,18 +177,18 @@ class QgsMssqlProvider : public QgsVectorDataProvider */ virtual bool createSpatialIndex() override; - /** Create an attribute index on the datasource*/ + //! Create an attribute index on the datasource virtual bool createAttributeIndex( int field ) override; - /** Convert a QgsField to work with MSSQL */ + //! Convert a QgsField to work with MSSQL static bool convertField( QgsField &field ); - /** Convert values to quoted values for database work **/ + //! Convert values to quoted values for database work * static QString quotedValue( const QVariant& value ); QVariant defaultValue( int fieldId ) const override; - /** Import a vector layer into the database */ + //! Import a vector layer into the database static QgsVectorLayerImport::ImportError createEmptyLayer( const QString& uri, const QgsFields &fields, @@ -203,7 +203,7 @@ class QgsMssqlProvider : public QgsVectorDataProvider virtual QgsCoordinateReferenceSystem crs() const override; protected: - /** Loads fields from input file to member attributeFields */ + //! Loads fields from input file to member attributeFields QVariant::Type DecodeSqlType( const QString& sqlTypeName ); void loadFields(); void loadMetadata(); diff --git a/src/providers/mssql/qgsmssqlsourceselect.cpp b/src/providers/mssql/qgsmssqlsourceselect.cpp index 6485d4034c7..72154ec5d7e 100644 --- a/src/providers/mssql/qgsmssqlsourceselect.cpp +++ b/src/providers/mssql/qgsmssqlsourceselect.cpp @@ -38,7 +38,7 @@ #include #include -/** Used to create an editor for when the user tries to change the contents of a cell */ +//! Used to create an editor for when the user tries to change the contents of a cell QWidget *QgsMssqlSourceSelectDelegate::createEditor( QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index ) const { Q_UNUSED( option ); @@ -205,7 +205,7 @@ QgsMssqlSourceSelect::QgsMssqlSourceSelect( QWidget *parent, Qt::WindowFlags fl, cbxAllowGeometrylessTables->setDisabled( true ); } -/** Autoconnected SLOTS **/ +//! Autoconnected SLOTS * // Slot for adding a new connection void QgsMssqlSourceSelect::on_btnNew_clicked() { @@ -280,7 +280,7 @@ void QgsMssqlSourceSelect::on_btnEdit_clicked() delete nc; } -/** End Autoconnected SLOTS **/ +//! End Autoconnected SLOTS * // Remember which database is selected void QgsMssqlSourceSelect::on_cmbConnections_activated( int ) diff --git a/src/providers/mssql/qgsmssqltablemodel.h b/src/providers/mssql/qgsmssqltablemodel.h index 8bea4bc1290..0167b29a9a4 100644 --- a/src/providers/mssql/qgsmssqltablemodel.h +++ b/src/providers/mssql/qgsmssqltablemodel.h @@ -19,7 +19,7 @@ #include "qgis.h" -/** Layer Property structure */ +//! Layer Property structure struct QgsMssqlLayerProperty { // MSSQL layer properties @@ -46,17 +46,17 @@ class QgsMssqlTableModel : public QStandardItemModel QgsMssqlTableModel(); ~QgsMssqlTableModel(); - /** Adds entry for one database table to the model*/ + //! Adds entry for one database table to the model void addTableEntry( const QgsMssqlLayerProperty &property ); - /** Sets an sql statement that belongs to a cell specified by a model index*/ + //! Sets an sql statement that belongs to a cell specified by a model index void setSql( const QModelIndex& index, const QString& sql ); /** Sets one or more geometry types to a row. In case of several types, additional rows are inserted. This is for tables where the type is dectected later by thread*/ void setGeometryTypesForTable( QgsMssqlLayerProperty layerProperty ); - /** Returns the number of tables in the model*/ + //! Returns the number of tables in the model int tableCount() const { return mTableCount; } enum columns @@ -81,7 +81,7 @@ class QgsMssqlTableModel : public QStandardItemModel static QgsWkbTypes::Type wkbTypeFromMssql( QString dbType ); private: - /** Number of tables in the model*/ + //! Number of tables in the model int mTableCount; }; diff --git a/src/providers/ogr/qgsogrconnpool.h b/src/providers/ogr/qgsogrconnpool.h index 10035951c01..0aa84563cfb 100644 --- a/src/providers/ogr/qgsogrconnpool.h +++ b/src/providers/ogr/qgsogrconnpool.h @@ -87,7 +87,7 @@ class QgsOgrConnPoolGroup : public QObject, public QgsConnectionPoolGroup { public: diff --git a/src/providers/ogr/qgsogrprovider.cpp b/src/providers/ogr/qgsogrprovider.cpp index 66fdc6dc7a2..89191a6f205 100644 --- a/src/providers/ogr/qgsogrprovider.cpp +++ b/src/providers/ogr/qgsogrprovider.cpp @@ -1981,17 +1981,17 @@ static QString createFileFilter_( QString const &longName, QString const &glob ) QString createFilters( const QString& type ) { - /** Database drivers available*/ + //! Database drivers available static QString myDatabaseDrivers; - /** Protocol drivers available*/ + //! Protocol drivers available static QString myProtocolDrivers; - /** File filters*/ + //! File filters static QString myFileFilters; - /** Directory drivers*/ + //! Directory drivers static QString myDirectoryDrivers; - /** Extensions*/ + //! Extensions static QStringList myExtensions; - /** Wildcards*/ + //! Wildcards static QStringList myWildcards; // if we've already built the supported vector string, just return what diff --git a/src/providers/ogr/qgsogrprovider.h b/src/providers/ogr/qgsogrprovider.h index b60aa3e09b3..22291f0700a 100644 --- a/src/providers/ogr/qgsogrprovider.h +++ b/src/providers/ogr/qgsogrprovider.h @@ -52,7 +52,7 @@ class QgsOgrProvider : public QgsVectorDataProvider public: - /** Convert a vector layer to a vector file */ + //! Convert a vector layer to a vector file static QgsVectorLayerImport::ImportError createEmptyLayer( const QString& uri, const QgsFields &fields, @@ -98,7 +98,7 @@ class QgsOgrProvider : public QgsVectorDataProvider virtual bool supportsSubsetString() const override { return true; } - /** Mutator for sql where clause used to limit dataset size */ + //! Mutator for sql where clause used to limit dataset size virtual bool setSubsetString( const QString& theSQL, bool updateFeatureCount = true ) override; /** @@ -128,27 +128,27 @@ class QgsOgrProvider : public QgsVectorDataProvider */ virtual void updateExtents() override; - /** Writes a list of features to the file*/ + //! Writes a list of features to the file virtual bool addFeatures( QgsFeatureList & flist ) override; - /** Deletes a feature*/ + //! Deletes a feature virtual bool deleteFeatures( const QgsFeatureIds & id ) override; virtual bool addAttributes( const QList &attributes ) override; virtual bool deleteAttributes( const QgsAttributeIds &attributes ) override; virtual bool renameAttributes( const QgsFieldNameMap& renamedAttributes ) override; - /** Changes attribute values of existing features */ + //! Changes attribute values of existing features virtual bool changeAttributeValues( const QgsChangedAttributesMap &attr_map ) override; - /** Changes existing geometries*/ + //! Changes existing geometries virtual bool changeGeometryValues( const QgsGeometryMap &geometry_map ) override; /** Tries to create a .qix index file for faster access if only a subset of the features is required @return true in case of success*/ virtual bool createSpatialIndex() override; - /** Create an attribute index on the datasource*/ + //! Create an attribute index on the datasource virtual bool createAttributeIndex( int field ) override; /** Returns a bitmask containing the supported capabilities @@ -176,11 +176,11 @@ class QgsOgrProvider : public QgsVectorDataProvider */ /* virtual */ QString fileVectorFilters() const override; - /** Return a string containing the available database drivers */ + //! Return a string containing the available database drivers QString databaseDrivers() const; - /** Return a string containing the available directory drivers */ + //! Return a string containing the available directory drivers QString protocolDrivers() const; - /** Return a string containing the available protocol drivers */ + //! Return a string containing the available protocol drivers QString directoryDrivers() const; /** Returns true if this is a valid shapefile @@ -238,10 +238,10 @@ class QgsOgrProvider : public QgsVectorDataProvider */ virtual bool doesStrictFeatureTypeCheck() const override; - /** Return OGR geometry type */ + //! Return OGR geometry type static OGRwkbGeometryType getOgrGeomType( OGRLayerH ogrLayer ); - /** Get single flatten geometry type */ + //! Get single flatten geometry type static OGRwkbGeometryType ogrWkbSingleFlatten( OGRwkbGeometryType type ); QString layerName() const { return mLayerName; } @@ -259,26 +259,26 @@ class QgsOgrProvider : public QgsVectorDataProvider */ void forceReload() override; - /** Closes and re-open the datasource */ + //! Closes and re-open the datasource void reloadData() override; protected: - /** Loads fields from input file to member attributeFields */ + //! Loads fields from input file to member attributeFields void loadFields(); - /** Find out the number of features of the whole layer */ + //! Find out the number of features of the whole layer void recalculateFeatureCount(); - /** Tell OGR, which fields to fetch in nextFeature/featureAtId (ie. which not to ignore) */ + //! Tell OGR, which fields to fetch in nextFeature/featureAtId (ie. which not to ignore) void setRelevantFields( OGRLayerH ogrLayer, bool fetchGeometry, const QgsAttributeList& fetchAttributes ); - /** Convert a QgsField to work with OGR */ + //! Convert a QgsField to work with OGR static bool convertField( QgsField &field, const QTextCodec &encoding ); - /** Clean shapefile from features which are marked as deleted */ + //! Clean shapefile from features which are marked as deleted void repack(); - /** Invalidate extent and optionnaly force its low level recomputation */ + //! Invalidate extent and optionnaly force its low level recomputation void invalidateCachedExtent( bool bForceRecomputeExtent ); enum OpenMode @@ -344,30 +344,30 @@ class QgsOgrProvider : public QgsVectorDataProvider mutable QStringList mSubLayerList; - /** Adds one feature*/ + //! Adds one feature bool addFeature( QgsFeature& f ); - /** Deletes one feature*/ + //! Deletes one feature bool deleteFeature( QgsFeatureId id ); - /** Calls OGR_L_SyncToDisk and recreates the spatial index if present*/ + //! Calls OGR_L_SyncToDisk and recreates the spatial index if present bool syncToDisc(); OGRLayerH setSubsetString( OGRLayerH layer, OGRDataSourceH ds ); friend class QgsOgrFeatureSource; - /** Whether the file is opened in write mode*/ + //! Whether the file is opened in write mode bool mWriteAccess; - /** Whether the file can potentially be opened in write mode (but not necessarily currently) */ + //! Whether the file can potentially be opened in write mode (but not necessarily currently) bool mWriteAccessPossible; - /** Whether the open mode of the datasource changes w.r.t calls to enterUpdateMode() / leaveUpdateMode() */ + //! Whether the open mode of the datasource changes w.r.t calls to enterUpdateMode() / leaveUpdateMode() bool mDynamicWriteAccess; bool mShapefileMayBeCorrupted; - /** Converts the geometry to the layer type if necessary. Takes ownership of the passed geometry */ + //! Converts the geometry to the layer type if necessary. Takes ownership of the passed geometry OGRGeometryH ConvertGeometryIfNecessary( OGRGeometryH ); int mUpdateModeStackDepth; diff --git a/src/providers/oracle/qgsoracleconn.h b/src/providers/oracle/qgsoracleconn.h index 57c4e4845e7..d1fa11d7106 100644 --- a/src/providers/oracle/qgsoracleconn.h +++ b/src/providers/oracle/qgsoracleconn.h @@ -130,10 +130,10 @@ class QgsOracleConn : public QObject void retrieveLayerTypes( QgsOracleLayerProperty &layerProperty, bool useEstimatedMetadata, bool onlyExistingTypes ); - /** Gets information about the spatial tables */ + //! Gets information about the spatial tables bool tableInfo( bool geometryTablesOnly, bool userTablesOnly, bool allowGeometrylessTables ); - /** Get primary key candidates (all int4 columns) */ + //! Get primary key candidates (all int4 columns) QStringList pkCandidates( QString ownerName, QString viewName ); static QString fieldExpression( const QgsField &fld ); diff --git a/src/providers/oracle/qgsoracleconnpool.h b/src/providers/oracle/qgsoracleconnpool.h index 60810885a9a..46d1d8f2b6c 100644 --- a/src/providers/oracle/qgsoracleconnpool.h +++ b/src/providers/oracle/qgsoracleconnpool.h @@ -64,7 +64,7 @@ class QgsOracleConnPoolGroup : public QObject, public QgsConnectionPoolGroup { public: diff --git a/src/providers/oracle/qgsoraclenewconnection.cpp b/src/providers/oracle/qgsoraclenewconnection.cpp index b2ad458edba..a850b6ef482 100644 --- a/src/providers/oracle/qgsoraclenewconnection.cpp +++ b/src/providers/oracle/qgsoraclenewconnection.cpp @@ -81,7 +81,7 @@ QgsOracleNewConnection::QgsOracleNewConnection( QWidget *parent, const QString& txtName->setText( connName ); } } -/** Autoconnected SLOTS **/ +//! Autoconnected SLOTS * void QgsOracleNewConnection::accept() { QSettings settings; @@ -165,7 +165,7 @@ void QgsOracleNewConnection::on_btnConnect_clicked() } } -/** End Autoconnected SLOTS **/ +//! End Autoconnected SLOTS * QgsOracleNewConnection::~QgsOracleNewConnection() { diff --git a/src/providers/oracle/qgsoracleprovider.h b/src/providers/oracle/qgsoracleprovider.h index 1c39a328b15..3ba0ad3a3da 100644 --- a/src/providers/oracle/qgsoracleprovider.h +++ b/src/providers/oracle/qgsoracleprovider.h @@ -59,7 +59,7 @@ class QgsOracleProvider : public QgsVectorDataProvider public: - /** Import a vector layer into the database */ + //! Import a vector layer into the database static QgsVectorLayerImport::ImportError createEmptyLayer( const QString& uri, const QgsFields &fields, @@ -180,10 +180,10 @@ class QgsOracleProvider : public QgsVectorDataProvider QgsAttributeList pkAttributeIndexes() const override { return mPrimaryKeyAttrs; } - /** Returns the default value for field specified by @c fieldName */ + //! Returns the default value for field specified by @c fieldName QVariant defaultValue( QString fieldName, QString tableName = QString::null, QString schemaName = QString::null ); - /** Returns the default value for field specified by @c fieldId */ + //! Returns the default value for field specified by @c fieldId QVariant defaultValue( int fieldId ) const override; /** Adds a list of features @@ -231,15 +231,15 @@ class QgsOracleProvider : public QgsVectorDataProvider //! Get the table name associated with this provider instance QString getTableName(); - /** Accessor for sql where clause used to limit dataset */ + //! Accessor for sql where clause used to limit dataset QString subsetString() const override; - /** Mutator for sql where clause used to limit dataset size */ + //! Mutator for sql where clause used to limit dataset size bool setSubsetString( const QString& theSQL, bool updateFeatureCount = true ) override; virtual bool supportsSubsetString() const override { return true; } - /** Returns a bitmask containing the supported capabilities*/ + //! Returns a bitmask containing the supported capabilities QgsVectorDataProvider::Capabilities capabilities() const override; /** Return a provider name @@ -298,7 +298,7 @@ class QgsOracleProvider : public QgsVectorDataProvider */ bool loadFields(); - /** Convert a QgsField to work with Oracle */ + //! Convert a QgsField to work with Oracle static bool convertField( QgsField &field ); QgsFields mAttributeFields; //! List of fields @@ -421,7 +421,7 @@ class QgsOracleProvider : public QgsVectorDataProvider }; -/** Assorted Oracle utility functions */ +//! Assorted Oracle utility functions class QgsOracleUtils { public: diff --git a/src/providers/oracle/qgsoraclesourceselect.cpp b/src/providers/oracle/qgsoraclesourceselect.cpp index 5da2f8b37ed..27b90538938 100644 --- a/src/providers/oracle/qgsoraclesourceselect.cpp +++ b/src/providers/oracle/qgsoraclesourceselect.cpp @@ -38,7 +38,7 @@ email : jef at norbit dot de #include #include -/** Used to create an editor for when the user tries to change the contents of a cell */ +//! Used to create an editor for when the user tries to change the contents of a cell QWidget *QgsOracleSourceSelectDelegate::createEditor( QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index ) const { Q_UNUSED( option ); @@ -256,7 +256,7 @@ QgsOracleSourceSelect::QgsOracleSourceSelect( QWidget *parent, Qt::WindowFlags f populateConnectionList(); } -/** Autoconnected SLOTS **/ +//! Autoconnected SLOTS * // Slot for adding a new connection void QgsOracleSourceSelect::on_btnNew_clicked() { @@ -319,7 +319,7 @@ void QgsOracleSourceSelect::on_btnEdit_clicked() delete nc; } -/** End Autoconnected SLOTS **/ +//! End Autoconnected SLOTS * // Remember which database is selected void QgsOracleSourceSelect::on_cmbConnections_currentIndexChanged( const QString & text ) diff --git a/src/providers/oracle/qgsoracletablemodel.h b/src/providers/oracle/qgsoracletablemodel.h index 79c4b014b1a..1ace38890aa 100644 --- a/src/providers/oracle/qgsoracletablemodel.h +++ b/src/providers/oracle/qgsoracletablemodel.h @@ -33,13 +33,13 @@ class QgsOracleTableModel : public QStandardItemModel QgsOracleTableModel(); ~QgsOracleTableModel(); - /** Adds entry for one database table to the model*/ + //! Adds entry for one database table to the model void addTableEntry( const QgsOracleLayerProperty &property ); - /** Sets an sql statement that belongs to a cell specified by a model index*/ + //! Sets an sql statement that belongs to a cell specified by a model index void setSql( const QModelIndex& index, const QString& sql ); - /** Returns the number of tables in the model*/ + //! Returns the number of tables in the model int tableCount() const { return mTableCount; } enum columns @@ -62,7 +62,7 @@ class QgsOracleTableModel : public QStandardItemModel static QIcon iconForWkbType( QgsWkbTypes::Type type ); private: - /** Number of tables in the model*/ + //! Number of tables in the model int mTableCount; }; diff --git a/src/providers/postgres/qgspgnewconnection.cpp b/src/providers/postgres/qgspgnewconnection.cpp index 8bca623385b..4a207983a25 100644 --- a/src/providers/postgres/qgspgnewconnection.cpp +++ b/src/providers/postgres/qgspgnewconnection.cpp @@ -104,7 +104,7 @@ QgsPgNewConnection::QgsPgNewConnection( QWidget *parent, const QString& connName txtName->setText( connName ); } } -/** Autoconnected SLOTS **/ +//! Autoconnected SLOTS * void QgsPgNewConnection::accept() { QSettings settings; @@ -176,7 +176,7 @@ void QgsPgNewConnection::on_cb_geometryColumnsOnly_clicked() cb_publicSchemaOnly->setEnabled( true ); } -/** End Autoconnected SLOTS **/ +//! End Autoconnected SLOTS * QgsPgNewConnection::~QgsPgNewConnection() { diff --git a/src/providers/postgres/qgspgsourceselect.cpp b/src/providers/postgres/qgspgsourceselect.cpp index 527a92aee7d..c858a979a34 100644 --- a/src/providers/postgres/qgspgsourceselect.cpp +++ b/src/providers/postgres/qgspgsourceselect.cpp @@ -38,7 +38,7 @@ email : sherman at mrcc.com #include #include -/** Used to create an editor for when the user tries to change the contents of a cell */ +//! Used to create an editor for when the user tries to change the contents of a cell QWidget *QgsPgSourceSelectDelegate::createEditor( QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index ) const { Q_UNUSED( option ); @@ -281,7 +281,7 @@ QgsPgSourceSelect::QgsPgSourceSelect( QWidget *parent, Qt::WindowFlags fl, bool mSearchModeLabel->setVisible( false ); mSearchTableEdit->setVisible( false ); } -/** Autoconnected SLOTS **/ +//! Autoconnected SLOTS * // Slot for adding a new connection void QgsPgSourceSelect::on_btnNew_clicked() { @@ -339,7 +339,7 @@ void QgsPgSourceSelect::on_btnEdit_clicked() delete nc; } -/** End Autoconnected SLOTS **/ +//! End Autoconnected SLOTS * // Remember which database is selected void QgsPgSourceSelect::on_cmbConnections_currentIndexChanged( const QString & text ) diff --git a/src/providers/postgres/qgspgtablemodel.h b/src/providers/postgres/qgspgtablemodel.h index 784b043b7c9..11f9bbc9a07 100644 --- a/src/providers/postgres/qgspgtablemodel.h +++ b/src/providers/postgres/qgspgtablemodel.h @@ -33,13 +33,13 @@ class QgsPgTableModel : public QStandardItemModel QgsPgTableModel(); ~QgsPgTableModel(); - /** Adds entry for one database table to the model*/ + //! Adds entry for one database table to the model void addTableEntry( const QgsPostgresLayerProperty& property ); - /** Sets an sql statement that belongs to a cell specified by a model index*/ + //! Sets an sql statement that belongs to a cell specified by a model index void setSql( const QModelIndex& index, const QString& sql ); - /** Returns the number of tables in the model*/ + //! Returns the number of tables in the model int tableCount() const { return mTableCount; } enum columns @@ -64,7 +64,7 @@ class QgsPgTableModel : public QStandardItemModel static QIcon iconForWkbType( QgsWkbTypes::Type type ); private: - /** Number of tables in the model*/ + //! Number of tables in the model int mTableCount; }; diff --git a/src/providers/postgres/qgspostgresconn.h b/src/providers/postgres/qgspostgresconn.h index c33130c97e3..933f78e3b6a 100644 --- a/src/providers/postgres/qgspostgresconn.h +++ b/src/providers/postgres/qgspostgresconn.h @@ -35,7 +35,7 @@ extern "C" class QgsField; -/** Spatial column types */ +//! Spatial column types enum QgsPostgresGeometryColumnType { sctNone, @@ -55,7 +55,7 @@ enum QgsPostgresPrimaryKeyType pktFidMap }; -/** Schema properties structure */ +//! Schema properties structure struct QgsPostgresSchemaProperty { QString name; @@ -63,7 +63,7 @@ struct QgsPostgresSchemaProperty QString owner; }; -/** Layer Property structure */ +//! Layer Property structure // TODO: Fill to Postgres/PostGIS specifications struct QgsPostgresLayerProperty { @@ -335,7 +335,7 @@ class QgsPostgresConn : public QObject static bool allowGeometrylessTables( const QString& theConnName ); static void deleteConnection( const QString& theConnName ); - /** A connection needs to be locked when it uses transactions, see QgsPostgresConn::{begin,commit,rollback} */ + //! A connection needs to be locked when it uses transactions, see QgsPostgresConn::{begin,commit,rollback} void lock() { mLock.lock(); } void unlock() { mLock.unlock(); } @@ -386,7 +386,7 @@ class QgsPostgresConn : public QObject static QMap sConnectionsRW; static QMap sConnectionsRO; - /** Count number of spatial columns in a given relation */ + //! Count number of spatial columns in a given relation void addColumnInfo( QgsPostgresLayerProperty& layerProperty, const QString& schemaName, const QString& viewName, bool fetchPkCandidates ); //! List of the supported layers diff --git a/src/providers/postgres/qgspostgresconnpool.h b/src/providers/postgres/qgspostgresconnpool.h index a3ae398c03e..83344155872 100644 --- a/src/providers/postgres/qgspostgresconnpool.h +++ b/src/providers/postgres/qgspostgresconnpool.h @@ -64,7 +64,7 @@ class QgsPostgresConnPoolGroup : public QObject, public QgsConnectionPoolGroup { public: diff --git a/src/providers/postgres/qgspostgresdataitems.h b/src/providers/postgres/qgspostgresdataitems.h index 96d11383857..870e6cda705 100644 --- a/src/providers/postgres/qgspostgresdataitems.h +++ b/src/providers/postgres/qgspostgresdataitems.h @@ -111,7 +111,7 @@ class QgsPGLayerItem : public QgsLayerItem virtual QList actions() override; - /** Returns comments of the layer */ + //! Returns comments of the layer virtual QString comments() const override; public slots: diff --git a/src/providers/postgres/qgspostgresprovider.cpp b/src/providers/postgres/qgspostgresprovider.cpp index 2cca87a975f..0b600accf26 100644 --- a/src/providers/postgres/qgspostgresprovider.cpp +++ b/src/providers/postgres/qgspostgresprovider.cpp @@ -651,7 +651,7 @@ QString QgsPostgresProvider::dataComment() const } -/** @todo XXX Perhaps this should be promoted to QgsDataProvider? */ +//! @todo XXX Perhaps this should be promoted to QgsDataProvider? QString QgsPostgresProvider::endianString() { switch ( QgsApplication::endian() ) diff --git a/src/providers/postgres/qgspostgresprovider.h b/src/providers/postgres/qgspostgresprovider.h index d1c46c808da..eb90e2d770d 100644 --- a/src/providers/postgres/qgspostgresprovider.h +++ b/src/providers/postgres/qgspostgresprovider.h @@ -207,12 +207,12 @@ class QgsPostgresProvider : public QgsVectorDataProvider QString subsetString() const override; - /** Mutator for sql where clause used to limit dataset size */ + //! Mutator for sql where clause used to limit dataset size bool setSubsetString( const QString& theSQL, bool updateFeatureCount = true ) override; virtual bool supportsSubsetString() const override { return true; } - /** Returns a bitmask containing the supported capabilities*/ + //! Returns a bitmask containing the supported capabilities QgsVectorDataProvider::Capabilities capabilities() const override; /** The Postgres provider does its own transforms so we return @@ -330,7 +330,7 @@ class QgsPostgresProvider : public QgsVectorDataProvider */ void setEditorWidgets(); - /** Convert a QgsField to work with PG */ + //! Convert a QgsField to work with PG static bool convertField( QgsField &field, const QMap *options = nullptr ); /** Parses the enum_range of an attribute and inserts the possible values into a stringlist @@ -362,7 +362,7 @@ class QgsPostgresProvider : public QgsVectorDataProvider */ static QList searchLayers( const QList& layers, const QString& connectionInfo, const QString& schema, const QString& tableName ); - /** Old-style mapping of index to name for QgsPalLabeling fix */ + //! Old-style mapping of index to name for QgsPalLabeling fix QgsAttrPalIndexNameHash mAttrPalIndexName; QgsFields mAttributeFields; @@ -496,7 +496,7 @@ class QgsPostgresProvider : public QgsVectorDataProvider }; -/** Assorted Postgres utility functions */ +//! Assorted Postgres utility functions class QgsPostgresUtils { public: diff --git a/src/providers/spatialite/qgsspatialiteconnection.h b/src/providers/spatialite/qgsspatialiteconnection.h index be6f55a938b..7cdecef6525 100644 --- a/src/providers/spatialite/qgsspatialiteconnection.h +++ b/src/providers/spatialite/qgsspatialiteconnection.h @@ -29,7 +29,7 @@ class QgsSpatiaLiteConnection : public QObject { Q_OBJECT public: - /** Construct a connection. Name can be either stored connection name or a path to the database file */ + //! Construct a connection. Name can be either stored connection name or a path to the database file explicit QgsSpatiaLiteConnection( const QString& name ); QString path() { return mPath; } @@ -68,13 +68,13 @@ class QgsSpatiaLiteConnection : public QObject Error fetchTables( bool loadGeometrylessTables ); - /** Return list of tables. fetchTables() function has to be called before */ + //! Return list of tables. fetchTables() function has to be called before QList tables() { return mTables; } - /** Return additional error message (if an error occurred before) */ + //! Return additional error message (if an error occurred before) QString errorMessage() { return mErrorMsg; } - /** Updates the Internal Statistics*/ + //! Updates the Internal Statistics bool updateStatistics(); protected: @@ -82,7 +82,7 @@ class QgsSpatiaLiteConnection : public QObject sqlite3 *openSpatiaLiteDb( const QString& path ); void closeSpatiaLiteDb( sqlite3 * handle ); - /** Checks if geometry_columns and spatial_ref_sys exist and have expected layout*/ + //! Checks if geometry_columns and spatial_ref_sys exist and have expected layout int checkHasMetadataTables( sqlite3* handle ); /** Inserts information about the spatial tables into mTables @@ -103,22 +103,22 @@ class QgsSpatiaLiteConnection : public QObject bool getTableInfoAbstractInterface( sqlite3 * handle, bool loadGeometrylessTables ); #endif - /** Cleaning well-formatted SQL strings*/ + //! Cleaning well-formatted SQL strings QString quotedValue( QString value ) const; - /** Checks if geometry_columns_auth table exists*/ + //! Checks if geometry_columns_auth table exists bool checkGeometryColumnsAuth( sqlite3 * handle ); - /** Checks if views_geometry_columns table exists*/ + //! Checks if views_geometry_columns table exists bool checkViewsGeometryColumns( sqlite3 * handle ); - /** Checks if virts_geometry_columns table exists*/ + //! Checks if virts_geometry_columns table exists bool checkVirtsGeometryColumns( sqlite3 * handle ); - /** Checks if this layer has been declared HIDDEN*/ + //! Checks if this layer has been declared HIDDEN bool isDeclaredHidden( sqlite3 * handle, const QString& table, const QString& geom ); - /** Checks if this layer is a RasterLite-1 datasource*/ + //! Checks if this layer is a RasterLite-1 datasource bool isRasterlite1Datasource( sqlite3 * handle, const char * table ); QString mErrorMsg; diff --git a/src/providers/spatialite/qgsspatialiteconnpool.h b/src/providers/spatialite/qgsspatialiteconnpool.h index 1266d06be02..436500eb01c 100644 --- a/src/providers/spatialite/qgsspatialiteconnpool.h +++ b/src/providers/spatialite/qgsspatialiteconnpool.h @@ -65,7 +65,7 @@ class QgsSpatiaLiteConnPoolGroup : public QObject, public QgsConnectionPoolGroup }; -/** SpatiaLite connection pool - singleton */ +//! SpatiaLite connection pool - singleton class QgsSpatiaLiteConnPool : public QgsConnectionPool { static QgsSpatiaLiteConnPool sInstance; diff --git a/src/providers/spatialite/qgsspatialitefeatureiterator.h b/src/providers/spatialite/qgsspatialitefeatureiterator.h index f660064e957..5b914465cf2 100644 --- a/src/providers/spatialite/qgsspatialitefeatureiterator.h +++ b/src/providers/spatialite/qgsspatialitefeatureiterator.h @@ -94,7 +94,7 @@ class QgsSpatiaLiteFeatureIterator : public QgsAbstractFeatureIteratorFromSource */ sqlite3_stmt *sqliteStatement; - /** Geometry column index used when fetching geometry */ + //! Geometry column index used when fetching geometry int mGeomColIdx; //! Set to true, if geometry is in the requested columns diff --git a/src/providers/spatialite/qgsspatialiteprovider.h b/src/providers/spatialite/qgsspatialiteprovider.h index 09a37d6b6fd..228cb0866f8 100644 --- a/src/providers/spatialite/qgsspatialiteprovider.h +++ b/src/providers/spatialite/qgsspatialiteprovider.h @@ -55,7 +55,7 @@ class QgsSpatiaLiteProvider: public QgsVectorDataProvider Q_OBJECT public: - /** Import a vector layer into the database */ + //! Import a vector layer into the database static QgsVectorLayerImport::ImportError createEmptyLayer( const QString& uri, const QgsFields &fields, @@ -92,7 +92,7 @@ class QgsSpatiaLiteProvider: public QgsVectorDataProvider virtual QString subsetString() const override; - /** Mutator for sql where clause used to limit dataset size */ + //! Mutator for sql where clause used to limit dataset size virtual bool setSubsetString( const QString& theSQL, bool updateFeatureCount = true ) override; virtual bool supportsSubsetString() const override { return true; } @@ -162,7 +162,7 @@ class QgsSpatiaLiteProvider: public QgsVectorDataProvider */ bool changeGeometryValues( const QgsGeometryMap &geometry_map ) override; - /** Returns a bitmask containing the supported capabilities*/ + //! Returns a bitmask containing the supported capabilities QgsVectorDataProvider::Capabilities capabilities() const override; /** The SpatiaLite provider does its own transforms so we return diff --git a/src/providers/spatialite/qgsspatialitesourceselect.cpp b/src/providers/spatialite/qgsspatialitesourceselect.cpp index 5f80ed6f51e..c54723a2664 100644 --- a/src/providers/spatialite/qgsspatialitesourceselect.cpp +++ b/src/providers/spatialite/qgsspatialitesourceselect.cpp @@ -127,7 +127,7 @@ void QgsSpatiaLiteSourceSelect::addClicked() addTables(); } -/** End Autoconnected SLOTS **/ +//! End Autoconnected SLOTS * // Remember which database is selected void QgsSpatiaLiteSourceSelect::on_cmbConnections_activated( int ) diff --git a/src/providers/spatialite/qgsspatialitetablemodel.h b/src/providers/spatialite/qgsspatialitetablemodel.h index bb4a40722fc..495c713a7d3 100644 --- a/src/providers/spatialite/qgsspatialitetablemodel.h +++ b/src/providers/spatialite/qgsspatialitetablemodel.h @@ -28,31 +28,31 @@ class QgsSpatiaLiteTableModel: public QStandardItemModel QgsSpatiaLiteTableModel(); ~QgsSpatiaLiteTableModel(); - /** Adds entry for one database table to the model*/ + //! Adds entry for one database table to the model void addTableEntry( const QString& type, const QString& tableName, const QString& geometryColName, const QString& sql ); - /** Sets an sql statement that belongs to a cell specified by a model index*/ + //! Sets an sql statement that belongs to a cell specified by a model index void setSql( const QModelIndex& index, const QString& sql ); /** Sets one or more geometry types to a row. In case of several types, additional rows are inserted. This is for tables where the type is dectected later by thread*/ void setGeometryTypesForTable( const QString & table, const QString & attribute, const QString & type ); - /** Returns the number of tables in the model*/ + //! Returns the number of tables in the model int tableCount() const { return mTableCount; } - /** Sets the SQLite DB full path*/ + //! Sets the SQLite DB full path void setSqliteDb( const QString & dbName ) { mSqliteDb = dbName; } private: - /** Number of tables in the model*/ + //! Number of tables in the model int mTableCount; QString mSqliteDb; QIcon iconForType( QgsWkbTypes::Type type ) const; QString displayStringForType( QgsWkbTypes::Type type ) const; - /** Returns qgis wkbtype from database typename*/ + //! Returns qgis wkbtype from database typename QgsWkbTypes::Type qgisTypeFromDbType( const QString & dbType ) const; }; diff --git a/src/providers/virtual/qgsembeddedlayerselectdialog.h b/src/providers/virtual/qgsembeddedlayerselectdialog.h index b9802a8b0f8..6187962563a 100644 --- a/src/providers/virtual/qgsembeddedlayerselectdialog.h +++ b/src/providers/virtual/qgsembeddedlayerselectdialog.h @@ -33,7 +33,7 @@ class QgsEmbeddedLayerSelectDialog : public QDialog, private Ui::QgsEmbeddedLaye public: QgsEmbeddedLayerSelectDialog( QWidget * parent, QgsLayerTreeView* tv ); - /** Returns the list of layer ids selected */ + //! Returns the list of layer ids selected QStringList layers() const; }; diff --git a/src/providers/virtual/qgsvirtuallayerprovider.h b/src/providers/virtual/qgsvirtuallayerprovider.h index cbb23f090cc..a5426f35d9f 100644 --- a/src/providers/virtual/qgsvirtuallayerprovider.h +++ b/src/providers/virtual/qgsvirtuallayerprovider.h @@ -36,29 +36,29 @@ class QgsVirtualLayerProvider: public QgsVectorDataProvider */ explicit QgsVirtualLayerProvider( QString const &uri = "" ); - /** Destructor */ + //! Destructor virtual ~QgsVirtualLayerProvider(); virtual QgsAbstractFeatureSource* featureSource() const override; - /** Returns the permanent storage type for this layer as a friendly name */ + //! Returns the permanent storage type for this layer as a friendly name virtual QString storageType() const override; virtual QgsCoordinateReferenceSystem crs() const override; virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest& request ) const override; - /** Get the feature geometry type */ + //! Get the feature geometry type QgsWkbTypes::Type wkbType() const override; - /** Get the number of features in the layer */ + //! Get the number of features in the layer long featureCount() const override; virtual QgsRectangle extent() const override; virtual QString subsetString() const override; - /** Set the subset string used to create a subset of features in the layer (WHERE clause) */ + //! Set the subset string used to create a subset of features in the layer (WHERE clause) virtual bool setSubsetString( const QString& subset, bool updateFeatureCount = true ) override; virtual bool supportsSubsetString() const override { return true; } @@ -67,18 +67,18 @@ class QgsVirtualLayerProvider: public QgsVectorDataProvider bool isValid() const override; - /** Returns a bitmask containing the supported capabilities*/ + //! Returns a bitmask containing the supported capabilities QgsVectorDataProvider::Capabilities capabilities() const override; - /** Return the provider name */ + //! Return the provider name QString name() const override; - /** Return description */ + //! Return description QString description() const override; QgsAttributeList pkAttributeIndexes() const override; - /** Get the list of layer ids on which this layer depends */ + //! Get the list of layer ids on which this layer depends QSet dependencies() const override; private: diff --git a/src/providers/virtual/qgsvirtuallayersourceselect.h b/src/providers/virtual/qgsvirtuallayersourceselect.h index 0032d7b7dad..38c27a98d59 100644 --- a/src/providers/virtual/qgsvirtuallayersourceselect.h +++ b/src/providers/virtual/qgsvirtuallayersourceselect.h @@ -46,9 +46,9 @@ class QgsVirtualLayerSourceSelect : public QDialog, private Ui::QgsVirtualLayerS void onTableRowChanged( const QModelIndex& current, const QModelIndex& previous ); signals: - /** Source, name, provider */ + //! Source, name, provider void addVectorLayer( QString, QString, QString ); - /** Old_id, source, name, provider */ + //! Old_id, source, name, provider void replaceVectorLayer( QString, QString, QString, QString ); private: diff --git a/src/providers/wcs/qgswcscapabilities.h b/src/providers/wcs/qgswcscapabilities.h index edfce9a9aaa..4b350fad34f 100644 --- a/src/providers/wcs/qgswcscapabilities.h +++ b/src/providers/wcs/qgswcscapabilities.h @@ -34,7 +34,7 @@ class QNetworkAccessManager; class QNetworkReply; -/** CoverageSummary structure */ +//! CoverageSummary structure struct QgsWcsCoverageSummary { QgsWcsCoverageSummary() @@ -70,7 +70,7 @@ struct QgsWcsCoverageSummary bool hasSize; }; -/** Capability Property structure */ +//! Capability Property structure struct QgsWcsCapabilitiesProperty { QString version; @@ -138,13 +138,13 @@ class QgsWcsCapabilities : public QObject * \param version optional version, e.g. 1.0.0 or 1.1.0 */ QString getCapabilitiesUrl( const QString& version ) const; - /** \brief Returns the GetCoverage full url using current version */ + //! \brief Returns the GetCoverage full url using current version QString getCapabilitiesUrl() const; - /** \brief Returns the GetCoverage full full url using current version */ + //! \brief Returns the GetCoverage full full url using current version QString getDescribeCoverageUrl( QString const &identifier ) const; - /** Returns the GetCoverage base url */ + //! Returns the GetCoverage base url QString getCoverageUrl() const; //! Send request to server @@ -209,17 +209,17 @@ class QgsWcsCapabilities : public QObject * NS is ignored. Example path: domainSet.spatialDomain.RectifiedGrid */ static QDomElement domElement( const QDomElement &element, const QString &path ); - /** Get text of element specified by path */ + //! Get text of element specified by path static QString domElementText( const QDomElement &element, const QString &path ); - /** Get sub elements texts by path */ + //! Get sub elements texts by path static QStringList domElementsTexts( const QDomElement &element, const QString &path ); signals: - /** \brief emit a signal to notify of a progress event */ + //! \brief emit a signal to notify of a progress event void progressChanged( int theProgress, int theTotalSteps ); - /** \brief emit a signal to be caught by qgisapp and display a msg on status bar */ + //! \brief emit a signal to be caught by qgisapp and display a msg on status bar void statusChanged( QString const & theStatusQString ); void downloadFinished(); @@ -260,7 +260,7 @@ class QgsWcsCapabilities : public QObject */ bool retrieveServerCapabilities( const QString& preferredVersion ); - /** Retrieve the best WCS version supported by server and QGIS */ + //! Retrieve the best WCS version supported by server and QGIS bool retrieveServerCapabilities(); //! \return false if the capabilities document could not be parsed - see lastError() for more info diff --git a/src/providers/wcs/qgswcsprovider.h b/src/providers/wcs/qgswcsprovider.h index 3fb3e5580cc..91ac010a630 100644 --- a/src/providers/wcs/qgswcsprovider.h +++ b/src/providers/wcs/qgswcsprovider.h @@ -159,7 +159,7 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase void readBlock( int theBandNo, int xBlock, int yBlock, void *block ) override; - /** Download cache */ + //! Download cache void getCache( int bandNo, QgsRectangle const & viewExtent, int width, int height, QString crs = QString(), QgsRasterBlockFeedback* feedback = nullptr ) const; virtual QgsRectangle extent() const override; @@ -207,7 +207,7 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase signals: - /** \brief emit a signal to notify of a progress event */ + //! \brief emit a signal to notify of a progress event void progressChanged( int theProgress, int theTotalSteps ); void dataChanged(); @@ -278,32 +278,32 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase */ bool mValid; - /** Server capabilities */ + //! Server capabilities QgsWcsCapabilities mCapabilities; - /** Coverage summary */ + //! Coverage summary QgsWcsCoverageSummary mCoverageSummary; - /** Spatial reference id of the layer */ + //! Spatial reference id of the layer QString mSrid; - /** Rectangle that contains the extent (bounding box) of the layer */ + //! Rectangle that contains the extent (bounding box) of the layer mutable QgsRectangle mCoverageExtent; - /** Coverage width, may be 0 if it could not be found in DescribeCoverage */ + //! Coverage width, may be 0 if it could not be found in DescribeCoverage int mWidth; - /** Coverage width, may be 0 if it could not be found in DescribeCoverage */ + //! Coverage width, may be 0 if it could not be found in DescribeCoverage int mHeight; - /** Block size */ + //! Block size int mXBlockSize; int mYBlockSize; - /** Flag if size was parsed successfully */ + //! Flag if size was parsed successfully bool mHasSize; - /** Number of bands */ + //! Number of bands int mBandCount; /** \brief Gdal data types used to represent data in in QGIS, @@ -311,13 +311,13 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase indexed from 0 */ QList mGdalDataType; - /** GDAL source data types, indexed from 0 */ + //! GDAL source data types, indexed from 0 QList mSrcGdalDataType; - /** \brief Cell value representing no data. e.g. -9999, indexed from 0 */ + //! \brief Cell value representing no data. e.g. -9999, indexed from 0 //QList mNoDataValue; - /** Color tables indexed from 0 */ + //! Color tables indexed from 0 QList< QList > mColorTables; /** @@ -336,14 +336,14 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase */ QMap mQueryableForLayer; - /** Coverage CRS used for requests in Auth */ + //! Coverage CRS used for requests in Auth // TODO: use QgsCoordinateReferenceSystem ? QString mCoverageCrs; - /** Cached data */ + //! Cached data mutable QByteArray mCachedData; - /** Name of memory file for cached data */ + //! Name of memory file for cached data QString mCachedMemFilename; #if defined(GDAL_VERSION_NUM) && GDAL_VERSION_NUM >= 1800 @@ -352,29 +352,29 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase mutable FILE * mCachedMemFile; #endif - /** Pointer to cached GDAL dataset */ + //! Pointer to cached GDAL dataset mutable GDALDatasetH mCachedGdalDataset; - /** Current cache error last getCache() error. */ + //! Current cache error last getCache() error. mutable QgsError mCachedError; - /** The previous parameters to draw(). */ + //! The previous parameters to draw(). mutable QgsRectangle mCachedViewExtent; mutable int mCachedViewWidth; mutable int mCachedViewHeight; - /** Maximum width and height of getmap requests */ + //! Maximum width and height of getmap requests int mMaxWidth; int mMaxHeight; - /** The error caption associated with the last WCS error. */ + //! The error caption associated with the last WCS error. QString mErrorCaption; - /** The error message associated with the last WCS error. */ + //! The error message associated with the last WCS error. QString mError; - /** The mime type of the message */ + //! The mime type of the message QString mErrorFormat; //! A QgsCoordinateTransform is used for transformation of WCS layer extents @@ -416,7 +416,7 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase }; -/** Handler for downloading of coverage data - output is written to mCachedData */ +//! Handler for downloading of coverage data - output is written to mCachedData class QgsWcsDownloadHandler : public QObject { Q_OBJECT diff --git a/src/providers/wfs/qgswfscapabilities.h b/src/providers/wfs/qgswfscapabilities.h index cb056e1fcc1..9e3a029a72f 100644 --- a/src/providers/wfs/qgswfscapabilities.h +++ b/src/providers/wfs/qgswfscapabilities.h @@ -21,7 +21,7 @@ #include "qgsrectangle.h" #include "qgswfsrequest.h" -/** Manages the GetCapabilities request */ +//! Manages the GetCapabilities request class QgsWfsCapabilities : public QgsWfsRequest { Q_OBJECT @@ -123,7 +123,7 @@ class QgsWfsCapabilities : public QgsWfsRequest private: Capabilities mCaps; - /** Takes element and updates the capabilities*/ + //! Takes element and updates the capabilities void parseSupportedOperations( const QDomElement& operationsElem, bool& insertCap, bool& updateCap, diff --git a/src/providers/wfs/qgswfsdatasourceuri.h b/src/providers/wfs/qgswfsdatasourceuri.h index cd934eff8db..1b805b00514 100644 --- a/src/providers/wfs/qgswfsdatasourceuri.h +++ b/src/providers/wfs/qgswfsdatasourceuri.h @@ -75,67 +75,67 @@ class QgsWFSDataSourceURI explicit QgsWFSDataSourceURI( const QString& uri ); - /** Return the URI, avoiding expansion of authentication configuration, which is handled during network access */ + //! Return the URI, avoiding expansion of authentication configuration, which is handled during network access const QString uri( bool expandAuthConfig = false ) const; - /** Return base URL (with SERVICE=WFS parameter if bIncludeServiceWFS=true) */ + //! Return base URL (with SERVICE=WFS parameter if bIncludeServiceWFS=true) QUrl baseURL( bool bIncludeServiceWFS = true ) const; - /** Get WFS version. Can be auto, 1.0.0, 1.1.0 or 2.0.0. */ + //! Get WFS version. Can be auto, 1.0.0, 1.1.0 or 2.0.0. QString version() const; - /** Return user defined limit of features to download. 0=no limitation */ + //! Return user defined limit of features to download. 0=no limitation int maxNumFeatures() const; - /** Set user defined limit of features to download */ + //! Set user defined limit of features to download void setMaxNumFeatures( int maxNumFeatures ); - /** Get typename (with prefix) */ + //! Get typename (with prefix) QString typeName() const; - /** Set typename (with prefix)*/ + //! Set typename (with prefix) void setTypeName( const QString& typeName ); - /** Get SRS name (in the normalized form EPSG:xxxx) */ + //! Get SRS name (in the normalized form EPSG:xxxx) QString SRSName() const; - /** Set SRS name (in the normalized form EPSG:xxxx) */ + //! Set SRS name (in the normalized form EPSG:xxxx) void setSRSName( const QString& crsString ); - /** Set version */ + //! Set version void setVersion( const QString& versionString ); - /** Get OGC filter xml or a QGIS expression */ + //! Get OGC filter xml or a QGIS expression QString filter() const; - /** Set OGC filter xml or a QGIS expression */ + //! Set OGC filter xml or a QGIS expression void setFilter( const QString& filterIn ); - /** Get SQL query */ + //! Get SQL query QString sql() const; - /** Set SQL query */ + //! Set SQL query void setSql( const QString& sql ); - /** Returns whether GetFeature request should include the request bounding box. Defaults to false */ + //! Returns whether GetFeature request should include the request bounding box. Defaults to false bool isRestrictedToRequestBBOX() const; - /** Returns whether axis orientation should be ignored (for WFS >= 1.1). Defaults to false */ + //! Returns whether axis orientation should be ignored (for WFS >= 1.1). Defaults to false bool ignoreAxisOrientation() const; - /** Returns whether axis orientation should be inverted. Defaults to false */ + //! Returns whether axis orientation should be inverted. Defaults to false bool invertAxisOrientation() const; - /** For debug purposes. Checks that functions used in sql match functions declared by the server. Defaults to false */ + //! For debug purposes. Checks that functions used in sql match functions declared by the server. Defaults to false bool validateSqlFunctions() const; - /** Whether to hide download progress dialog in QGIS main app. Defaults to false */ + //! Whether to hide download progress dialog in QGIS main app. Defaults to false bool hideDownloadProgressDialog() const; - /** Return authorization parameters */ + //! Return authorization parameters QgsWFSAuthorization& auth() { return mAuth; } - /** Builds a derived uri from a base uri */ + //! Builds a derived uri from a base uri static QString build( const QString& uri, const QString& typeName, const QString& crsString = QString(), diff --git a/src/providers/wfs/qgswfsdescribefeaturetype.h b/src/providers/wfs/qgswfsdescribefeaturetype.h index 2a5a8f6f3c3..16e82489118 100644 --- a/src/providers/wfs/qgswfsdescribefeaturetype.h +++ b/src/providers/wfs/qgswfsdescribefeaturetype.h @@ -17,14 +17,14 @@ #include "qgswfsrequest.h" -/** Manages the DescribeFeatureType request */ +//! Manages the DescribeFeatureType request class QgsWFSDescribeFeatureType : public QgsWfsRequest { Q_OBJECT public: explicit QgsWFSDescribeFeatureType( const QString& theUri ); - /** Issue the request */ + //! Issue the request bool requestFeatureType( const QString& WFSVersion, const QString& typeName ); protected: diff --git a/src/providers/wfs/qgswfsfeatureiterator.h b/src/providers/wfs/qgswfsfeatureiterator.h index a78c63c7c71..ff88e54dbb7 100644 --- a/src/providers/wfs/qgswfsfeatureiterator.h +++ b/src/providers/wfs/qgswfsfeatureiterator.h @@ -33,7 +33,7 @@ class QProgressDialog; typedef QPair QgsWFSFeatureGmlIdPair; -/** Utility class to issue a GetFeature resultType=hits request */ +//! Utility class to issue a GetFeature resultType=hits request class QgsWFSFeatureHitsAsyncRequest: public QgsWfsRequest { Q_OBJECT @@ -43,7 +43,7 @@ class QgsWFSFeatureHitsAsyncRequest: public QgsWfsRequest void launch( const QUrl& url ); - /** Return result of request, or -1 if not known/error */ + //! Return result of request, or -1 if not known/error int numberMatched() const { return mNumberMatched; } signals: @@ -60,12 +60,12 @@ class QgsWFSFeatureHitsAsyncRequest: public QgsWfsRequest }; -/** Utility class for QgsWFSFeatureDownloader */ +//! Utility class for QgsWFSFeatureDownloader class QgsWFSProgressDialog: public QProgressDialog { Q_OBJECT public: - /** Constructor */ + //! Constructor QgsWFSProgressDialog( const QString & labelText, const QString & cancelButtonText, int minimum, int maximum, QWidget * parent ); void resizeEvent( QResizeEvent * ev ) override; @@ -101,23 +101,23 @@ class QgsWFSFeatureDownloader: public QgsWfsRequest void run( bool serializeFeatures, int maxFeatures ); public slots: - /** To interrupt the download. Thread-safe */ + //! To interrupt the download. Thread-safe void stop(); signals: - /** Emitted when new features have been received */ + //! Emitted when new features have been received void featureReceived( QVector ); - /** Emitted when new features have been received */ + //! Emitted when new features have been received void featureReceived( int featureCount ); - /** Emitted when the download is finished (successful or not) */ + //! Emitted when the download is finished (successful or not) void endOfDownload( bool success ); - /** Used internally by the stop() method */ + //! Used internally by the stop() method void doStop(); - /** Emitted with the total accumulated number of features downloaded. */ + //! Emitted with the total accumulated number of features downloaded. void updateProgress( int totalFeatureCount ); protected: @@ -135,11 +135,11 @@ class QgsWFSFeatureDownloader: public QgsWfsRequest void pushError( const QString& errorMsg ); QString sanitizeFilter( QString filter ); - /** Mutable data shared between provider, feature sources and downloader. */ + //! Mutable data shared between provider, feature sources and downloader. QgsWFSSharedData* mShared; - /** Whether the download should stop */ + //! Whether the download should stop bool mStop; - /** Progress dialog */ + //! Progress dialog QProgressDialog* mProgressDialog; /** If the progress dialog should be shown immediately, or if it should be let to QProgressDialog logic to decide when to show it */ @@ -153,7 +153,7 @@ class QgsWFSFeatureDownloader: public QgsWfsRequest int mTotalDownloadedFeatureCount; }; -/** Downloader thread */ +//! Downloader thread class QgsWFSThreadedFeatureDownloader: public QThread { Q_OBJECT @@ -161,18 +161,18 @@ class QgsWFSThreadedFeatureDownloader: public QThread explicit QgsWFSThreadedFeatureDownloader( QgsWFSSharedData* shared ); ~QgsWFSThreadedFeatureDownloader(); - /** Return downloader object */ + //! Return downloader object QgsWFSFeatureDownloader* downloader() { return mDownloader; } - /** Stops (synchronously) the download */ + //! Stops (synchronously) the download void stop(); signals: - /** Emitted when the thread is ready */ + //! Emitted when the thread is ready void ready(); protected: - /** Inherited from QThread. Starts the download */ + //! Inherited from QThread. Starts the download void run() override; private: @@ -200,7 +200,7 @@ class QgsWFSFeatureIterator : public QObject, void setInterruptionChecker( QgsInterruptionChecker* interruptionChecker ) override; - /** Used by QgsWFSSharedData::registerToCache() */ + //! Used by QgsWFSSharedData::registerToCache() void connectSignals( QObject* downloader ); private slots: @@ -213,12 +213,12 @@ class QgsWFSFeatureIterator : public QObject, bool fetchFeature( QgsFeature& f ) override; - /** Copies feature attributes / geometry from srcFeature to dstFeature*/ + //! Copies feature attributes / geometry from srcFeature to dstFeature void copyFeature( const QgsFeature& srcFeature, QgsFeature& dstFeature ); QSharedPointer mShared; //!< Mutable data shared between provider and feature sources - /** Subset of attributes (relatives to mShared->mFields) to fetch. Only valid if ( mRequest.flags() & QgsFeatureRequest::SubsetOfAttributes ) */ + //! Subset of attributes (relatives to mShared->mFields) to fetch. Only valid if ( mRequest.flags() & QgsFeatureRequest::SubsetOfAttributes ) QgsAttributeList mSubSetAttributes; bool mDownloadFinished; @@ -244,14 +244,14 @@ class QgsWFSFeatureIterator : public QObject, bool mFetchGeometry; }; -/** Feature source */ +//! Feature source class QgsWFSFeatureSource : public QgsAbstractFeatureSource { public: explicit QgsWFSFeatureSource( const QgsWFSProvider* p ); ~QgsWFSFeatureSource(); - /** Returns features matching the request */ + //! Returns features matching the request QgsFeatureIterator getFeatures( const QgsFeatureRequest& request ) override; protected: diff --git a/src/providers/wfs/qgswfsprovider.h b/src/providers/wfs/qgswfsprovider.h index cbe7d088f87..bc9d3c9d0a4 100644 --- a/src/providers/wfs/qgswfsprovider.h +++ b/src/providers/wfs/qgswfsprovider.h @@ -80,7 +80,7 @@ class QgsWFSProvider : public QgsVectorDataProvider virtual QString subsetString() const override; - /** Mutator for sql where clause used to limit dataset size */ + //! Mutator for sql where clause used to limit dataset size virtual bool setSubsetString( const QString& theSQL, bool updateFeatureCount = true ) override; virtual bool supportsSubsetString() const override { return true; } @@ -144,7 +144,7 @@ class QgsWFSProvider : public QgsVectorDataProvider void pushErrorSlot( const QString& errorMsg ); private: - /** Mutable data shared between provider and feature sources */ + //! Mutable data shared between provider and feature sources QSharedPointer mShared; friend class QgsWFSFeatureSource; @@ -154,15 +154,15 @@ class QgsWFSProvider : public QgsVectorDataProvider //! String used to define a subset of the layer QString mSubsetString; - /** Geometry type of the features in this layer*/ + //! Geometry type of the features in this layer mutable QgsWkbTypes::Type mWKBType; - /** Flag if provider is valid*/ + //! Flag if provider is valid bool mValid; - /** Namespace URL of the server (comes from DescribeFeatureDocument)*/ + //! Namespace URL of the server (comes from DescribeFeatureDocument) QString mApplicationNamespace; - /** Server capabilities for this layer (generated from capabilities document)*/ + //! Server capabilities for this layer (generated from capabilities document) QgsVectorDataProvider::Capabilities mCapabilities; - /** Fields of this typename. Might be different from mShared->mFields in case of SELECT */ + //! Fields of this typename. Might be different from mShared->mFields in case of SELECT QgsFields mThisTypenameFields; QString mProcessSQLErrorMsg; @@ -188,20 +188,20 @@ class QgsWFSProvider : public QgsVectorDataProvider note: true does not automatically mean that the transaction succeeded*/ bool sendTransactionDocument( const QDomDocument& doc, QDomDocument& serverResponse ); - /** Creates a transaction element and adds it (normally as first element) to the document*/ + //! Creates a transaction element and adds it (normally as first element) to the document QDomElement createTransactionElement( QDomDocument& doc ) const; - /** True if the server response means success*/ + //! True if the server response means success bool transactionSuccess( const QDomDocument& serverResponse ) const; - /** Returns the inserted ids*/ + //! Returns the inserted ids QStringList insertedFeatureIds( const QDomDocument& serverResponse ) const; - /** Retrieve version and capabilities for this layer from GetCapabilities document (will be stored in mCapabilites)*/ + //! Retrieve version and capabilities for this layer from GetCapabilities document (will be stored in mCapabilites) bool getCapabilities(); - /** Records provider error*/ + //! Records provider error void handleException( const QDomDocument& serverResponse ); - /** Converts DescribeFeatureType schema geometry property type to WKBType*/ + //! Converts DescribeFeatureType schema geometry property type to WKBType QgsWkbTypes::Type geomTypeFromPropertyType( const QString& attName, const QString& propType ); - /** Convert the value to its appropriate XML representation */ + //! Convert the value to its appropriate XML representation QString convertToXML( const QVariant& value ); bool processSQL( const QString& sqlString, QString& errorMsg, QString& warningMsg ); diff --git a/src/providers/wfs/qgswfsrequest.h b/src/providers/wfs/qgswfsrequest.h index 38706909cf8..6dfe312fcd5 100644 --- a/src/providers/wfs/qgswfsrequest.h +++ b/src/providers/wfs/qgswfsrequest.h @@ -22,7 +22,7 @@ #include "qgswfsdatasourceuri.h" -/** Abstract base class for a WFS request. */ +//! Abstract base class for a WFS request. class QgsWfsRequest : public QObject { Q_OBJECT @@ -31,10 +31,10 @@ class QgsWfsRequest : public QObject virtual ~QgsWfsRequest(); - /** \brief proceed to sending a GET request */ + //! \brief proceed to sending a GET request bool sendGET( const QUrl& url, bool synchronous, bool forceRefresh = false, bool cache = true ); - /** \brief proceed to sending a synchronous POST request */ + //! \brief proceed to sending a synchronous POST request bool sendPOST( const QUrl& url, const QString& contentTypeHeader, const QByteArray& data ); enum ErrorCode { NoError, @@ -45,24 +45,24 @@ class QgsWfsRequest : public QObject WFSVersionNotSupported }; - /** \brief Return error code (after download/post) */ + //! \brief Return error code (after download/post) ErrorCode errorCode() const { return mErrorCode; } - /** \brief Return error message (after download/post) */ + //! \brief Return error message (after download/post) const QString& errorMessage() const { return mErrorMessage; } - /** \brief Return server response (after download/post) */ + //! \brief Return server response (after download/post) const QByteArray& response() const { return mResponse; } public slots: - /** Abort network request immediately */ + //! Abort network request immediately void abort(); signals: - /** \brief emit a signal when data arrives */ + //! \brief emit a signal when data arrives void downloadProgress( qint64, qint64 ); - /** \brief emit a signal once the download is finished */ + //! \brief emit a signal once the download is finished void downloadFinished(); protected slots: @@ -71,31 +71,31 @@ class QgsWfsRequest : public QObject void requestTimedOut( QNetworkReply* reply ); protected: - /** URI */ + //! URI QgsWFSDataSourceURI mUri; - /** The reply to the request */ + //! The reply to the request QNetworkReply *mReply; - /** The error message associated with the last error. */ + //! The error message associated with the last error. QString mErrorMessage; - /** Error code */ + //! Error code ErrorCode mErrorCode; - /** Raw response */ + //! Raw response QByteArray mResponse; - /** Whether the request is aborted. */ + //! Whether the request is aborted. bool mIsAborted; - /** Whether to force refresh (i.e. issue a network request and not use cache) */ + //! Whether to force refresh (i.e. issue a network request and not use cache) bool mForceRefresh; - /** Whether the request has timed-out */ + //! Whether the request has timed-out bool mTimedout; - /** Whether we already received bytes */ + //! Whether we already received bytes bool mGotNonEmptyResponse; protected: @@ -107,7 +107,7 @@ class QgsWfsRequest : public QObject (possibly translated, but sometimes coming from server) reason */ virtual QString errorMessageWithReason( const QString& reason ) = 0; - /** Return experiation delay in second */ + //! Return experiation delay in second virtual int defaultExpirationInSec() { return 0; } private: diff --git a/src/providers/wfs/qgswfsshareddata.cpp b/src/providers/wfs/qgswfsshareddata.cpp index 45200f1ea01..68dcba09aee 100644 --- a/src/providers/wfs/qgswfsshareddata.cpp +++ b/src/providers/wfs/qgswfsshareddata.cpp @@ -975,7 +975,7 @@ void QgsWFSSharedData::pushError( const QString& errorMsg ) emit raiseError( errorMsg ); } -/** Called by QgsWFSFeatureDownloader::run() at the end of the download process. */ +//! Called by QgsWFSFeatureDownloader::run() at the end of the download process. void QgsWFSSharedData::endOfDownload( bool success, int featureCount, bool truncatedResponse, bool interrupted, diff --git a/src/providers/wfs/qgswfsshareddata.h b/src/providers/wfs/qgswfsshareddata.h index aecc4698b7d..e49558817ae 100644 --- a/src/providers/wfs/qgswfsshareddata.h +++ b/src/providers/wfs/qgswfsshareddata.h @@ -63,55 +63,55 @@ class QgsWFSSharedData : public QObject the cache. Also used by a WFS-T insert operation */ void serializeFeatures( QVector& featureList ); - /** Called by QgsWFSFeatureDownloader::run() at the end of the download process. */ + //! Called by QgsWFSFeatureDownloader::run() at the end of the download process. void endOfDownload( bool success, int featureCount, bool truncatedResponse, bool interrupted, const QString &errorMsg ); /** Used by QgsWFSProvider::reloadData(). The effect is to invalid all the caching state, so that a new request results in fresh download */ void invalidateCache(); - /** Give a feature id, find the correspond fid/gml.id. Used by WFS-T */ + //! Give a feature id, find the correspond fid/gml.id. Used by WFS-T QString findGmlId( QgsFeatureId fid ); - /** Delete from the on-disk cache the features of given fid. Used by WFS-T */ + //! Delete from the on-disk cache the features of given fid. Used by WFS-T bool deleteFeatures( const QgsFeatureIds& fidlist ); - /** Change into the on-disk cache the passed geometries. Used by WFS-T */ + //! Change into the on-disk cache the passed geometries. Used by WFS-T bool changeGeometryValues( const QgsGeometryMap &geometry_map ); - /** Change into the on-disk cache the passed attributes. Used by WFS-T */ + //! Change into the on-disk cache the passed attributes. Used by WFS-T bool changeAttributeValues( const QgsChangedAttributesMap &attr_map ); - /** Force an update of the feature count */ + //! Force an update of the feature count void setFeatureCount( int featureCount ); - /** Return layer feature count. Might issue a GetFeature resultType=hits request */ + //! Return layer feature count. Might issue a GetFeature resultType=hits request int getFeatureCount( bool issueRequestIfNeeded = true ); - /** Return whether the feature count is exact, or approximate/transient */ + //! Return whether the feature count is exact, or approximate/transient bool isFeatureCountExact() const { return mFeatureCountExact; } - /** Return whether the server support RESULTTYPE=hits */ + //! Return whether the server support RESULTTYPE=hits bool supportsHits() const { return mCaps.supportsHits; } - /** Compute WFS filter from the sql or filter in the URI */ + //! Compute WFS filter from the sql or filter in the URI bool computeFilter( QString& errorMsg ); - /** Return extent computed from currently downloaded features */ + //! Return extent computed from currently downloaded features QgsRectangle computedExtent(); - /** Return srsName */ + //! Return srsName QString srsName() const; - /** Return whether the feature download is finished */ + //! Return whether the feature download is finished bool downloadFinished() const { return mDownloadFinished; } signals: - /** Raise error */ + //! Raise error void raiseError( const QString& errorMsg ); - /** Extent has been updated */ + //! Extent has been updated void extentUpdated(); protected: @@ -120,55 +120,55 @@ class QgsWFSSharedData : public QObject friend class QgsWFSProvider; friend class QgsWFSSingleFeatureRequest; - /** Datasource URI */ + //! Datasource URI QgsWFSDataSourceURI mURI; - /** WFS version to use. Comes from GetCapabilities response */ + //! WFS version to use. Comes from GetCapabilities response QString mWFSVersion; - /** Source CRS*/ + //! Source CRS QgsCoordinateReferenceSystem mSourceCRS; - /** Attribute fields of the layer */ + //! Attribute fields of the layer QgsFields mFields; - /** Name of geometry attribute */ + //! Name of geometry attribute QString mGeometryAttribute; - /** Layer properties */ + //! Layer properties QList< QgsOgcUtils::LayerProperties > mLayerPropertiesList; - /** Map a field name to the pair (typename, fieldname) that describes its source field */ + //! Map a field name to the pair (typename, fieldname) that describes its source field QMap< QString, QPair > mMapFieldNameToSrcLayerNameFieldName; - /** The data provider of the on-disk cache */ + //! The data provider of the on-disk cache QgsVectorDataProvider* mCacheDataProvider; - /** Current BBOX used by the downloader */ + //! Current BBOX used by the downloader QgsRectangle mRect; - /** Server-side or user-side limit of downloaded features (in a single GetFeature()). Valid if > 0 */ + //! Server-side or user-side limit of downloaded features (in a single GetFeature()). Valid if > 0 int mMaxFeatures; - /** Whether mMaxFeatures was set to a non 0 value for the purpose of paging */ + //! Whether mMaxFeatures was set to a non 0 value for the purpose of paging bool mMaxFeaturesWasSetFromDefaultForPaging; - /** Server capabilities */ + //! Server capabilities QgsWfsCapabilities::Capabilities mCaps; - /** Whether progress dialog should be hidden */ + //! Whether progress dialog should be hidden bool mHideProgressDialog; - /** SELECT DISTINCT */ + //! SELECT DISTINCT bool mDistinctSelect; - /** Bounding box for the layer as returned by GetCapabilities */ + //! Bounding box for the layer as returned by GetCapabilities QgsRectangle mCapabilityExtent; - /** If we have already issued a warning about missing feature ids */ + //! If we have already issued a warning about missing feature ids bool mHasWarnedAboutMissingFeatureId; - /** Create GML parser */ + //! Create GML parser QgsGmlStreamingParser* createParser(); /** If the server (typically MapServer WFS 1.1) honours EPSG axis order, but returns @@ -177,25 +177,25 @@ class QgsWFSSharedData : public QObject private: - /** Main mutex to protect most data members that can be modified concurrently */ + //! Main mutex to protect most data members that can be modified concurrently QMutex mMutex; - /** Mutex used specifically by registerToCache() */ + //! Mutex used specifically by registerToCache() QMutex mMutexRegisterToCache; - /** Mutex used only by serializeFeatures() */ + //! Mutex used only by serializeFeatures() QMutex mCacheWriteMutex; - /** WFS filter */ + //! WFS filter QString mWFSFilter; - /** WFS SORTBY */ + //! WFS SORTBY QString mSortBy; - /** The background feature downloader */ + //! The background feature downloader QgsWFSThreadedFeatureDownloader* mDownloader; - /** Whether the downloader has finished (or been cancelled) */ + //! Whether the downloader has finished (or been cancelled) bool mDownloadFinished; /** The generation counter. When a iterator is built or rewind, it gets the @@ -205,34 +205,34 @@ class QgsWFSSharedData : public QObject notified in live by the downloader. */ int mGenCounter; - /** Number of features of the layer */ + //! Number of features of the layer int mFeatureCount; - /** Whether mFeatureCount value is exact or approximate / in construction */ + //! Whether mFeatureCount value is exact or approximate / in construction bool mFeatureCountExact; - /** Extent computed from downloaded features */ + //! Extent computed from downloaded features QgsRectangle mComputedExtent; - /** Filename of the on-disk cache */ + //! Filename of the on-disk cache QString mCacheDbname; - /** Tablename of the on-disk cache */ + //! Tablename of the on-disk cache QString mCacheTablename; - /** Spatial index of requested cached regions */ + //! Spatial index of requested cached regions QgsSpatialIndex mCachedRegions; - /** Requested cached regions */ + //! Requested cached regions QVector< QgsFeature > mRegions; - /** Whether a GetFeature hits request has been issued to retrieve the number of features */ + //! Whether a GetFeature hits request has been issued to retrieve the number of features bool mGetFeatureHitsIssued; - /** Number of features that have been cached, or attempted to be cached */ + //! Number of features that have been cached, or attempted to be cached int mTotalFeaturesAttemptedToBeCached; - /** Whether we have already tried fetching one feature after realizing that the capabilities extent is wrong */ + //! Whether we have already tried fetching one feature after realizing that the capabilities extent is wrong bool mTryFetchingOneFeature; /** Returns the set of gmlIds that have already been downloaded and @@ -243,14 +243,14 @@ class QgsWFSSharedData : public QObject cached, so as to avoid to cache duplicates. */ QSet getExistingCachedMD5( const QVector& featureList ); - /** Create the on-disk cache and connect to it */ + //! Create the on-disk cache and connect to it bool createCache(); - /** Log error to QgsMessageLog and raise it to the provider */ + //! Log error to QgsMessageLog and raise it to the provider void pushError( const QString& errorMsg ); }; -/** Utility class to issue a GetFeature resultType=hits request */ +//! Utility class to issue a GetFeature resultType=hits request class QgsWFSFeatureHitsRequest: public QgsWfsRequest { Q_OBJECT @@ -258,7 +258,7 @@ class QgsWFSFeatureHitsRequest: public QgsWfsRequest explicit QgsWFSFeatureHitsRequest( QgsWFSDataSourceURI& uri ); ~QgsWFSFeatureHitsRequest(); - /** Return the feature count, or -1 in case of error */ + //! Return the feature count, or -1 in case of error int getFeatureCount( const QString& WFSVersion, const QString& filter ); protected: @@ -274,7 +274,7 @@ class QgsWFSSingleFeatureRequest: public QgsWfsRequest explicit QgsWFSSingleFeatureRequest( QgsWFSSharedData* shared ); ~QgsWFSSingleFeatureRequest(); - /** Return the feature extent of the single feature requested */ + //! Return the feature extent of the single feature requested QgsRectangle getExtent(); protected: diff --git a/src/providers/wfs/qgswfstransactionrequest.h b/src/providers/wfs/qgswfstransactionrequest.h index c4d847ea88b..b2c23859e20 100644 --- a/src/providers/wfs/qgswfstransactionrequest.h +++ b/src/providers/wfs/qgswfstransactionrequest.h @@ -17,14 +17,14 @@ #include "qgswfsrequest.h" -/** Manages the Transaction requests */ +//! Manages the Transaction requests class QgsWFSTransactionRequest : public QgsWfsRequest { Q_OBJECT public: explicit QgsWFSTransactionRequest( const QString& theUri ); - /** Send the transaction document and return the server response */ + //! Send the transaction document and return the server response bool send( const QDomDocument& doc, QDomDocument& serverResponse ); protected: diff --git a/src/providers/wfs/qgswfsutils.h b/src/providers/wfs/qgswfsutils.h index 23a313788a7..fad73be0e44 100644 --- a/src/providers/wfs/qgswfsutils.h +++ b/src/providers/wfs/qgswfsutils.h @@ -27,21 +27,21 @@ class QgsWFSUtils { public: - /** Return the name of temporary directory. */ + //! Return the name of temporary directory. static QString acquireCacheDirectory(); - /** To be called when a temporary file is removed from the directory */ + //! To be called when a temporary file is removed from the directory static void releaseCacheDirectory(); - /** Initial cleanup. */ + //! Initial cleanup. static void init(); - /** Removes a possible namespace prefix from a typename*/ + //! Removes a possible namespace prefix from a typename static QString removeNamespacePrefix( const QString& tname ); - /** Returns namespace prefix (or an empty string if there is no prefix)*/ + //! Returns namespace prefix (or an empty string if there is no prefix) static QString nameSpacePrefix( const QString& tname ); - /** Return a unique identifier made from feature content */ + //! Return a unique identifier made from feature content static QString getMD5( const QgsFeature& f ); protected: @@ -54,16 +54,16 @@ class QgsWFSUtils static bool gmKeepAliveWorks; static int gmCounter; - /** Return the name of temporary directory. */ + //! Return the name of temporary directory. static QString getCacheDirectory( bool createIfNotExisting ); static QString getBaseCacheDirectory( bool createIfNotExisting ); - /** Remove (recursively) a directory. */ + //! Remove (recursively) a directory. static bool removeDir( const QString &dirName ); }; -/** For internal use of QgsWFSUtils */ +//! For internal use of QgsWFSUtils class QgsWFSUtilsKeepAlive: public QThread { Q_OBJECT diff --git a/src/providers/wms/qgswmscapabilities.h b/src/providers/wms/qgswmscapabilities.h index 00d6d36539a..5194ff3aa18 100644 --- a/src/providers/wms/qgswmscapabilities.h +++ b/src/providers/wms/qgswmscapabilities.h @@ -32,28 +32,28 @@ class QNetworkReply; * as illustrated in Appendix E of the Web Map Service standard, version 1.3, 2004-08-02. */ -/** OnlineResource Attribute structure */ +//! OnlineResource Attribute structure // TODO: Fill to WMS specifications struct QgsWmsOnlineResourceAttribute { QString xlinkHref; }; -/** Get Property structure */ +//! Get Property structure // TODO: Fill to WMS specifications struct QgsWmsGetProperty { QgsWmsOnlineResourceAttribute onlineResource; }; -/** Post Property structure */ +//! Post Property structure // TODO: Fill to WMS specifications struct QgsWmsPostProperty { QgsWmsOnlineResourceAttribute onlineResource; }; -/** HTTP Property structure */ +//! HTTP Property structure // TODO: Fill to WMS specifications struct QgsWmsHttpProperty { @@ -61,14 +61,14 @@ struct QgsWmsHttpProperty QgsWmsPostProperty post; // can be null }; -/** DCP Type Property structure */ +//! DCP Type Property structure // TODO: Fill to WMS specifications struct QgsWmsDcpTypeProperty { QgsWmsHttpProperty http; }; -/** Operation Type structure (for GetMap and GetFeatureInfo) */ +//! Operation Type structure (for GetMap and GetFeatureInfo) // TODO: Fill to WMS specifications struct QgsWmsOperationType { @@ -77,7 +77,7 @@ struct QgsWmsOperationType QStringList allowedEncodings; }; -/** Request Property structure */ +//! Request Property structure // TODO: Fill to WMS specifications struct QgsWmsRequestProperty { @@ -90,21 +90,21 @@ struct QgsWmsRequestProperty QgsWmsOperationType getLegendGraphic; }; -/** Exception Property structure */ +//! Exception Property structure // TODO: Fill to WMS specifications struct QgsWmsExceptionProperty { QStringList format; // text formats supported. }; -/** Primary Contact Person Property structure */ +//! Primary Contact Person Property structure struct QgsWmsContactPersonPrimaryProperty { QString contactPerson; QString contactOrganization; }; -/** Contact Address Property structure */ +//! Contact Address Property structure struct QgsWmsContactAddressProperty { QString addressType; @@ -115,7 +115,7 @@ struct QgsWmsContactAddressProperty QString country; }; -/** Contact Information Property structure */ +//! Contact Information Property structure struct QgsWmsContactInformationProperty { QgsWmsContactPersonPrimaryProperty contactPersonPrimary; @@ -126,7 +126,7 @@ struct QgsWmsContactInformationProperty QString contactElectronicMailAddress; }; -/** Service Property structure */ +//! Service Property structure // TODO: Fill to WMS specifications struct QgsWmsServiceProperty { @@ -142,7 +142,7 @@ struct QgsWmsServiceProperty uint maxHeight; }; -/** Bounding Box Property structure */ +//! Bounding Box Property structure // TODO: Fill to WMS specifications struct QgsWmsBoundingBoxProperty { @@ -150,7 +150,7 @@ struct QgsWmsBoundingBoxProperty QgsRectangle box; // consumes minx, miny, maxx, maxy. }; -/** Dimension Property structure */ +//! Dimension Property structure // TODO: Fill to WMS specifications struct QgsWmsDimensionProperty { @@ -163,7 +163,7 @@ struct QgsWmsDimensionProperty bool current; }; -/** Logo URL Property structure */ +//! Logo URL Property structure // TODO: Fill to WMS specifications struct QgsWmsLogoUrlProperty { @@ -174,7 +174,7 @@ struct QgsWmsLogoUrlProperty int height; }; -/** Attribution Property structure */ +//! Attribution Property structure // TODO: Fill to WMS specifications struct QgsWmsAttributionProperty { @@ -183,7 +183,7 @@ struct QgsWmsAttributionProperty QgsWmsLogoUrlProperty logoUrl; }; -/** Legend URL Property structure */ +//! Legend URL Property structure // TODO: Fill to WMS specifications struct QgsWmsLegendUrlProperty { @@ -194,7 +194,7 @@ struct QgsWmsLegendUrlProperty int height; }; -/** StyleSheet URL Property structure */ +//! StyleSheet URL Property structure // TODO: Fill to WMS specifications struct QgsWmsStyleSheetUrlProperty { @@ -202,7 +202,7 @@ struct QgsWmsStyleSheetUrlProperty QgsWmsOnlineResourceAttribute onlineResource; }; -/** Style URL Property structure */ +//! Style URL Property structure // TODO: Fill to WMS specifications struct QgsWmsStyleUrlProperty { @@ -210,7 +210,7 @@ struct QgsWmsStyleUrlProperty QgsWmsOnlineResourceAttribute onlineResource; }; -/** Style Property structure */ +//! Style Property structure // TODO: Fill to WMS specifications struct QgsWmsStyleProperty { @@ -222,7 +222,7 @@ struct QgsWmsStyleProperty QgsWmsStyleUrlProperty styleUrl; }; -/** Authority URL Property structure */ +//! Authority URL Property structure // TODO: Fill to WMS specifications struct QgsWmsAuthorityUrlProperty { @@ -230,14 +230,14 @@ struct QgsWmsAuthorityUrlProperty QString name; // XML "NMTOKEN" type }; -/** Identifier Property structure */ +//! Identifier Property structure // TODO: Fill to WMS specifications struct QgsWmsIdentifierProperty { QString authority; }; -/** Metadata URL Property structure */ +//! Metadata URL Property structure // TODO: Fill to WMS specifications struct QgsWmsMetadataUrlProperty { @@ -246,7 +246,7 @@ struct QgsWmsMetadataUrlProperty QString type; // XML "NMTOKEN" type }; -/** Data List URL Property structure */ +//! Data List URL Property structure // TODO: Fill to WMS specifications struct QgsWmsDataListUrlProperty { @@ -254,7 +254,7 @@ struct QgsWmsDataListUrlProperty QgsWmsOnlineResourceAttribute onlineResource; }; -/** Feature List URL Property structure */ +//! Feature List URL Property structure // TODO: Fill to WMS specifications struct QgsWmsFeatureListUrlProperty { @@ -262,7 +262,7 @@ struct QgsWmsFeatureListUrlProperty QgsWmsOnlineResourceAttribute onlineResource; }; -/** Layer Property structure */ +//! Layer Property structure // TODO: Fill to WMS specifications struct QgsWmsLayerProperty { @@ -316,12 +316,12 @@ struct QgsWmtsTileMatrix QString title, abstract; QStringList keywords; double scaleDenom; - QgsPoint topLeft; //!< top-left corner of the tile matrix in map units - int tileWidth; //!< width of a tile in pixels - int tileHeight; //!< height of a tile in pixels - int matrixWidth; //!< number of tiles horizontally - int matrixHeight; //!< number of tiles vertically - double tres; //!< pixel span in map units + QgsPoint topLeft; //!< Top-left corner of the tile matrix in map units + int tileWidth; //!< Width of a tile in pixels + int tileHeight; //!< Height of a tile in pixels + int matrixWidth; //!< Number of tiles horizontally + int matrixHeight; //!< Number of tiles vertically + double tres; //!< Pixel span in map units //! Returns extent of a tile in map coordinates. //! (same function as tileBBox() but returns QRectF instead of QgsRectangle) @@ -339,12 +339,12 @@ struct QgsWmtsTileMatrix struct QgsWmtsTileMatrixSet { - QString identifier; //!< tile matrix set identifier - QString title; //!< human readable tile matrix set name - QString abstract; //!< brief description of the tile matrix set - QStringList keywords; //!< list of words/phrases to describe the dataset + QString identifier; //!< Tile matrix set identifier + QString title; //!< Human readable tile matrix set name + QString abstract; //!< Brief description of the tile matrix set + QStringList keywords; //!< List of words/phrases to describe the dataset QString crs; //!< CRS of the tile matrix set - QString wkScaleSet; //!< optional reference to a well-known scale set + QString wkScaleSet; //!< Optional reference to a well-known scale set //! available tile matrixes (key = pixel span in map units) QMap tileMatrices; @@ -394,15 +394,15 @@ struct QgsWmtsStyle */ struct QgsWmtsDimension { - QString identifier; //!< name of the dimensional axis - QString title; //!< human readable name - QString abstract; //!< brief description of the dimension - QStringList keywords; //!< list of words/phrases to describe the dataset - QString UOM; //!< units of measure of dimensional axis - QString unitSymbol; //!< symbol of the units - QString defaultValue; //!< default value to be used if value is not specified in request - bool current; //!< indicates whether temporal data are normally kept current - QStringList values; //!< available values for this dimension + QString identifier; //!< Name of the dimensional axis + QString title; //!< Human readable name + QString abstract; //!< Brief description of the dimension + QStringList keywords; //!< List of words/phrases to describe the dataset + QString UOM; //!< Units of measure of dimensional axis + QString unitSymbol; //!< Symbol of the units + QString defaultValue; //!< Default value to be used if value is not specified in request + bool current; //!< Indicates whether temporal data are normally kept current + QStringList values; //!< Available values for this dimension }; struct QgsWmtsTileLayer @@ -424,7 +424,7 @@ struct QgsWmtsTileLayer QHash getFeatureInfoURLs; }; -/** Capability Property structure */ +//! Capability Property structure // TODO: Fill to WMS specifications struct QgsWmsCapabilityProperty { @@ -441,7 +441,7 @@ struct QgsWmsCapabilityProperty QHash tileMatrixSets; }; -/** Capabilities Property structure */ +//! Capabilities Property structure // TODO: Fill to WMS specifications struct QgsWmsCapabilitiesProperty { @@ -450,7 +450,7 @@ struct QgsWmsCapabilitiesProperty QString version; }; -/** Formats supported by QImageReader */ +//! Formats supported by QImageReader struct QgsWmsSupportedFormat { QString format; @@ -536,7 +536,7 @@ struct QgsWmsAuthorization }; -/** URI that gets passed to provider */ +//! URI that gets passed to provider class QgsWmsSettings { public: @@ -607,7 +607,7 @@ class QgsWmsSettings }; -/** Keeps information about capabilities of particular URI */ +//! Keeps information about capabilities of particular URI class QgsWmsCapabilities { public: @@ -651,10 +651,10 @@ class QgsWmsCapabilities */ QHash supportedTileMatrixSets() const { return mTileMatrixSets; } - /** Find out whether to invert axis orientation when parsing/writing coordinates */ + //! Find out whether to invert axis orientation when parsing/writing coordinates bool shouldInvertAxisOrientation( const QString& ogcCrs ); - /** Find out identify capabilities */ + //! Find out identify capabilities int identifyCapabilities() const; protected: @@ -774,10 +774,10 @@ class QgsWmsCapabilitiesDownload : public QObject void abort(); signals: - /** \brief emit a signal to be caught by qgisapp and display a msg on status bar */ + //! \brief emit a signal to be caught by qgisapp and display a msg on status bar void statusChanged( QString const & theStatusQString ); - /** \brief emit a signal once the download is finished */ + //! \brief emit a signal once the download is finished void downloadFinished(); protected slots: @@ -790,16 +790,16 @@ class QgsWmsCapabilitiesDownload : public QObject QgsWmsAuthorization mAuth; - /** The reply to the capabilities request */ + //! The reply to the capabilities request QNetworkReply *mCapabilitiesReply; - /** The error message associated with the last WMS error. */ + //! The error message associated with the last WMS error. QString mError; - /** The mime type of the message */ + //! The mime type of the message QString mErrorFormat; - /** Capabilities of the WMS (raw) */ + //! Capabilities of the WMS (raw) QByteArray mHttpCapabilitiesResponse; bool mIsAborted; diff --git a/src/providers/wms/qgswmsprovider.h b/src/providers/wms/qgswmsprovider.h index cb0c5d036c0..877d6c34ea7 100644 --- a/src/providers/wms/qgswmsprovider.h +++ b/src/providers/wms/qgswmsprovider.h @@ -176,13 +176,13 @@ class QgsWmsProvider : public QgsRasterDataProvider virtual bool hasTiles() const; #endif - /** Returns the GetMap url */ + //! Returns the GetMap url virtual QString getMapUrl() const; - /** Returns the GetFeatureInfo url */ + //! Returns the GetFeatureInfo url virtual QString getFeatureInfoUrl() const; - /** Return the GetTile url */ + //! Return the GetTile url virtual QString getTileUrl() const; /** Return the GetLegendGraphic url @@ -212,7 +212,7 @@ class QgsWmsProvider : public QgsRasterDataProvider */ QStringList subLayerStyles() const override; - /** \brief Returns whether the provider supplies a legend graphic */ + //! \brief Returns whether the provider supplies a legend graphic bool supportsLegendGraphic() const override { return true; } @@ -374,7 +374,7 @@ class QgsWmsProvider : public QgsRasterDataProvider signals: - /** \brief emit a signal to notify of a progress event */ + //! \brief emit a signal to notify of a progress event void progressChanged( int theProgress, int theTotalSteps ); void dataChanged(); @@ -460,8 +460,8 @@ class QgsWmsProvider : public QgsRasterDataProvider typedef struct TileImage { TileImage( const QRectF& r, const QImage& i ): rect( r ), img( i ) {} - QRectF rect; //!< destination rectangle for a tile (in screen coordinates) - QImage img; //!< cached tile to be drawn + QRectF rect; //!< Destination rectangle for a tile (in screen coordinates) + QImage img; //!< Cached tile to be drawn } TileImage; //! Get tiles from a different resolution to cover the missing areas void fetchOtherResTiles( QgsTileMode tileMode, const QgsRectangle& viewExtent, int imageWidth, QList& missing, double tres, int resOffset, QList &otherResTiles ); @@ -586,7 +586,7 @@ class QgsWmsProvider : public QgsRasterDataProvider }; -/** Handler for downloading of non-tiled WMS requests, the data are written to the given image */ +//! Handler for downloading of non-tiled WMS requests, the data are written to the given image class QgsWmsImageDownloadHandler : public QObject { Q_OBJECT @@ -615,7 +615,7 @@ class QgsWmsImageDownloadHandler : public QObject }; -/** Handler for tiled WMS-C/WMTS requests, the data are written to the given image */ +//! Handler for tiled WMS-C/WMTS requests, the data are written to the given image class QgsWmsTiledImageDownloadHandler : public QObject { Q_OBJECT @@ -661,7 +661,7 @@ class QgsWmsTiledImageDownloadHandler : public QObject }; -/** Class keeping simple statistics for WMS provider - per unique URI */ +//! Class keeping simple statistics for WMS provider - per unique URI class QgsWmsStatistics { public: diff --git a/src/providers/wms/qgsxyzconnection.h b/src/providers/wms/qgsxyzconnection.h index ba1882546f6..92efe8463ab 100644 --- a/src/providers/wms/qgsxyzconnection.h +++ b/src/providers/wms/qgsxyzconnection.h @@ -26,7 +26,7 @@ struct QgsXyzConnection QString encodedUri() const; }; -/** Utility class for handling list of connections to XYZ tile layers */ +//! Utility class for handling list of connections to XYZ tile layers class QgsXyzConnectionUtils { public: diff --git a/src/server/qgsaccesscontrol.cpp b/src/server/qgsaccesscontrol.cpp index 8e13d9020a2..f8fe1480ed1 100644 --- a/src/server/qgsaccesscontrol.cpp +++ b/src/server/qgsaccesscontrol.cpp @@ -23,7 +23,7 @@ #include -/** Filter the features of the layer */ +//! Filter the features of the layer void QgsAccessControl::filterFeatures( const QgsVectorLayer* layer, QgsFeatureRequest& featureRequest ) const { QStringList expressions = QStringList(); @@ -42,13 +42,13 @@ void QgsAccessControl::filterFeatures( const QgsVectorLayer* layer, QgsFeatureRe } } -/** Clone the object */ +//! Clone the object QgsFeatureFilterProvider* QgsAccessControl::clone() const { return new QgsAccessControl( *this ); } -/** Return an additional subset string (typically SQL) filter */ +//! Return an additional subset string (typically SQL) filter QString QgsAccessControl::extraSubsetString( const QgsVectorLayer* layer ) const { QStringList sqls; @@ -64,7 +64,7 @@ QString QgsAccessControl::extraSubsetString( const QgsVectorLayer* layer ) const return sqls.isEmpty() ? QString() : QStringLiteral( "((" ).append( sqls.join( QStringLiteral( ") AND (" ) ) ).append( "))" ); } -/** Return the layer read right */ +//! Return the layer read right bool QgsAccessControl::layerReadPermission( const QgsMapLayer* layer ) const { QgsAccessControlFilterMap::const_iterator acIterator; @@ -78,7 +78,7 @@ bool QgsAccessControl::layerReadPermission( const QgsMapLayer* layer ) const return true; } -/** Return the layer insert right */ +//! Return the layer insert right bool QgsAccessControl::layerInsertPermission( const QgsVectorLayer* layer ) const { QgsAccessControlFilterMap::const_iterator acIterator; @@ -92,7 +92,7 @@ bool QgsAccessControl::layerInsertPermission( const QgsVectorLayer* layer ) cons return true; } -/** Return the layer update right */ +//! Return the layer update right bool QgsAccessControl::layerUpdatePermission( const QgsVectorLayer* layer ) const { QgsAccessControlFilterMap::const_iterator acIterator; @@ -106,7 +106,7 @@ bool QgsAccessControl::layerUpdatePermission( const QgsVectorLayer* layer ) cons return true; } -/** Return the layer delete right */ +//! Return the layer delete right bool QgsAccessControl::layerDeletePermission( const QgsVectorLayer* layer ) const { QgsAccessControlFilterMap::const_iterator acIterator; @@ -120,7 +120,7 @@ bool QgsAccessControl::layerDeletePermission( const QgsVectorLayer* layer ) cons return true; } -/** Return the authorized layer attributes */ +//! Return the authorized layer attributes QStringList QgsAccessControl::layerAttributes( const QgsVectorLayer* layer, const QStringList& attributes ) const { QStringList currentAttributes( attributes ); @@ -132,7 +132,7 @@ QStringList QgsAccessControl::layerAttributes( const QgsVectorLayer* layer, cons return currentAttributes; } -/** Are we authorized to modify the following geometry */ +//! Are we authorized to modify the following geometry bool QgsAccessControl::allowToEdit( const QgsVectorLayer* layer, const QgsFeature& feature ) const { QgsAccessControlFilterMap::const_iterator acIterator; @@ -146,7 +146,7 @@ bool QgsAccessControl::allowToEdit( const QgsVectorLayer* layer, const QgsFeatur return true; } -/** Fill the capabilities caching key */ +//! Fill the capabilities caching key bool QgsAccessControl::fillCacheKey( QStringList& cacheKey ) const { QgsAccessControlFilterMap::const_iterator acIterator; @@ -163,7 +163,7 @@ bool QgsAccessControl::fillCacheKey( QStringList& cacheKey ) const return true; } -/** Register a new access control filter */ +//! Register a new access control filter void QgsAccessControl::registerAccessControl( QgsAccessControlFilter* accessControl, int priority ) { mPluginsAccessControls->insert( priority, accessControl ); diff --git a/src/server/qgsaccesscontrol.h b/src/server/qgsaccesscontrol.h index a42a194c5ef..f039ab7b900 100644 --- a/src/server/qgsaccesscontrol.h +++ b/src/server/qgsaccesscontrol.h @@ -35,19 +35,19 @@ class QgsAccessControlPlugin; class SERVER_EXPORT QgsAccessControl : public QgsFeatureFilterProvider { public: - /** Constructor */ + //! Constructor QgsAccessControl() { mPluginsAccessControls = new QgsAccessControlFilterMap(); } - /** Constructor */ + //! Constructor QgsAccessControl( const QgsAccessControl& copy ) { mPluginsAccessControls = new QgsAccessControlFilterMap( *copy.mPluginsAccessControls ); } - /** Destructor */ + //! Destructor ~QgsAccessControl() { delete mPluginsAccessControls; @@ -121,7 +121,7 @@ class SERVER_EXPORT QgsAccessControl : public QgsFeatureFilterProvider void registerAccessControl( QgsAccessControlFilter* accessControl, int priority = 0 ); private: - /** The AccessControl plugins registry */ + //! The AccessControl plugins registry QgsAccessControlFilterMap* mPluginsAccessControls; }; diff --git a/src/server/qgsaccesscontrolfilter.cpp b/src/server/qgsaccesscontrolfilter.cpp index f75831a2a81..386b1806beb 100644 --- a/src/server/qgsaccesscontrolfilter.cpp +++ b/src/server/qgsaccesscontrolfilter.cpp @@ -26,18 +26,18 @@ #include -/** Constructor */ +//! Constructor QgsAccessControlFilter::QgsAccessControlFilter( const QgsServerInterface* serverInterface ): mServerInterface( serverInterface ) { } -/** Destructor */ +//! Destructor QgsAccessControlFilter::~QgsAccessControlFilter() { } -/** Return an additional layer expression filter */ +//! Return an additional layer expression filter QString QgsAccessControlFilter::layerFilterExpression( const QgsVectorLayer* layer ) const { QgsMessageLog::logMessage( QStringLiteral( "QgsAccessControlFilter plugin default layerFilterExpression called" ), QStringLiteral( "AccessControlFilter" ), QgsMessageLog::INFO ); @@ -45,7 +45,7 @@ QString QgsAccessControlFilter::layerFilterExpression( const QgsVectorLayer* lay return QString(); } -/** Return an additional layer subset string (typically SQL) filter */ +//! Return an additional layer subset string (typically SQL) filter QString QgsAccessControlFilter::layerFilterSubsetString( const QgsVectorLayer* layer ) const { QgsMessageLog::logMessage( QStringLiteral( "QgsAccessControlFilter plugin default layerFilterSQL called" ), QStringLiteral( "AccessControlFilter" ), QgsMessageLog::INFO ); @@ -53,7 +53,7 @@ QString QgsAccessControlFilter::layerFilterSubsetString( const QgsVectorLayer* l return QString(); } -/** Return the layer permissions */ +//! Return the layer permissions QgsAccessControlFilter::LayerPermissions QgsAccessControlFilter::layerPermissions( const QgsMapLayer* layer ) const { QgsMessageLog::logMessage( QStringLiteral( "QgsAccessControlFilter plugin default layerPermissions called" ), QStringLiteral( "AccessControlFilter" ), QgsMessageLog::INFO ); @@ -63,7 +63,7 @@ QgsAccessControlFilter::LayerPermissions QgsAccessControlFilter::layerPermission return permissions; } -/** Return the authorized layer attributes */ +//! Return the authorized layer attributes QStringList QgsAccessControlFilter::authorizedLayerAttributes( const QgsVectorLayer* layer, const QStringList& attributes ) const { Q_UNUSED( layer ); @@ -71,7 +71,7 @@ QStringList QgsAccessControlFilter::authorizedLayerAttributes( const QgsVectorLa return attributes; } -/** Are we authorized to modify the feature */ +//! Are we authorized to modify the feature bool QgsAccessControlFilter::allowToEdit( const QgsVectorLayer* layer, const QgsFeature& feature ) const { QgsMessageLog::logMessage( QStringLiteral( "QgsAccessControlFilter plugin default allowToEdit called" ), QStringLiteral( "AccessControlFilter" ), QgsMessageLog::INFO ); @@ -80,7 +80,7 @@ bool QgsAccessControlFilter::allowToEdit( const QgsVectorLayer* layer, const Qgs return true; } -/** Cache key to used to create the capabilities cache, "" for no cache */ +//! Cache key to used to create the capabilities cache, "" for no cache QString QgsAccessControlFilter::cacheKey() const { return QString(); diff --git a/src/server/qgsaccesscontrolfilter.h b/src/server/qgsaccesscontrolfilter.h index 72dfd2f5643..cb596ad17e5 100644 --- a/src/server/qgsaccesscontrolfilter.h +++ b/src/server/qgsaccesscontrolfilter.h @@ -54,10 +54,10 @@ class SERVER_EXPORT QgsAccessControlFilter * and must be passed to QgsAccessControlFilter instances. */ QgsAccessControlFilter( const QgsServerInterface* serverInterface ); - /** Destructor */ + //! Destructor virtual ~QgsAccessControlFilter(); - /** Describe the layer permission */ + //! Describe the layer permission struct LayerPermissions { bool canRead; @@ -66,7 +66,7 @@ class SERVER_EXPORT QgsAccessControlFilter bool canDelete; }; - /** Return the QgsServerInterface instance */ + //! Return the QgsServerInterface instance const QgsServerInterface* serverInterface() const { return mServerInterface; } /** Return an additional expression filter @@ -108,12 +108,12 @@ class SERVER_EXPORT QgsAccessControlFilter private: - /** The server interface */ + //! The server interface const QgsServerInterface* mServerInterface; }; -/** The registry definition */ +//! The registry definition typedef QMultiMap QgsAccessControlFilterMap; diff --git a/src/server/qgscapabilitiescache.h b/src/server/qgscapabilitiescache.h index c82217ae006..089ce3a1fae 100644 --- a/src/server/qgscapabilitiescache.h +++ b/src/server/qgscapabilitiescache.h @@ -57,7 +57,7 @@ class SERVER_EXPORT QgsCapabilitiesCache : public QObject QFileSystemWatcher mFileSystemWatcher; private slots: - /** Removes changed entry from this cache*/ + //! Removes changed entry from this cache void removeChangedEntry( const QString &path ); }; diff --git a/src/server/qgsconfigcache.h b/src/server/qgsconfigcache.h index e7330d21671..37cfcea41bb 100644 --- a/src/server/qgsconfigcache.h +++ b/src/server/qgsconfigcache.h @@ -66,10 +66,10 @@ class SERVER_EXPORT QgsConfigCache : public QObject private: QgsConfigCache(); - /** Check for configuration file updates (remove entry from cache if file changes)*/ + //! Check for configuration file updates (remove entry from cache if file changes) QFileSystemWatcher mFileSystemWatcher; - /** Returns xml document for project file / sld or 0 in case of errors*/ + //! Returns xml document for project file / sld or 0 in case of errors QDomDocument* xmlDocument( const QString& filePath ); QCache mXmlDocumentCache; @@ -78,7 +78,7 @@ class SERVER_EXPORT QgsConfigCache : public QObject QCache mWCSConfigCache; private slots: - /** Removes changed entry from this cache*/ + //! Removes changed entry from this cache void removeChangedEntry( const QString& path ); }; diff --git a/src/server/qgsconfigparserutils.h b/src/server/qgsconfigparserutils.h index a213fd8ffc6..9cb8636fd1b 100644 --- a/src/server/qgsconfigparserutils.h +++ b/src/server/qgsconfigparserutils.h @@ -40,10 +40,10 @@ class QgsConfigParserUtils const QStringList& constrainedCrsList ); static void appendLayerBoundingBox( QDomElement& layerElem, QDomDocument& doc, const QgsRectangle& layerExtent, const QgsCoordinateReferenceSystem& layerCRS, const QString& crsText ); - /** Returns a list of supported EPSG coordinate system numbers from a layer*/ + //! Returns a list of supported EPSG coordinate system numbers from a layer static QStringList createCrsListForLayer( QgsMapLayer* theMapLayer ); - /** Returns default service capabilities from wms_metadata.xml if nothing else is defined*/ + //! Returns default service capabilities from wms_metadata.xml if nothing else is defined static void fallbackServiceCapabilities( QDomElement& parentElement, QDomDocument& doc ); static QList layerMapToList( const QMap< int, QgsMapLayer* >& layerMap, bool reverseOrder = false ); diff --git a/src/server/qgshttprequesthandler.h b/src/server/qgshttprequesthandler.h index 833fab653ff..8aad80af8a2 100644 --- a/src/server/qgshttprequesthandler.h +++ b/src/server/qgshttprequesthandler.h @@ -47,7 +47,7 @@ class QgsHttpRequestHandler: public QgsRequestHandler virtual void setGetFeatureResponse( QByteArray* ba ) override; virtual void endGetFeatureResponse( QByteArray* ba ) override; virtual void setGetCoverageResponse( QByteArray* ba ) override; - /** Send out HTTP headers and flush output buffer*/ + //! Send out HTTP headers and flush output buffer virtual void sendResponse() override; virtual void setDefaultHeaders() override; virtual void setHeader( const QString &name, const QString &value ) override; @@ -64,7 +64,7 @@ class QgsHttpRequestHandler: public QgsRequestHandler #ifdef HAVE_SERVER_PYTHON_PLUGINS virtual void setPluginFilters( const QgsServerFiltersMap &pluginFilters ) override; #endif - /** Return the response if capture output is activated */ + //! Return the response if capture output is activated QPair getResponse() override; protected: @@ -76,7 +76,7 @@ class QgsHttpRequestHandler: public QgsRequestHandler QString formatToMimeType( const QString& format ) const; void requestStringToParameterMap( const QString& request, QMap& parameters ); - /** Read CONTENT_LENGTH characters from stdin*/ + //! Read CONTENT_LENGTH characters from stdin QString readPostBody() const; private: @@ -89,7 +89,7 @@ class QgsHttpRequestHandler: public QgsRequestHandler static bool greenCompare( QPair c1, QPair c2 ); static bool blueCompare( QPair c1, QPair c2 ); static bool alphaCompare( QPair c1, QPair c2 ); - /** Calculates a representative color for a box (pixel weighted average)*/ + //! Calculates a representative color for a box (pixel weighted average) static QRgb boxColor( const QgsColorBox& box, int boxPixels ); // TODO: if HAVE_SERVER_PYTHON QByteArray mResponseHeader; diff --git a/src/server/qgshttptransaction.h b/src/server/qgshttptransaction.h index 9377427c154..412a885229c 100644 --- a/src/server/qgshttptransaction.h +++ b/src/server/qgshttptransaction.h @@ -91,12 +91,12 @@ class QgsHttpTransaction : public QObject @return true if proxy settings was applied, false else*/ static bool applyProxySettings( QHttp& http, const QString& url ); - /** Set the credentials (username and password) */ + //! Set the credentials (username and password) void setCredentials( const QString& username, const QString &password ); - /** Returns the network timeout in msec*/ + //! Returns the network timeout in msec int networkTimeout() const { return mNetworkTimeoutMsec;} - /** Sets the network timeout in milliseconds*/ + //! Sets the network timeout in milliseconds void setNetworkTimeout( int msec ) { mNetworkTimeoutMsec = msec;} @@ -118,26 +118,26 @@ class QgsHttpTransaction : public QObject void networkTimedOut(); - /** Aborts the current transaction*/ + //! Aborts the current transaction void abort(); signals: - /** Legacy code. This signal is currently not emitted and only kept for API compatibility*/ + //! Legacy code. This signal is currently not emitted and only kept for API compatibility void setProgress( int done, int total ); - /** Signal for progress update */ + //! Signal for progress update void dataReadProgress( int theProgress ); - /** Signal for adjusted number of steps*/ + //! Signal for adjusted number of steps void totalSteps( int theTotalSteps ); - /** \brief emit a signal to be caught by qgisapp and display a msg on status bar */ + //! \brief emit a signal to be caught by qgisapp and display a msg on status bar void statusChanged( const QString& theStatusQString ); private: - /** Default constructor is forbidden*/ + //! Default constructor is forbidden QgsHttpTransaction(); /** @@ -214,7 +214,7 @@ class QgsHttpTransaction : public QObject */ QString mPassword; - /** Network timeout in milliseconds*/ + //! Network timeout in milliseconds int mNetworkTimeoutMsec; }; diff --git a/src/server/qgsinterpolationlayerbuilder.h b/src/server/qgsinterpolationlayerbuilder.h index f2b3711a0af..0912f769748 100644 --- a/src/server/qgsinterpolationlayerbuilder.h +++ b/src/server/qgsinterpolationlayerbuilder.h @@ -22,7 +22,7 @@ class QgsVectorLayer; -/** A class that produces a rasterlayer from a vector layer with spatial interpolation*/ +//! A class that produces a rasterlayer from a vector layer with spatial interpolation class QgsInterpolationLayerBuilder: public QgsMSLayerBuilder { public: diff --git a/src/server/qgsmaprenderer.h b/src/server/qgsmaprenderer.h index 97559531484..a243e7c2a5d 100644 --- a/src/server/qgsmaprenderer.h +++ b/src/server/qgsmaprenderer.h @@ -61,7 +61,7 @@ class SERVER_EXPORT QgsMapRenderer : public QObject public: - /** Output units for pen width and point marker width/height*/ + //! Output units for pen width and point marker width/height enum OutputUnits { Millimeters, diff --git a/src/server/qgsmslayerbuilder.h b/src/server/qgsmslayerbuilder.h index c25f2f0a5df..98fbe97138a 100644 --- a/src/server/qgsmslayerbuilder.h +++ b/src/server/qgsmslayerbuilder.h @@ -43,7 +43,7 @@ class QgsMSLayerBuilder @return the created layer or 0 in case of error*/ virtual QgsMapLayer* createMapLayer( const QDomElement& elem, const QString& layerName, QList& filesToRemove, QList& layersToRemove, bool allowCaching = true ) const = 0; protected: - /** Tries to create a suitable layer name from a URL. */ + //! Tries to create a suitable layer name from a URL. virtual QString layerNameFromUri( const QString& uri ) const; /** Helper function that creates a new temporary file with random name under /tmp/qgis_wms_serv/ and returns the path of the file (Unix). On Windows, it is created in the current working directory diff --git a/src/server/qgsmslayercache.h b/src/server/qgsmslayercache.h index 14b7b6ee3c2..d00775feed3 100644 --- a/src/server/qgsmslayercache.h +++ b/src/server/qgsmslayercache.h @@ -73,19 +73,19 @@ class QgsMSLayerCache: public QObject //for debugging void logCacheContents() const; - /** Expose method for use in server interface */ + //! Expose method for use in server interface void removeProjectLayers( const QString& path ); protected: - /** Protected singleton constructor*/ + //! Protected singleton constructor QgsMSLayerCache(); /** Goes through the list and removes entries and layers depending on their time stamps and the number of other layers*/ void updateEntries(); - /** Removes the cash entry with the lowest 'lastUsedTime'*/ + //! Removes the cash entry with the lowest 'lastUsedTime' void removeLeastUsedEntry(); - /** Frees memory and removes temporary files of an entry*/ + //! Frees memory and removes temporary files of an entry void freeEntryRessources( QgsMSLayerCacheEntry& entry ); private: @@ -94,21 +94,21 @@ class QgsMSLayerCache: public QObject layer names*/ QMultiHash, QgsMSLayerCacheEntry> mEntries; - /** Config files used in the cache (with reference counter)*/ + //! Config files used in the cache (with reference counter) QHash< QString, int > mConfigFiles; - /** Check for configuration file updates (remove layers from cache if configuration file changes)*/ + //! Check for configuration file updates (remove layers from cache if configuration file changes) QFileSystemWatcher mFileSystemWatcher; - /** Maximum number of layers in the cache*/ + //! Maximum number of layers in the cache int mDefaultMaxLayers; - /** Maximum number of layers in the cache, overrides DEFAULT_MAX_N_LAYERS if larger*/ + //! Maximum number of layers in the cache, overrides DEFAULT_MAX_N_LAYERS if larger int mProjectMaxLayers; private slots: - /** Removes entries from a project (e.g. if a project file has changed)*/ + //! Removes entries from a project (e.g. if a project file has changed) void removeProjectFileLayers( const QString& project ); }; diff --git a/src/server/qgsmsutils.h b/src/server/qgsmsutils.h index 9751d9979a1..326e35e8760 100644 --- a/src/server/qgsmsutils.h +++ b/src/server/qgsmsutils.h @@ -17,14 +17,14 @@ #include -/** Some utility functions that may be included from everywhere in the code*/ +//! Some utility functions that may be included from everywhere in the code namespace QgsMSUtils { /** Creates a ramdom filename for a temporary file. This function also creates the directory to store the temporary files if it does not already exist. The directory is /tmp/qgis_map_serv/ under linux or the current working directory on windows*/ QString createTempFilePath(); - /** Stores the specified text in a temporary file. Returns 0 in case of success*/ + //! Stores the specified text in a temporary file. Returns 0 in case of success int createTextFile( const QString& filePath, const QString& text ); } diff --git a/src/server/qgsowsserver.cpp b/src/server/qgsowsserver.cpp index 9cae708eee3..1524c42c4ff 100644 --- a/src/server/qgsowsserver.cpp +++ b/src/server/qgsowsserver.cpp @@ -22,7 +22,7 @@ #include "qgsvectordataprovider.h" #ifdef HAVE_SERVER_PYTHON_PLUGINS -/** Apply filter from AccessControl */ +//! Apply filter from AccessControl void QgsOWSServer::applyAccessControlLayerFilters( QgsMapLayer* mapLayer, QHash& originalLayerFilters ) const { if ( QgsVectorLayer* layer = qobject_cast( mapLayer ) ) @@ -48,7 +48,7 @@ void QgsOWSServer::applyAccessControlLayerFilters( QgsMapLayer* mapLayer, QHash< } #endif -/** Restore layer filter as original */ +//! Restore layer filter as original void QgsOWSServer::restoreLayerFilters( const QHash& filterMap ) { QHash::const_iterator filterIt = filterMap.constBegin(); diff --git a/src/server/qgsowsserver.h b/src/server/qgsowsserver.h index cd5748f9595..7ac0fd4c556 100644 --- a/src/server/qgsowsserver.h +++ b/src/server/qgsowsserver.h @@ -62,7 +62,7 @@ class QgsOWSServer QgsRequestHandler* mRequestHandler; QString mConfigFilePath; #ifdef HAVE_SERVER_PYTHON_PLUGINS - /** The access control helper */ + //! The access control helper const QgsAccessControl* mAccessControl; /** Apply filter strings from the access control to the layers. diff --git a/src/server/qgspostrequesthandler.h b/src/server/qgspostrequesthandler.h index 0a9a2f11195..65ddf7a5630 100644 --- a/src/server/qgspostrequesthandler.h +++ b/src/server/qgspostrequesthandler.h @@ -20,14 +20,14 @@ #include "qgshttprequesthandler.h" -/** Request handler for HTTP POST*/ +//! Request handler for HTTP POST class QgsPostRequestHandler: public QgsHttpRequestHandler { public: explicit QgsPostRequestHandler( const bool captureOutput = false ); ~QgsPostRequestHandler(); - /** Parses the input and creates a request neutral Parameter/Value map*/ + //! Parses the input and creates a request neutral Parameter/Value map void parseInput() override; }; diff --git a/src/server/qgsremotedatasourcebuilder.h b/src/server/qgsremotedatasourcebuilder.h index 466c52ce230..f97ae721c3d 100644 --- a/src/server/qgsremotedatasourcebuilder.h +++ b/src/server/qgsremotedatasourcebuilder.h @@ -22,7 +22,7 @@ class QgsRasterLayer; class QgsVectorLayer; -/** A class that creates map layer from or tags*/ +//! A class that creates map layer from or tags class QgsRemoteDataSourceBuilder: public QgsMSLayerBuilder { public: @@ -31,9 +31,9 @@ class QgsRemoteDataSourceBuilder: public QgsMSLayerBuilder QgsMapLayer* createMapLayer( const QDomElement& elem, const QString& layerName, QList& filesToRemove, QList& layersToRemove, bool allowCaching = true ) const override; private: - /** Creates a raster layer from a . This function loads the data into a temporary file and creates a rasterlayer from it. Returns a 0 pointer in case of error*/ + //! Creates a raster layer from a . This function loads the data into a temporary file and creates a rasterlayer from it. Returns a 0 pointer in case of error QgsRasterLayer* rasterLayerFromRemoteRDS( const QDomElement& remoteRDSElem, const QString& layerName, QList& filesToRemove, QList& layersToRemove, bool allowCaching = true ) const; - /** Saves the vector data into a temporary file and creates a vector layer. Returns a 0 pointer in case of error*/ + //! Saves the vector data into a temporary file and creates a vector layer. Returns a 0 pointer in case of error QgsVectorLayer* vectorLayerFromRemoteVDS( const QDomElement& remoteVDSElem, const QString& layerName, QList& filesToRemove, QList& layersToRemove, bool allowCaching = true ) const; /** Loads data from http or ftp diff --git a/src/server/qgsremoteowsbuilder.h b/src/server/qgsremoteowsbuilder.h index 468520618ff..d4f5414f9e8 100644 --- a/src/server/qgsremoteowsbuilder.h +++ b/src/server/qgsremoteowsbuilder.h @@ -24,7 +24,7 @@ class QgsRasterLayer; class QgsVectorLayer; -/** Creates QGIS maplayers from sld tags*/ +//! Creates QGIS maplayers from sld tags class QgsRemoteOWSBuilder: public QgsMSLayerBuilder { public: @@ -35,11 +35,11 @@ class QgsRemoteOWSBuilder: public QgsMSLayerBuilder private: QgsRemoteOWSBuilder(); //forbidden - /** Creates a wms layer from a complete wms url (using http get). Returns 0 in case of error*/ + //! Creates a wms layer from a complete wms url (using http get). Returns 0 in case of error QgsRasterLayer* wmsLayerFromUrl( const QString& url, const QString& layerName, QList& layersToRemove, bool allowCaching = true ) const; - /** Creates a temporary file such that the gdal library can read from wcs*/ + //! Creates a temporary file such that the gdal library can read from wcs QgsRasterLayer* wcsLayerFromUrl( const QString& url, const QString& layerName, QList& filesToRemove, QList& layersToRemove, bool allowCaching = true ) const; - /** Creates sos layer by analizing server url and LayerSensorObservationConstraints*/ + //! Creates sos layer by analizing server url and LayerSensorObservationConstraints QgsVectorLayer* sosLayer( const QDomElement& remoteOWSElem, const QString& url, const QString& layerName, QList& layersToRemove, bool allowCaching = true ) const; QMap mParameterMap; diff --git a/src/server/qgsrequesthandler.h b/src/server/qgsrequesthandler.h index 72c3f690e12..ecc50eeb2e1 100644 --- a/src/server/qgsrequesthandler.h +++ b/src/server/qgsrequesthandler.h @@ -71,7 +71,7 @@ class QgsRequestHandler //! @note not available in Python bindings virtual void setGetFeatureInfoResponse( const QDomDocument& infoDoc, const QString& infoFormat ) = 0; - /** Allow plugins to return a QgsMapServiceException*/ + //! Allow plugins to return a QgsMapServiceException virtual void setServiceException( const QgsMapServiceException& ex ) = 0; //! @note not available in Python bindings @@ -97,34 +97,34 @@ class QgsRequestHandler virtual void setDefaultHeaders() {} - /** Set an HTTP header*/ + //! Set an HTTP header virtual void setHeader( const QString &name, const QString &value ) = 0; - /** Remove an HTTP header*/ + //! Remove an HTTP header virtual int removeHeader( const QString &name ) = 0; - /** Delete all HTTP headers*/ + //! Delete all HTTP headers virtual void clearHeaders() = 0; - /** Append the bytestream to response body*/ + //! Append the bytestream to response body virtual void appendBody( const QByteArray &body ) = 0; - /** Clears the response body*/ + //! Clears the response body virtual void clearBody() = 0; - /** Return the response body*/ + //! Return the response body virtual QByteArray body() { return mBody; } - /** Set the info format string such as "text/xml"*/ + //! Set the info format string such as "text/xml" virtual void setInfoFormat( const QString &format ) = 0; - /** Check whether there is any header set or the body is not empty*/ + //! Check whether there is any header set or the body is not empty virtual bool responseReady() const = 0; - /** Send out HTTP headers and flush output buffer*/ + //! Send out HTTP headers and flush output buffer virtual void sendResponse() = 0; - /** Pointer to last raised exception*/ + //! Pointer to last raised exception virtual bool exceptionRaised() const = 0; /** Return a copy of the parsed parameters as a key-value pair, to modify @@ -133,22 +133,22 @@ class QgsRequestHandler */ QMap parameterMap() { return mParameterMap; } - /** Set a request parameter*/ + //! Set a request parameter virtual void setParameter( const QString &key, const QString &value ) = 0; - /** Remove a request parameter*/ + //! Remove a request parameter virtual int removeParameter( const QString &key ) = 0; - /** Return a request parameter*/ + //! Return a request parameter virtual QString parameter( const QString &key ) const = 0; - /** Return the requested format string*/ + //! Return the requested format string QString format() const { return mFormat; } - /** Return the mime type for the response*/ + //! Return the mime type for the response QString infoFormat() const { return mInfoFormat; } - /** Return true if the HTTP headers were already sent to the client*/ + //! Return true if the HTTP headers were already sent to the client bool headersSent() { return mHeadersSent; } #ifdef HAVE_SERVER_PYTHON_PLUGINS @@ -171,7 +171,7 @@ class QgsRequestHandler QgsServerFiltersMap mPluginFilters; #endif QByteArray mBody; // The response payload - /** This is set by the parseInput methods of the subclasses (parameter FORMAT, e.g. 'FORMAT=PNG')*/ + //! This is set by the parseInput methods of the subclasses (parameter FORMAT, e.g. 'FORMAT=PNG') QString mFormat; QString mFormatString; //format string as it is passed in the request (with base) bool mHeadersSent; diff --git a/src/server/qgssentdatasourcebuilder.h b/src/server/qgssentdatasourcebuilder.h index dcf585294c3..9a4aeada3e6 100644 --- a/src/server/qgssentdatasourcebuilder.h +++ b/src/server/qgssentdatasourcebuilder.h @@ -23,7 +23,7 @@ class QgsVectorLayer; class QgsRasterLayer; -/** Builds maplayer from and tags*/ +//! Builds maplayer from and tags class QgsSentDataSourceBuilder: public QgsMSLayerBuilder { public: @@ -39,10 +39,10 @@ class QgsSentDataSourceBuilder: public QgsMSLayerBuilder QgsMapLayer* createMapLayer( const QDomElement& elem, const QString& layerName, QList& filesToRemove, QList& layersToRemove, bool allowCaching = true ) const override; private: - /** Creates a vector layer from a tag. Returns a 0 pointer in case of error*/ + //! Creates a vector layer from a tag. Returns a 0 pointer in case of error QgsVectorLayer* vectorLayerFromSentVDS( const QDomElement& sentVDSElem, QList& filesToRemove, QList& layersToRemove ) const; - /** Creates a raster layer from a tag. Returns a 0 pointer in case of error*/ + //! Creates a raster layer from a tag. Returns a 0 pointer in case of error QgsRasterLayer* rasterLayerFromSentRDS( const QDomElement& sentRDSElem, QList& filesToRemove, QList& layersToRemove ) const; }; diff --git a/src/server/qgsserver.h b/src/server/qgsserver.h index 11f15bf814f..022ccc8d913 100644 --- a/src/server/qgsserver.h +++ b/src/server/qgsserver.h @@ -77,19 +77,19 @@ class SERVER_EXPORT QgsServer QPair testQPair( QPair pair ); #endif - /** Returns a pointer to the server interface */ + //! Returns a pointer to the server interface #ifdef HAVE_SERVER_PYTHON_PLUGINS QgsServerInterfaceImpl* serverInterface() { return sServerInterface; } #endif private: - /** Server initialization */ + //! Server initialization static bool init(); void saveEnvVars(); - /** Saves environment variable into mEnvironmentVariables if defined*/ + //! Saves environment variable into mEnvironmentVariables if defined void saveEnvVar( const QString& variableName ); // All functions that where previously in the main file are now @@ -125,7 +125,7 @@ class SERVER_EXPORT QgsServer static bool sInitialised; static bool sCaptureOutput; - /** Pass important environment variables to the fcgi processes*/ + //! Pass important environment variables to the fcgi processes QHash< QString, QString > mEnvironmentVariables; }; #endif // QGSSERVER_H diff --git a/src/server/qgsserverfilter.h b/src/server/qgsserverfilter.h index 3ae33ba4b59..415937aac16 100644 --- a/src/server/qgsserverfilter.h +++ b/src/server/qgsserverfilter.h @@ -46,9 +46,9 @@ class SERVER_EXPORT QgsServerFilter * and must be passed to QgsServerFilter instances. */ QgsServerFilter( QgsServerInterface* serverInterface ); - /** Destructor */ + //! Destructor virtual ~QgsServerFilter(); - /** Return the QgsServerInterface instance*/ + //! Return the QgsServerInterface instance QgsServerInterface* serverInterface() { return mServerInterface; } /** Method called when the QgsRequestHandler is ready and populated with * parameters, just before entering the main switch for core services.*/ diff --git a/src/server/qgsserverinterface.cpp b/src/server/qgsserverinterface.cpp index f6c9cbd2b8e..302bcfd2bc0 100644 --- a/src/server/qgsserverinterface.cpp +++ b/src/server/qgsserverinterface.cpp @@ -18,13 +18,13 @@ #include "qgsserverinterface.h" -/** Constructor */ +//! Constructor QgsServerInterface::QgsServerInterface(): mConfigFilePath( QString() ) { } -/** Destructor */ +//! Destructor QgsServerInterface::~QgsServerInterface() { } diff --git a/src/server/qgsserverinterface.h b/src/server/qgsserverinterface.h index 228bd7a2cca..cc21381ba5f 100644 --- a/src/server/qgsserverinterface.h +++ b/src/server/qgsserverinterface.h @@ -45,10 +45,10 @@ class SERVER_EXPORT QgsServerInterface public: - /** Constructor */ + //! Constructor QgsServerInterface(); - /** Destructor */ + //! Destructor virtual ~QgsServerInterface() = 0; /** @@ -102,7 +102,7 @@ class SERVER_EXPORT QgsServerInterface */ virtual void registerAccessControl( QgsAccessControlFilter* accessControl, int priority = 0 ) = 0; - /** Gets the registred access control filters */ + //! Gets the registred access control filters virtual const QgsAccessControl* accessControls() const = 0; //! Return an enrironment variable, used to pass environment variables to python diff --git a/src/server/qgsserverinterfaceimpl.cpp b/src/server/qgsserverinterfaceimpl.cpp index 0da0ee12bdb..a90cc65135e 100644 --- a/src/server/qgsserverinterfaceimpl.cpp +++ b/src/server/qgsserverinterfaceimpl.cpp @@ -21,7 +21,7 @@ #include "qgsconfigcache.h" #include "qgsmslayercache.h" -/** Constructor */ +//! Constructor QgsServerInterfaceImpl::QgsServerInterfaceImpl( QgsCapabilitiesCache* capCache ) : mCapabilitiesCache( capCache ) { @@ -36,7 +36,7 @@ QString QgsServerInterfaceImpl::getEnv( const QString& name ) const } -/** Destructor */ +//! Destructor QgsServerInterfaceImpl::~QgsServerInterfaceImpl() { delete mAccessControls; @@ -68,7 +68,7 @@ void QgsServerInterfaceImpl::setFilters( QgsServerFiltersMap* filters ) mFilters = *filters; } -/** Register a new access control filter */ +//! Register a new access control filter void QgsServerInterfaceImpl::registerAccessControl( QgsAccessControlFilter* accessControl, int priority ) { mAccessControls->registerAccessControl( accessControl, priority ); diff --git a/src/server/qgsserverinterfaceimpl.h b/src/server/qgsserverinterfaceimpl.h index 92e58b5bf31..a799f35563e 100644 --- a/src/server/qgsserverinterfaceimpl.h +++ b/src/server/qgsserverinterfaceimpl.h @@ -38,10 +38,10 @@ class QgsServerInterfaceImpl : public QgsServerInterface public: - /** Constructor */ + //! Constructor explicit QgsServerInterfaceImpl( QgsCapabilitiesCache *capCache ); - /** Destructor */ + //! Destructor ~QgsServerInterfaceImpl(); void setRequestHandler( QgsRequestHandler* requestHandler ) override; @@ -51,7 +51,7 @@ class QgsServerInterfaceImpl : public QgsServerInterface QgsRequestHandler* requestHandler() override { return mRequestHandler; } void registerFilter( QgsServerFilter *filter, int priority = 0 ) override; QgsServerFiltersMap filters() override { return mFilters; } - /** Register an access control filter */ + //! Register an access control filter void registerAccessControl( QgsAccessControlFilter *accessControl, int priority = 0 ) override; /** Gets the helper over all the registered access control filters * @return the access control helper diff --git a/src/server/qgsserverlogger.h b/src/server/qgsserverlogger.h index f57d9c084a3..01031bca7a4 100644 --- a/src/server/qgsserverlogger.h +++ b/src/server/qgsserverlogger.h @@ -25,7 +25,7 @@ #include #include -/** Writes message log into server logfile*/ +//! Writes message log into server logfile class QgsServerLogger: public QObject { Q_OBJECT diff --git a/src/server/qgsserverprojectparser.h b/src/server/qgsserverprojectparser.h index 3744739e82b..02767b56330 100644 --- a/src/server/qgsserverprojectparser.h +++ b/src/server/qgsserverprojectparser.h @@ -44,10 +44,10 @@ class SERVER_EXPORT QgsServerProjectParser const QDomDocument* xmlDocument() const { return mXMLDoc; } - /** Returns project layers by id*/ + //! Returns project layers by id void projectLayerMap( QMap& layerMap ) const; - /** Converts a (possibly relative) path to absolute*/ + //! Converts a (possibly relative) path to absolute QString convertToAbsolutePath( const QString& file ) const; /** Creates a maplayer object from element. The layer cash owns the maplayer, so don't delete it @@ -56,10 +56,10 @@ class SERVER_EXPORT QgsServerProjectParser QgsMapLayer* mapLayerFromLayerId( const QString& lId, bool useCache = true ) const; - /** Returns the layer id under a tag in the QGIS projectfile*/ + //! Returns the layer id under a tag in the QGIS projectfile QString layerIdFromLegendLayer( const QDomElement& legendLayer ) const; - /** @param considerMapExtent Take user-defined map extent instead of data-calculated extent if present in project file*/ + //! @param considerMapExtent Take user-defined map extent instead of data-calculated extent if present in project file void combineExtentAndCrsOfGroupChildren( QDomElement& groupElement, QDomDocument& doc, bool considerMapExtent = false ) const; void addLayerProjectSettings( QDomElement& layerElem, QDomDocument& doc, QgsMapLayer* currentLayer ) const; @@ -112,11 +112,11 @@ class SERVER_EXPORT QgsServerProjectParser QStringList wfsLayers() const; QStringList wcsLayers() const; - /** Add layers for vector joins */ + //! Add layers for vector joins void addJoinLayersForElement( const QDomElement& layerElem ) const; void addValueRelationLayersForLayer( const QgsVectorLayer *vl ) const; - /** Add layers which are necessary for the evaluation of the expression function 'getFeature( layer, attributField, value)'*/ + //! Add layers which are necessary for the evaluation of the expression function 'getFeature( layer, attributField, value)' void addGetFeatureLayers( const QDomElement& layerElem ) const; /** Returns the text of the element for a layer element @@ -139,32 +139,32 @@ class SERVER_EXPORT QgsServerProjectParser private: - /** Content of project file*/ + //! Content of project file QDomDocument* mXMLDoc; - /** Absolute project file path (including file name)*/ + //! Absolute project file path (including file name) QString mProjectPath; - /** List of project layer (ordered same as in the project file)*/ + //! List of project layer (ordered same as in the project file) QList mProjectLayerElements; - /** Project layer elements, accessible by layer id*/ + //! Project layer elements, accessible by layer id QHash< QString, QDomElement > mProjectLayerElementsById; - /** Project layer elements, accessible by layer name*/ + //! Project layer elements, accessible by layer name QHash< QString, QDomElement > mProjectLayerElementsByName; - /** List of all legend group elements*/ + //! List of all legend group elements QList mLegendGroupElements; - /** Names of layers and groups which should not be published*/ + //! Names of layers and groups which should not be published QSet mRestrictedLayers; bool mUseLayerIDs; QgsServerProjectParser(); //forbidden - /** Returns a complete string set with all the restricted layer names (layers/groups that are not to be published)*/ + //! Returns a complete string set with all the restricted layer names (layers/groups that are not to be published) QSet findRestrictedLayers() const; QStringList mCustomLayerOrder; @@ -174,7 +174,7 @@ class SERVER_EXPORT QgsServerProjectParser QList findLegendGroupElements() const; QList setLegendGroupElementsWithLayerTree( QgsLayerTreeGroup* layerTreeGroup, const QDomElement& legendElement ) const; - /** Adds sublayers of an embedded group to layer set*/ + //! Adds sublayers of an embedded group to layer set static void sublayersOfEmbeddedGroup( const QString& projectFilePath, const QString& groupName, QSet& layerSet ); }; diff --git a/src/server/qgssldconfigparser.h b/src/server/qgssldconfigparser.h index 552a10ee01f..0033d2a8123 100644 --- a/src/server/qgssldconfigparser.h +++ b/src/server/qgssldconfigparser.h @@ -40,34 +40,34 @@ class QgsSLDConfigParser : public QgsWmsConfigParser @param fullProjectInformation If true: add extended project information (does not validate against WMS schema)*/ void layersAndStylesCapabilities( QDomElement& parentElement, QDomDocument& doc, const QString& version, bool fullProjectSettings = false ) const override; - /** Returns one or possibly several maplayers for a given layer name and style. If no layers/style are found, an empty list is returned*/ + //! Returns one or possibly several maplayers for a given layer name and style. If no layers/style are found, an empty list is returned QList mapLayerFromStyle( const QString& lName, const QString& styleName, bool useCache = true ) const override; - /** Fills a layer and a style list. The two list have the same number of entries and the style and the layer at a position belong together (similar to the HTTP parameters 'Layers' and 'Styles'. Returns 0 in case of success*/ + //! Fills a layer and a style list. The two list have the same number of entries and the style and the layer at a position belong together (similar to the HTTP parameters 'Layers' and 'Styles'. Returns 0 in case of success int layersAndStyles( QStringList& layers, QStringList& styles ) const override; - /** Returns the xml fragment of a style*/ + //! Returns the xml fragment of a style QDomDocument getStyle( const QString& styleName, const QString& layerName ) const override; - /** Returns the xml fragment of layers styles*/ + //! Returns the xml fragment of layers styles QDomDocument getStyles( QStringList& layerList ) const override; - /** Returns the xml fragment of layers styles description*/ + //! Returns the xml fragment of layers styles description QDomDocument describeLayer( QStringList& layerList, const QString& hrefString ) const override; - /** Returns if output are MM or PIXEL*/ + //! Returns if output are MM or PIXEL QgsMapRenderer::OutputUnits outputUnits() const override; - /** Returns an ID-list of layers which are not queryable (comes from -> -> -> -> featureInfoLayerAliasMap() const override; QString featureInfoDocumentElement( const QString& defaultValue ) const override; @@ -76,13 +76,13 @@ class QgsSLDConfigParser : public QgsWmsConfigParser QString featureInfoSchema() const override; - /** Return feature info in format SIA2045?*/ + //! Return feature info in format SIA2045? bool featureInfoFormatSIA2045() const override; - /** Draw text annotation items from the QGIS projectfile*/ + //! Draw text annotation items from the QGIS projectfile void drawOverlays( QPainter* p, int dpi, int width, int height ) const override; - /** Load PAL engine settings from projectfile*/ + //! Load PAL engine settings from projectfile void loadLabelSettings( QgsLabelingEngineInterface* lbl ) const override; QString serviceUrl() const override; @@ -109,18 +109,18 @@ class QgsSLDConfigParser : public QgsWmsConfigParser // WMS inspire capabilities bool wmsInspireActivated() const override; - /** Adds inspire capabilities to xml document. ParentElem usually is the element*/ + //! Adds inspire capabilities to xml document. ParentElem usually is the element void inspireCapabilities( QDomElement& parentElement, QDomDocument& doc ) const override; //printing - /** Creates a print composition, usually for a GetPrint request. Replaces map and label parameters*/ + //! Creates a print composition, usually for a GetPrint request. Replaces map and label parameters QgsComposition* createPrintComposition( const QString& composerTemplate, QgsMapRenderer* mapRenderer, const QMap< QString, QString >& parameterMap, QStringList& highlightLayers ) const; - /** Creates a composition from the project file (probably delegated to the fallback parser)*/ + //! Creates a composition from the project file (probably delegated to the fallback parser) QgsComposition* initComposition( const QString& composerTemplate, QgsMapRenderer* mapRenderer, QList< QgsComposerMap*>& mapList, QList< QgsComposerLegend* >& legendList, QList< QgsComposerLabel* >& labelList, QList& htmlFrameList ) const override; - /** Adds print capabilities to xml document. ParentElem usually is the element*/ + //! Adds print capabilities to xml document. ParentElem usually is the element void printCapabilities( QDomElement& parentElement, QDomDocument& doc ) const override; void setScaleDenominator( double denom ) override; @@ -134,15 +134,15 @@ class QgsSLDConfigParser : public QgsWmsConfigParser private: - /** SLD as dom document*/ + //! SLD as dom document QDomDocument* mXMLDoc; - /** Map containing the WMS parameters of the request*/ + //! Map containing the WMS parameters of the request QMap mParameterMap; QString mSLDNamespace; - /** Output units (pixel or mm)*/ + //! Output units (pixel or mm) QgsMapRenderer::OutputUnits mOutputUnits; QgsWmsConfigParser *mFallbackParser; @@ -151,10 +151,10 @@ class QgsSLDConfigParser : public QgsWmsConfigParser QFont mLegendItemFont; - /** Stores pointers to layers that have to be removed after the request*/ + //! Stores pointers to layers that have to be removed after the request mutable QList mLayersToRemove; - /** Stores the temporary file objects. The class takes ownership of the objects and deletes them in the destructor*/ + //! Stores the temporary file objects. The class takes ownership of the objects and deletes them in the destructor mutable QList mFilesToRemove; /** Stores paths of files that need to be removed after each request (necessary because of contours shapefiles that @@ -164,16 +164,16 @@ class QgsSLDConfigParser : public QgsWmsConfigParser //default constructor forbidden QgsSLDConfigParser(); - /** Returns a list of all element that match the layer name. Returns an empty list if no such layer*/ + //! Returns a list of all element that match the layer name. Returns an empty list if no such layer QList findNamedLayerElements( const QString& layerName ) const; - /** Returns the node of a given or a null node in case of failure*/ + //! Returns the node of a given or a null node in case of failure QDomElement findUserStyleElement( const QDomElement& userLayerElement, const QString& styleName ) const; - /** Returns the node of a given or a null node in case of failure*/ + //! Returns the node of a given or a null node in case of failure QDomElement findNamedStyleElement( const QDomElement& layerElement, const QString& styleName ) const; - /** Creates a Renderer from a UserStyle SLD node. Returns 0 in case of error*/ + //! Creates a Renderer from a UserStyle SLD node. Returns 0 in case of error QgsFeatureRenderer* rendererFromUserStyle( const QDomElement& userStyleElement, QgsVectorLayer* vec ) const; /** Searches for a element and applies the settings to the vector layer @@ -188,7 +188,7 @@ class QgsSLDConfigParser : public QgsWmsConfigParser @return the layer or 0 if no layer could be created*/ QgsVectorLayer* contourLayerFromRaster( const QDomElement& userStyleElem, QgsRasterLayer* rasterLayer ) const; - /** Returns the dom node or a null node in case of failure*/ + //! Returns the dom node or a null node in case of failure QDomElement findUserLayerElement( const QString& layerName ) const; /** Creates a vector layer from a tag. @@ -197,7 +197,7 @@ class QgsSLDConfigParser : public QgsWmsConfigParser Delegates the work to specific methods for , or */ QgsMapLayer* mapLayerFromUserLayer( const QDomElement& userLayerElem, const QString& layerName, bool allowCaching = true ) const; - /** Reads attributes "epsg" or "proj" from layer element and sets specified CRS if present*/ + //! Reads attributes "epsg" or "proj" from layer element and sets specified CRS if present void setCrsForLayer( const QDomElement& layerElem, QgsMapLayer* ml ) const; bool useLayerIds() const override { return false; } diff --git a/src/server/qgssoaprequesthandler.h b/src/server/qgssoaprequesthandler.h index c683fb4cd15..14895c5b857 100644 --- a/src/server/qgssoaprequesthandler.h +++ b/src/server/qgssoaprequesthandler.h @@ -22,7 +22,7 @@ class QDomElement; -/** A handler to parse requests via SOAP/HTTP POST*/ +//! A handler to parse requests via SOAP/HTTP POST class QgsSOAPRequestHandler: public QgsHttpRequestHandler { public: @@ -37,15 +37,15 @@ class QgsSOAPRequestHandler: public QgsHttpRequestHandler void setXmlResponse( const QDomDocument& doc, const QString& mimeType ) override; void setGetPrintResponse( QByteArray* ba ) override; private: - /** Parses the xml of a getMap request and fills the parameters into the map. Returns 0 in case of success*/ + //! Parses the xml of a getMap request and fills the parameters into the map. Returns 0 in case of success int parseGetMapElement( QMap& parameterMap, const QDomElement& getMapElement ) const; - /** Parses the xml of a feature info request and fills the parameters into the map. Returns 0 in case of success*/ + //! Parses the xml of a feature info request and fills the parameters into the map. Returns 0 in case of success int parseGetFeatureInfoElement( QMap& parameterMap, const QDomElement& getMapElement ) const; int parseBoundingBoxElement( QMap& parameterMap, const QDomElement& boundingBoxElement ) const; int parseOutputAttributesElement( QMap& parameterMap, const QDomElement& outputAttributesElement ) const; int setSOAPWithAttachments( QImage* img ); int setUrlToFile( QImage* img ); - /** Reads the file wms_metadata.xml and extract the OnlineResource href. Returns 0 in case of success.*/ + //! Reads the file wms_metadata.xml and extract the OnlineResource href. Returns 0 in case of success. int findOutHostAddress( QString& address ) const; }; diff --git a/src/server/qgswcsserver.h b/src/server/qgswcsserver.h index 9fc20e17794..f82fed750ce 100644 --- a/src/server/qgswcsserver.h +++ b/src/server/qgswcsserver.h @@ -35,7 +35,7 @@ independent from any server side technology*/ class QgsWCSServer: public QgsOWSServer { public: - /** Constructor. Takes parameter map and a pointer to a renderer object (does not take ownership)*/ + //! Constructor. Takes parameter map and a pointer to a renderer object (does not take ownership) QgsWCSServer( const QString& configFilePath , QMap& parameters @@ -49,23 +49,23 @@ class QgsWCSServer: public QgsOWSServer void executeRequest() override; - /** Returns an XML file with the capabilities description (as described in the WFS specs)*/ + //! Returns an XML file with the capabilities description (as described in the WFS specs) QDomDocument getCapabilities(); - /** Returns an XML file with the describe Coverage (as described in the WCS specs)*/ + //! Returns an XML file with the describe Coverage (as described in the WCS specs) QDomDocument describeCoverage(); - /** Creates a file which is the result of the getCoverage request.*/ + //! Creates a file which is the result of the getCoverage request. QByteArray* getCoverage(); - /** Sets configuration parser for administration settings. Does not take ownership*/ + //! Sets configuration parser for administration settings. Does not take ownership void setAdminConfigParser( QgsWCSProjectParser* parser ) { mConfigParser = parser; } private: - /** Don't use the default constructor*/ + //! Don't use the default constructor QgsWCSServer(); - /** Get service address from REQUEST_URI if not specified in the configuration*/ + //! Get service address from REQUEST_URI if not specified in the configuration QString serviceUrl() const; QgsWCSProjectParser* mConfigParser; diff --git a/src/server/qgswfsserver.h b/src/server/qgswfsserver.h index ae24baeb56f..596a17fdb82 100644 --- a/src/server/qgswfsserver.h +++ b/src/server/qgswfsserver.h @@ -59,7 +59,7 @@ independent from any server side technology*/ class QgsWfsServer: public QgsOWSServer { public: - /** Constructor. Takes parameter map and a pointer to a renderer object (does not take ownership)*/ + //! Constructor. Takes parameter map and a pointer to a renderer object (does not take ownership) QgsWfsServer( const QString& configFilePath , QMap& parameters @@ -73,10 +73,10 @@ class QgsWfsServer: public QgsOWSServer void executeRequest() override; - /** Returns an XML file with the capabilities description (as described in the WFS specs)*/ + //! Returns an XML file with the capabilities description (as described in the WFS specs) QDomDocument getCapabilities(); - /** Returns an XML file with the describe feature type (as described in the WFS specs)*/ + //! Returns an XML file with the describe feature type (as described in the WFS specs) QDomDocument describeFeatureType(); /** Creates a document that describes the result of the getFeature request. @@ -87,14 +87,14 @@ class QgsWfsServer: public QgsOWSServer @return 0 in case of success*/ QDomDocument transaction( const QString& requestBody ); - /** Sets configuration parser for administration settings. Does not take ownership*/ + //! Sets configuration parser for administration settings. Does not take ownership void setAdminConfigParser( QgsWfsProjectParser* parser ) { mConfigParser = parser; } private: - /** Don't use the default constructor*/ + //! Don't use the default constructor QgsWfsServer(); - /** Get service address from REQUEST_URI if not specified in the configuration*/ + //! Get service address from REQUEST_URI if not specified in the configuration QString serviceUrl() const; /* The Type of Feature created */ diff --git a/src/server/qgswmsconfigparser.h b/src/server/qgswmsconfigparser.h index 6f354c7fabd..2159f974810 100644 --- a/src/server/qgswmsconfigparser.h +++ b/src/server/qgswmsconfigparser.h @@ -40,34 +40,34 @@ class SERVER_EXPORT QgsWmsConfigParser @param fullProjectInformation If true: add extended project information (does not validate against WMS schema)*/ virtual void layersAndStylesCapabilities( QDomElement& parentElement, QDomDocument& doc, const QString& version, bool fullProjectSettings = false ) const = 0; - /** Returns one or possibly several maplayers for a given layer name and style. If no layers/style are found, an empty list is returned*/ + //! Returns one or possibly several maplayers for a given layer name and style. If no layers/style are found, an empty list is returned virtual QList mapLayerFromStyle( const QString& lName, const QString& styleName, bool useCache = true ) const = 0; - /** Fills a layer and a style list. The two list have the same number of entries and the style and the layer at a position belong together (similar to the HTTP parameters 'Layers' and 'Styles'. Returns 0 in case of success*/ + //! Fills a layer and a style list. The two list have the same number of entries and the style and the layer at a position belong together (similar to the HTTP parameters 'Layers' and 'Styles'. Returns 0 in case of success virtual int layersAndStyles( QStringList& layers, QStringList& styles ) const = 0; - /** Returns the xml fragment of a style*/ + //! Returns the xml fragment of a style virtual QDomDocument getStyle( const QString& styleName, const QString& layerName ) const = 0; - /** Returns the xml fragment of layers styles*/ + //! Returns the xml fragment of layers styles virtual QDomDocument getStyles( QStringList& layerList ) const = 0; - /** Returns the xml fragment of layers styles description*/ + //! Returns the xml fragment of layers styles description virtual QDomDocument describeLayer( QStringList& layerList, const QString& hrefString ) const = 0; - /** Returns if output are MM or PIXEL*/ + //! Returns if output are MM or PIXEL virtual QgsMapRenderer::OutputUnits outputUnits() const = 0; - /** Returns an ID-list of layers which are not queryable (comes from -> -> -> -> featureInfoLayerAliasMap() const = 0; virtual QString featureInfoDocumentElement( const QString& defaultValue ) const = 0; @@ -76,13 +76,13 @@ class SERVER_EXPORT QgsWmsConfigParser virtual QString featureInfoSchema() const = 0; - /** Return feature info in format SIA2045?*/ + //! Return feature info in format SIA2045? virtual bool featureInfoFormatSIA2045() const = 0; - /** Draw text annotation items from the QGIS projectfile*/ + //! Draw text annotation items from the QGIS projectfile virtual void drawOverlays( QPainter* p, int dpi, int width, int height ) const = 0; - /** Load PAL engine settings from the QGIS projectfile*/ + //! Load PAL engine settings from the QGIS projectfile virtual void loadLabelSettings( QgsLabelingEngineInterface* lbl ) const = 0; virtual QString serviceUrl() const = 0; @@ -111,21 +111,21 @@ class SERVER_EXPORT QgsWmsConfigParser // WMS inspire capabilities virtual bool wmsInspireActivated() const = 0; - /** Adds inspire capabilities to xml document. ParentElem usually is the element*/ + //! Adds inspire capabilities to xml document. ParentElem usually is the element virtual void inspireCapabilities( QDomElement& parentElement, QDomDocument& doc ) const = 0; //printing - /** Creates a print composition, usually for a GetPrint request. Replaces map and label parameters*/ + //! Creates a print composition, usually for a GetPrint request. Replaces map and label parameters QgsComposition* createPrintComposition( const QString& composerTemplate, QgsMapRenderer* mapRenderer, const QMap< QString, QString >& parameterMap ) const; - /** Creates a print composition, usually for a GetPrint request. Replaces map and label parameters*/ + //! Creates a print composition, usually for a GetPrint request. Replaces map and label parameters QgsComposition* createPrintComposition( const QString& composerTemplate, QgsMapRenderer* mapRenderer, const QMap< QString, QString >& parameterMap, QStringList& highlightLayers ) const; - /** Creates a composition from the project file (probably delegated to the fallback parser)*/ + //! Creates a composition from the project file (probably delegated to the fallback parser) virtual QgsComposition* initComposition( const QString& composerTemplate, QgsMapRenderer* mapRenderer, QList< QgsComposerMap*>& mapList, QList< QgsComposerLegend* >& legendList, QList< QgsComposerLabel* >& labelList, QList& htmlFrameList ) const = 0; - /** Adds print capabilities to xml document. ParentElem usually is the element*/ + //! Adds print capabilities to xml document. ParentElem usually is the element virtual void printCapabilities( QDomElement& parentElement, QDomDocument& doc ) const = 0; virtual void setScaleDenominator( double denom ) = 0; @@ -139,12 +139,12 @@ class SERVER_EXPORT QgsWmsConfigParser virtual bool useLayerIds() const = 0; - /** Adds highlight layers to the layer registry and to the layer set. Returns the ids of the newly created layers (for later removal)*/ + //! Adds highlight layers to the layer registry and to the layer set. Returns the ids of the newly created layers (for later removal) static QStringList addHighlightLayers( const QMap& parameterMap, QStringList& layerSet, const QString& parameterPrefix = QString() ); static void removeHighlightLayers( const QStringList& layerIds ); #if 0 - /** List of GML datasets passed outside SLD (e.g. in a SOAP request). Key of the map is the layer name*/ + //! List of GML datasets passed outside SLD (e.g. in a SOAP request). Key of the map is the layer name QMap mExternalGMLDatasets; #endif //0 diff --git a/src/server/qgswmsprojectparser.h b/src/server/qgswmsprojectparser.h index 2b468787734..3a5d93a615e 100644 --- a/src/server/qgswmsprojectparser.h +++ b/src/server/qgswmsprojectparser.h @@ -82,28 +82,28 @@ class SERVER_EXPORT QgsWmsProjectParser : public QgsWmsConfigParser QList< QPair< QString, QgsLayerCoordinateTransform > > layerCoordinateTransforms() const override; - /** Fills a layer and a style list. The two list have the same number of entries and the style and the layer at a position belong together (similar to the HTTP parameters 'Layers' and 'Styles'. Returns 0 in case of success*/ + //! Fills a layer and a style list. The two list have the same number of entries and the style and the layer at a position belong together (similar to the HTTP parameters 'Layers' and 'Styles'. Returns 0 in case of success int layersAndStyles( QStringList& layers, QStringList& styles ) const override; - /** Returns the xml fragment of a style*/ + //! Returns the xml fragment of a style QDomDocument getStyle( const QString& styleName, const QString& layerName ) const override; - /** Returns the xml fragment of layers styles*/ + //! Returns the xml fragment of layers styles QDomDocument getStyles( QStringList& layerList ) const override; - /** Returns the xml fragment of layers styles description*/ + //! Returns the xml fragment of layers styles description QDomDocument describeLayer( QStringList& layerList, const QString& hrefString ) const override; - /** Returns if output are MM or PIXEL*/ + //! Returns if output are MM or PIXEL QgsMapRenderer::OutputUnits outputUnits() const override; - /** True if the feature info response should contain the wkt geometry for vector features*/ + //! True if the feature info response should contain the wkt geometry for vector features bool featureInfoWithWktGeometry() const override; - /** True if the feature info wkt geometry is delivered with segmentized curve types*/ + //! True if the feature info wkt geometry is delivered with segmentized curve types bool segmentizeFeatureInfoWktGeometry() const override; - /** Returns map with layer aliases for GetFeatureInfo (or 0 pointer if not supported). Key: layer name, Value: layer alias*/ + //! Returns map with layer aliases for GetFeatureInfo (or 0 pointer if not supported). Key: layer name, Value: layer alias QHash featureInfoLayerAliasMap() const override; QString featureInfoDocumentElement( const QString& defaultValue ) const override; @@ -112,13 +112,13 @@ class SERVER_EXPORT QgsWmsProjectParser : public QgsWmsConfigParser QString featureInfoSchema() const override; - /** Return feature info in format SIA2045?*/ + //! Return feature info in format SIA2045? bool featureInfoFormatSIA2045() const override; - /** Draw text annotation items from the QGIS projectfile*/ + //! Draw text annotation items from the QGIS projectfile void drawOverlays( QPainter* p, int dpi, int width, int height ) const override; - /** Load PAL engine settings from projectfile*/ + //! Load PAL engine settings from projectfile void loadLabelSettings( QgsLabelingEngineInterface* lbl ) const override; int nLayers() const override; @@ -136,15 +136,15 @@ class SERVER_EXPORT QgsWmsProjectParser : public QgsWmsConfigParser mutable QFont mLegendLayerFont; mutable QFont mLegendItemFont; - /** Watermark text items*/ + //! Watermark text items QList< QPair< QTextDocument*, QDomElement > > mTextAnnotationItems; - /** Watermark items (content cached in QgsSVGCache)*/ + //! Watermark items (content cached in QgsSVGCache) QList< QPair< QSvgRenderer*, QDomElement > > mSvgAnnotationElems; - /** Returns an ID-list of layers which are not queryable (comes from -> -> -> -> element)*/ + //! Reads layer drawing order from the legend section of the project file and appends it to the parent elemen (usually the element) void addDrawingOrder( QDomElement& parentElem, QDomDocument& doc, const QHash &idNameMap, const QStringList &layerIDList ) const; void addLayerStyles( QgsMapLayer* currentLayer, QDomDocument& doc, QDomElement& layerElem, const QString& version ) const; @@ -166,7 +166,7 @@ class SERVER_EXPORT QgsWmsProjectParser : public QgsWmsConfigParser const QMap &layerMap, const QStringList &nonIdentifiableLayers, const QString& strHref, QgsRectangle& combinedBBox, const QString& strGroup ) const; - /** Adds layers from a legend group to list (could be embedded or a normal group)*/ + //! Adds layers from a legend group to list (could be embedded or a normal group) void addLayersFromGroup( const QDomElement& legendGroupElem, QMap< int, QgsMapLayer*>& layers, bool useCache = true ) const; QDomElement composerByName( const QString& composerName ) const; diff --git a/src/server/qgswmsserver.h b/src/server/qgswmsserver.h index 5053531e989..5268c090a1f 100644 --- a/src/server/qgswmsserver.h +++ b/src/server/qgswmsserver.h @@ -95,13 +95,13 @@ class QgsWmsServer: public QgsOWSServer of the image object). If an instance to existing hit test structure is passed, instead of rendering it will fill the structure with symbols that would be used for rendering */ QImage* getMap( HitTest* hitTest = nullptr ); - /** GetMap request with vector format output. This output is usually symbolized (difference to WFS GetFeature)*/ + //! GetMap request with vector format output. This output is usually symbolized (difference to WFS GetFeature) void getMapAsDxf(); - /** Returns an SLD file with the style of the requested layer. Exception is raised in case of troubles :-)*/ + //! Returns an SLD file with the style of the requested layer. Exception is raised in case of troubles :-) QDomDocument getStyle(); - /** Returns an SLD file with the styles of the requested layers. Exception is raised in case of troubles :-)*/ + //! Returns an SLD file with the styles of the requested layers. Exception is raised in case of troubles :-) QDomDocument getStyles(); - /** Returns a describeLayer file with the onlineResource of the requested layers. Exception is raised in case of troubles :-)*/ + //! Returns a describeLayer file with the onlineResource of the requested layers. Exception is raised in case of troubles :-) QDomDocument describeLayer(); /** Returns printed page as binary @@ -113,14 +113,14 @@ class QgsWmsServer: public QgsOWSServer @return 0 in case of success*/ int getFeatureInfo( QDomDocument& result, const QString& version = "1.3.0" ); - /** Sets configuration parser for administration settings. Does not take ownership*/ + //! Sets configuration parser for administration settings. Does not take ownership void setAdminConfigParser( QgsWmsConfigParser* parser ) { mConfigParser = parser; } - /** Returns the schemaExtension for WMS 1.3.0 capabilities*/ + //! Returns the schemaExtension for WMS 1.3.0 capabilities QDomDocument getSchemaExtension(); private: - /** Don't use the default constructor*/ + //! Don't use the default constructor QgsWmsServer(); /** Initializes WMS layers and configures mMapRendering. @@ -161,7 +161,7 @@ class QgsWmsServer: public QgsOWSServer const QString& version, const QString& infoFormat, QgsRectangle* featureBBox = nullptr ) const; - /** Appends feature info xml for the layer to the layer element of the dom document*/ + //! Appends feature info xml for the layer to the layer element of the dom document int featureInfoFromRasterLayer( QgsRasterLayer* layer, const QgsPoint* infoPoint, QDomDocument& infoDocument, @@ -173,12 +173,12 @@ class QgsWmsServer: public QgsOWSServer @param scaleDenominator Filter out layer if scale based visibility does not match (or use -1 if no scale restriction)*/ QStringList layerSet( const QStringList& layersList, const QStringList& stylesList, const QgsCoordinateReferenceSystem& destCRS, double scaleDenominator = -1 ) const; - /** Record which symbols would be used if the map was in the current configuration of mMapRenderer. This is useful for content-based legend*/ + //! Record which symbols would be used if the map was in the current configuration of mMapRenderer. This is useful for content-based legend void runHitTest( QPainter* painter, HitTest& hitTest ); - /** Record which symbols within one layer would be rendered with the given renderer context*/ + //! Record which symbols within one layer would be rendered with the given renderer context void runHitTestLayer( QgsVectorLayer* vl, SymbolSet& usedSymbols, QgsRenderContext& context ); - /** Read legend parameter from the request or from the first print composer in the project*/ + //! Read legend parameter from the request or from the first print composer in the project void legendParameters( double& boxSpace, double& layerSpace, double& layerTitleSpace, double& symbolSpace, double& iconLabelSpace, double& symbolWidth, double& symbolHeight, QFont& layerFont, QFont& itemFont, QColor& layerFontColor, QColor& itemFontColor ); @@ -206,23 +206,23 @@ class QgsWmsServer: public QgsOWSServer /** Tests if a filter sql string is allowed (safe) @return true in case of success, false if string seems unsafe*/ bool testFilterStringSafety( const QString& filter ) const; - /** Helper function for filter safety test. Groups stringlist to merge entries starting/ending with quotes*/ + //! Helper function for filter safety test. Groups stringlist to merge entries starting/ending with quotes static void groupStringList( QStringList& list, const QString& groupString ); /** Select vector features with ids specified in parameter SELECTED, e.g. ...&SELECTED=layer1:1,2,9;layer2:3,5,10&... @return list with layer ids where selections have been created*/ QStringList applyFeatureSelections( const QStringList& layerList ) const; - /** Clear all feature selections in the given layers*/ + //! Clear all feature selections in the given layers void clearFeatureSelections( const QStringList& layerIds ) const; - /** Applies opacity on layer/group level*/ + //! Applies opacity on layer/group level void applyOpacities( const QStringList& layerList, QList< QPair< QgsVectorLayer*, QgsFeatureRenderer*> >& vectorRenderers, QList< QPair< QgsRasterLayer*, QgsRasterRenderer* > >& rasterRenderers, QList< QPair< QgsVectorLayer*, double > >& labelTransparencies, QList< QPair< QgsVectorLayer*, double > >& labelBufferTransparencies ); - /** Restore original opacities*/ + //! Restore original opacities void restoreOpacities( QList< QPair >& vectorRenderers, QList< QPair < QgsRasterLayer*, QgsRasterRenderer* > >& rasterRenderers, QList< QPair< QgsVectorLayer*, double > >& labelTransparencies, @@ -234,19 +234,19 @@ class QgsWmsServer: public QgsOWSServer @return true if width/height values are okay*/ bool checkMaximumWidthHeight() const; - /** Get service address from REQUEST_URI if not specified in the configuration*/ + //! Get service address from REQUEST_URI if not specified in the configuration QString serviceUrl() const; - /** Add ''. Some clients need an xml declaration (though it is not strictly required)*/ + //! Add ''. Some clients need an xml declaration (though it is not strictly required) void addXmlDeclaration( QDomDocument& doc ) const; - /** Converts a feature info xml document to SIA2045 norm*/ + //! Converts a feature info xml document to SIA2045 norm void convertFeatureInfoToSIA2045( QDomDocument& doc ); - /** Cleanup temporary objects (e.g. SLD parser objects or temporary files) after request*/ + //! Cleanup temporary objects (e.g. SLD parser objects or temporary files) after request void cleanupAfterRequest(); - /** Map containing the WMS parameters*/ + //! Map containing the WMS parameters QgsMapRenderer* mMapRenderer; QgsCapabilitiesCache* mCapabilitiesCache; @@ -269,19 +269,19 @@ class QgsWmsServer: public QgsOWSServer int version, QStringList* attributes = nullptr ) const; - /** Replaces attribute value with ValueRelation or ValueRelation if defined. Otherwise returns the original value*/ + //! Replaces attribute value with ValueRelation or ValueRelation if defined. Otherwise returns the original value static QString replaceValueMapAndRelation( QgsVectorLayer* vl, int idx, const QString& attributeVal ); - /** Return the image quality to use for getMap request */ + //! Return the image quality to use for getMap request int getImageQuality() const; - /** Return precision to use for GetFeatureInfo request */ + //! Return precision to use for GetFeatureInfo request int getWMSPrecision( int defaultValue ) const; - /** Gets layer search rectangle (depending on request parameter, layer type, map and layer crs)*/ + //! Gets layer search rectangle (depending on request parameter, layer type, map and layer crs) QgsRectangle featureInfoSearchRect( QgsVectorLayer* ml, QgsMapRenderer* mr, const QgsRenderContext& rct, const QgsPoint& infoPoint ) const; - /** Reads and extracts the different options in the FORMAT_OPTIONS parameter*/ + //! Reads and extracts the different options in the FORMAT_OPTIONS parameter void readFormatOptions( QMap& formatOptions ) const; void readDxfLayerSettings( QList< QPair >& layers, const QMap& formatOptionsMap ) const; }; diff --git a/tests/src/analysis/testopenstreetmap.cpp b/tests/src/analysis/testopenstreetmap.cpp index 9a900d1a832..a2e60a19224 100644 --- a/tests/src/analysis/testopenstreetmap.cpp +++ b/tests/src/analysis/testopenstreetmap.cpp @@ -31,7 +31,7 @@ class TestOpenStreetMap : public QObject void cleanupTestCase();// will be called after the last testfunction was executed. void init() ;// will be called before each testfunction is executed. void cleanup() ;// will be called after every testfunction. - /** Our tests proper begin here */ + //! Our tests proper begin here void download(); void importAndQueries(); private: diff --git a/tests/src/analysis/testqgsvectoranalyzer.cpp b/tests/src/analysis/testqgsvectoranalyzer.cpp index cfa309cb288..eee86542795 100644 --- a/tests/src/analysis/testqgsvectoranalyzer.cpp +++ b/tests/src/analysis/testqgsvectoranalyzer.cpp @@ -36,7 +36,7 @@ class TestQgsVectorAnalyzer : public QObject void cleanupTestCase();// will be called after the last testfunction was executed. void init() ;// will be called before each testfunction is executed. void cleanup() ;// will be called after every testfunction. - /** Our tests proper begin here */ + //! Our tests proper begin here void singleToMulti(); void multiToSingle(); void extractNodes(); diff --git a/tests/src/core/testqgsgeometry.cpp b/tests/src/core/testqgsgeometry.cpp index 140dccd292b..6bccf7f4ff5 100644 --- a/tests/src/core/testqgsgeometry.cpp +++ b/tests/src/core/testqgsgeometry.cpp @@ -111,13 +111,13 @@ class TestQgsGeometry : public QObject void segmentizeCircularString(); private: - /** A helper method to do a render check to see if the geometry op is as expected */ + //! A helper method to do a render check to see if the geometry op is as expected bool renderCheck( const QString& theTestName, const QString& theComment = QLatin1String( QLatin1String( "" ) ), int mismatchCount = 0 ); - /** A helper method to dump to qdebug the geometry of a multipolygon */ + //! A helper method to dump to qdebug the geometry of a multipolygon void dumpMultiPolygon( QgsMultiPolygon &theMultiPolygon ); - /** A helper method to dump to qdebug the geometry of a polygon */ + //! A helper method to dump to qdebug the geometry of a polygon void dumpPolygon( QgsPolygon &thePolygon ); - /** A helper method to dump to qdebug the geometry of a polyline */ + //! A helper method to dump to qdebug the geometry of a polyline void dumpPolyline( QgsPolyline &thePolyline ); // Release return with delete [] diff --git a/tests/src/core/testqgsmaprendererjob.cpp b/tests/src/core/testqgsmaprendererjob.cpp index 1fe8166f48b..d8f73dc3699 100644 --- a/tests/src/core/testqgsmaprendererjob.cpp +++ b/tests/src/core/testqgsmaprendererjob.cpp @@ -69,7 +69,7 @@ class TestQgsMapRendererJob : public QObject void init() {} // will be called before each testfunction is executed. void cleanup() {} // will be called after every testfunction. - /** This method tests render perfomance */ + //! This method tests render perfomance void performanceTest(); /** This unit test checks if rendering of adjacent tiles (e.g. to render images for tile caches) diff --git a/tests/src/core/testqgsvectorfilewriter.cpp b/tests/src/core/testqgsvectorfilewriter.cpp index b0226bc9171..580010e6e1d 100644 --- a/tests/src/core/testqgsvectorfilewriter.cpp +++ b/tests/src/core/testqgsvectorfilewriter.cpp @@ -67,17 +67,17 @@ class TestQgsVectorFileWriter: public QObject void cleanup() {} // will be called after every testfunction. void cleanupTestCase();// will be called after the last testfunction was executed. - /** This method tests writing a point to a shapefile */ + //! This method tests writing a point to a shapefile void createPoint(); - /** This method tests writing a polyline to a shapefile */ + //! This method tests writing a polyline to a shapefile void createLine(); - /** This method tests writing a polygon to a shapefile */ + //! This method tests writing a polygon to a shapefile void createPolygon(); - /** This method test writing multiple features to a shapefile */ + //! This method test writing multiple features to a shapefile void polygonGridTest(); - /** As above but using a projected CRS*/ + //! As above but using a projected CRS void projectedPlygonGridTest(); - /** This is a regression test ticket 1141 (broken Polish characters support since r8592) http://hub.qgis.org/issues/1141 */ + //! This is a regression test ticket 1141 (broken Polish characters support since r8592) http://hub.qgis.org/issues/1141 void regression1141(); private: