Skip to content
Permalink
Browse files

Bulk doxygen TRUE/FALSE literal conversion

  • Loading branch information
nyalldawson committed Feb 26, 2019
1 parent eed9852 commit b1b247b9f24b46d81a47c68b6bf948dd6ed923d9
Showing 457 changed files with 1,800 additions and 1,800 deletions.
@@ -120,7 +120,7 @@ class QgsChunkNode
//! Returns updater job. Not null only when in Updating state
QgsChunkQueueJob *updater() const { return mUpdater; }

//! Returns true if all child chunks are available and thus this node could be swapped to the child nodes
//! Returns TRUE if all child chunks are available and thus this node could be swapped to the child nodes
bool allChildChunksResident( QTime currentTime ) const;

//! make sure that all child nodes are at least skeleton nodes
@@ -172,7 +172,7 @@ class QgsChunkNode
//! called when bounding box
void setExactBbox( const QgsAABB &box );

//! Sets whether the node has any data to be displayed. Can be used to set to false after load returned no data
//! Sets whether the node has any data to be displayed. Can be used to set to FALSE after load returned no data
void setHasData( bool hasData ) { mHasData = hasData; }
//! Returns whether the node has any data to be displayed. If not, it will be kept as a skeleton node and will not get loaded anymore
bool hasData() const { return mHasData; }
@@ -248,7 +248,7 @@ class _3D_EXPORT Qgs3DMapSettings : public QObject

/**
* Returns terrain shading material. Diffuse color component is ignored since the diffuse component
* is provided by 2D rendered map texture. Only used when isTerrainShadingEnabled() is true.
* is provided by 2D rendered map texture. Only used when isTerrainShadingEnabled() is TRUE.
* \since QGIS 3.6
*/
QgsPhongMaterialSettings terrainShadingMaterial() const { return mTerrainShadingMaterial; }
@@ -89,7 +89,7 @@ class QgsFeature3DHandler

/**
* Called before feature iteration starts to initialize, get required attributes.
* \returns true on success (on false the handler failed to initialize and processFeature() / finalize() should not be called
* \returns TRUE on success (on FALSE the handler failed to initialize and processFeature() / finalize() should not be called
*/
virtual bool prepare( const Qgs3DRenderContext &context, QSet<QString> &attributeNames ) = 0;

@@ -112,14 +112,14 @@ class _3D_EXPORT QgsRuleBased3DRenderer : public QgsAbstract3DRenderer
/**
* Returns if this rule is active
*
* \returns True if the rule is active
* \returns TRUE if the rule is active
*/
bool active() const { return mIsActive; }

/**
* Check if this rule is an ELSE rule
*
* \returns True if this rule is an else rule
* \returns TRUE if this rule is an else rule
*/
bool isElse() const { return mElseRule; }

@@ -152,7 +152,7 @@ class _3D_EXPORT QgsRuleBased3DRenderer : public QgsAbstract3DRenderer
/**
* Sets if this rule is an ELSE rule
*
* \param iselse If true, this rule is an ELSE rule
* \param iselse If TRUE, this rule is an ELSE rule
*/
void setIsElse( bool iselse ) { mElseRule = iselse; }

@@ -262,7 +262,7 @@ class _3D_EXPORT QgsRuleBased3DRenderer : public QgsAbstract3DRenderer
*
* \param f The feature to test
* \param context The context in which the rendering happens
* \returns True if the feature shall be rendered
* \returns TRUE if the feature shall be rendered
*/
bool isFilterOK( QgsFeature &f, Qgs3DRenderContext &context ) const;

@@ -90,7 +90,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
void eliminateHorizontalTriangles() override;
//! Adds points to make the triangles better shaped (algorithm of ruppert)
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
//bool readFromTAFF(QString fileName);
@@ -160,7 +160,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
unsigned int mUnstableEdge = 0;
//! If a point has been inserted twice, its number is stored in this member
int mTwiceInsPoint = 0;
//! 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
void triangulatePolygon( QList<int> *poly, QList<int> *free, int mainedge );
@@ -170,7 +170,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
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
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
void evaluateInfluenceRegion( QgsPoint *point, int edge, QSet<int> &set );
@@ -35,9 +35,9 @@ class ANALYSIS_EXPORT HalfEdge
int mNext = -10;
//! Number of the point at which this HalfEdge points
int mPoint = -10;
//! True, if the HalfEdge belongs to a break line, false otherwise
//! True, if the HalfEdge belongs to a break line, FALSE otherwise
bool mBreak = false;
//! True, if the HalfEdge belongs to a constrained edge, false otherwise
//! True, if the HalfEdge belongs to a constrained edge, FALSE otherwise
bool mForced = false;

public:
@@ -38,7 +38,7 @@ namespace MathUtils
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
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( QgsPoint *p1, QgsPoint *p2, QgsPoint *p3, QgsPoint *result );
//! Calculates the (2 dimensional) distance from 'thepoint' to the line defined by p1 and p2
double ANALYSIS_EXPORT distPointFromLine( QgsPoint *thepoint, QgsPoint *p1, QgsPoint *p2 );
@@ -50,9 +50,9 @@ namespace MathUtils
bool ANALYSIS_EXPORT inDiametral( QgsPoint *p1, QgsPoint *p2, QgsPoint *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
double ANALYSIS_EXPORT leftOf( const QgsPoint &thepoint, const QgsPoint *p1, const QgsPoint *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( QgsPoint *p1, QgsPoint *p2, QgsPoint *p3, QgsPoint *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( QgsPoint *p1, QgsPoint *p2, QgsPoint *p3, QgsPoint *p4, QgsPoint *intersection_point );
//! Lower function
int ANALYSIS_EXPORT lower( int n, int i );
@@ -68,9 +68,9 @@ namespace MathUtils
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;
void ANALYSIS_EXPORT normalFromPoints( QgsPoint *p1, QgsPoint *p2, QgsPoint *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, QgsPoint *p1, QgsPoint *p2, QgsPoint *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
double ANALYSIS_EXPORT planeTest( QgsPoint *test, QgsPoint *pt1, QgsPoint *pt2, QgsPoint *pt3 );
@@ -42,34 +42,34 @@ class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator
NormVecDecorator( Triangulation *tin );
~NormVecDecorator() override;
int addPoint( const QgsPoint &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 SIP_OUT ) 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 SIP_OUT );
bool calcPoint( double x, double y, QgsPoint &result SIP_OUT ) 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
void eliminateHorizontalTriangles() override;
//! Estimates the first derivative a point. Return true in case of success and false otherwise
//! Estimates the first derivative a point. Return TRUE in case of success 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( QgsFeedback *feedback = nullptr );
//! 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 normally taken from 'mNormVec', except 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 normally taken from 'mNormVec', except 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, QgsPoint &p1 SIP_OUT, Vector3D *v1 SIP_OUT, QgsPoint &p2 SIP_OUT, Vector3D *v2 SIP_OUT, QgsPoint &p3 SIP_OUT, Vector3D *v3 SIP_OUT ) SIP_PYNAME( getTriangleVertices );
//! 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)
bool getTriangle( double x, double y, QgsPoint &p1 SIP_OUT, int &ptn1 SIP_OUT, Vector3D *v1 SIP_OUT, PointState *state1 SIP_OUT, QgsPoint &p2 SIP_OUT, int &ptn2 SIP_OUT, Vector3D *v2 SIP_OUT, PointState *state2 SIP_OUT, QgsPoint &p3 SIP_OUT, int &ptn3 SIP_OUT, Vector3D *v3 SIP_OUT, PointState *state3 SIP_OUT );
//! Returns the state of the point with the number 'pointno'
PointState getState( int pointno ) const;
//! 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)
bool swapEdge( double x, double y ) override;

bool saveTriangulation( QgsFeatureSink *sink, QgsFeedback *feedback = nullptr ) const override;

protected:
//! Is true, if the normals already have been estimated
//! Is TRUE, if the normals already have been estimated
bool alreadyestimated;
static const unsigned int DEFAULT_STORAGE_FOR_NORMALS = 100000;
//! Association with an interpolator object
@@ -62,7 +62,7 @@ class ANALYSIS_EXPORT Triangulation

/**
* 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
* \returns TRUE in case of success and FALSE in case of failure
*/
virtual bool calcNormal( double x, double y, Vector3D *result SIP_OUT ) = 0;

@@ -71,7 +71,7 @@ class ANALYSIS_EXPORT Triangulation

/**
* 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
* Returns TRUE in case of success and flase in case of failure
*/
virtual bool calcPoint( double x, double y, QgsPoint &result SIP_OUT ) = 0;

@@ -150,7 +150,7 @@ class ANALYSIS_EXPORT Triangulation
//! 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
@@ -177,7 +177,7 @@ class ANALYSIS_EXPORT Triangulation
* The sink must be setup to accept LineString features, with fields matching
* those returned by triangulationFields().
*
* \returns true in case of success
* \returns TRUE in case of success
*
* \see triangulationFields()
* \since QGIS 3.0
@@ -93,7 +93,7 @@ class ANALYSIS_EXPORT QgsTinInterpolator: public QgsInterpolator
* Inserts the vertices of a feature into the triangulation
* \param f the feature
* \param source source for feature values to interpolate
* \param attr interpolation attribute index (if zCoord is false)
* \param attr interpolation attribute index (if zCoord is FALSE)
* \param type point/structure line, break line
* \returns 0 in case of success, -1 if the feature could not be inserted because of numerical problems
*/
@@ -132,7 +132,7 @@ class ANALYSIS_EXPORT QgsMeshCalcNode
* Calculates result of mesh calculation
* \param dsu utils with initial conditions for calculation (times, dataset groups)
* \param result destination dataset group for calculation results
* \returns true on success, false on failure
* \returns TRUE on success, FALSE on failure
*/
bool calculate( const QgsMeshCalcUtils &dsu, QgsMeshMemoryDatasetGroup &result ) const;

@@ -98,7 +98,7 @@ class ANALYSIS_EXPORT QgsMeshCalcUtils
//! Creates a single dataset with custom number
void number( QgsMeshMemoryDatasetGroup &group1, double val ) const;

//! If condition is true (for given time&point), takes val from trueGroup else from falseGroup
//! If condition is TRUE (for given time&point), takes val from trueGroup else from falseGroup
void addIf( QgsMeshMemoryDatasetGroup &trueGroup,
const QgsMeshMemoryDatasetGroup &falseGroup,
const QgsMeshMemoryDatasetGroup &condition ) const;
@@ -91,7 +91,7 @@ class ANALYSIS_EXPORT QgsReclassifyUtils
* will be used wherever the source raster has a no data value or a source pixel value
* does not have a matching class.
*
* If \a useNoDataForMissingValues is true, then any raster values which do not match to
* If \a useNoDataForMissingValues is TRUE, then any raster values which do not match to
* a class will be changed to the no data value. Otherwise they are saved unchanged.
*
* The \a feedback argument gives an optional processing feedback, for progress reports
@@ -110,10 +110,10 @@ class ANALYSIS_EXPORT QgsReclassifyUtils
/**
* Reclassifies a single \a input value, using the specified list of \a classes.
*
* If a matching class was found, then \a reclassified will be set to true and the
* If a matching class was found, then \a reclassified will be set to TRUE and the
* class output value returned.
*
* If no matching class was found then \a reclassified will be set to false, and the
* If no matching class was found then \a reclassified will be set to FALSE, and the
* original \a input value returned unchanged.
*/
static double reclassifyValue( const QVector< RasterClass > &classes, double input, bool &reclassified )

0 comments on commit b1b247b

Please sign in to comment.
You can’t perform that action at this time.