\return -> \returns (for consistency)

This commit is contained in:
Nyall Dawson 2017-04-03 10:31:30 +10:00
parent e4daf8ea62
commit e47073b1e1
270 changed files with 1083 additions and 1083 deletions

View File

@ -101,7 +101,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
virtual QList<int> *getPointsAroundEdge( double x, double y ) override; virtual QList<int> *getPointsAroundEdge( double x, double y ) override;
/** Saves the triangulation as a (line) shapefile /** Saves the triangulation as a (line) shapefile
\return true in case of success*/ \returns true in case of success*/
virtual bool saveAsShapefile( const QString &fileName ) const override; virtual bool saveAsShapefile( const QString &fileName ) const override;
protected: protected:

View File

@ -66,7 +66,7 @@ class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator
virtual bool swapEdge( double x, double y ) override; virtual bool swapEdge( double x, double y ) override;
/** Saves the triangulation as a (line) shapefile /** Saves the triangulation as a (line) shapefile
\return true in case of success*/ \returns true in case of success*/
virtual bool saveAsShapefile( const QString &fileName ) const override; virtual bool saveAsShapefile( const QString &fileName ) const override;
protected: protected:

View File

@ -52,7 +52,7 @@ class ANALYSIS_EXPORT Triangulation
/** /**
* Calculates the normal at a point on the surface and assigns it to 'result'. * Calculates the normal at a point on the surface and assigns it to 'result'.
* \return 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 ) = 0; virtual bool calcNormal( double x, double y, Vector3D *result ) = 0;
@ -148,7 +148,7 @@ class ANALYSIS_EXPORT Triangulation
/** /**
* Saves the triangulation as a (line) shapefile * Saves the triangulation as a (line) shapefile
* \return true in case of success * \returns true in case of success
*/ */
virtual bool saveAsShapefile( const QString &fileName ) const = 0; virtual bool saveAsShapefile( const QString &fileName ) const = 0;
}; };

View File

@ -35,7 +35,7 @@ class ANALYSIS_EXPORT QgsGridFileWriter
/** Writes the grid file. /** Writes the grid file.
\param showProgressDialog shows a dialog with the possibility to cancel \param showProgressDialog shows a dialog with the possibility to cancel
\return 0 in case of success*/ \returns 0 in case of success*/
int writeFile( bool showProgressDialog = false ); int writeFile( bool showProgressDialog = false );

View File

@ -33,7 +33,7 @@ class ANALYSIS_EXPORT QgsIDWInterpolator: public QgsInterpolator
\param x x-coordinate (in map units) \param x x-coordinate (in map units)
\param y y-coordinate (in map units) \param y y-coordinate (in map units)
\param result out: interpolation result \param result out: interpolation result
\return 0 in case of success*/ \returns 0 in case of success*/
int interpolatePoint( double x, double y, double &result ) override; int interpolatePoint( double x, double y, double &result ) override;
void setDistanceCoefficient( double p ) {mDistanceCoefficient = p;} void setDistanceCoefficient( double p ) {mDistanceCoefficient = p;}

View File

@ -63,7 +63,7 @@ class ANALYSIS_EXPORT QgsInterpolator
\param x x-coordinate (in map units) \param x x-coordinate (in map units)
\param y y-coordinate (in map units) \param y y-coordinate (in map units)
\param result out: interpolation result \param result out: interpolation result
\return 0 in case of success*/ \returns 0 in case of success*/
virtual int interpolatePoint( double x, double y, double &result ) = 0; virtual int interpolatePoint( double x, double y, double &result ) = 0;
//! \note not available in Python bindings //! \note not available in Python bindings
@ -73,7 +73,7 @@ class ANALYSIS_EXPORT QgsInterpolator
/** Caches the vertex and value data from the provider. All the vertex data /** Caches the vertex and value data from the provider. All the vertex data
will be held in virtual memory will be held in virtual memory
\return 0 in case of success*/ \returns 0 in case of success*/
int cacheBaseData(); int cacheBaseData();
QVector<vertexData> mCachedBaseData; QVector<vertexData> mCachedBaseData;
@ -91,7 +91,7 @@ class ANALYSIS_EXPORT QgsInterpolator
\param geom the geometry \param geom the geometry
\param zCoord true if the z-coordinate of the geometry is to be interpolated \param zCoord true if the z-coordinate of the geometry is to be interpolated
\param attributeValue the attribute value for interpolation (if not interpolated from z-coordinate) \param attributeValue the attribute value for interpolation (if not interpolated from z-coordinate)
\return 0 in case of success*/ \returns 0 in case of success*/
int addVerticesToCache( const QgsGeometry &geom, bool zCoord, double attributeValue ); int addVerticesToCache( const QgsGeometry &geom, bool zCoord, double attributeValue );
}; };

View File

@ -44,7 +44,7 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
\param x x-coordinate (in map units) \param x x-coordinate (in map units)
\param y y-coordinate (in map units) \param y y-coordinate (in map units)
\param result out: interpolation result \param result out: interpolation result
\return 0 in case of success*/ \returns 0 in case of success*/
int interpolatePoint( double x, double y, double &result ) override; int interpolatePoint( double x, double y, double &result ) override;
void setExportTriangulationToFile( bool e ) {mExportTriangulationToFile = e;} void setExportTriangulationToFile( bool e ) {mExportTriangulationToFile = e;}
@ -70,7 +70,7 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
\param zCoord true if the z coordinate is the interpolation attribute \param zCoord true if the z coordinate is the interpolation attribute
\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 \param type point/structure line, break line
\return 0 in case of success, -1 if the feature could not be inserted because of numerical problems*/ \returns 0 in case of success, -1 if the feature could not be inserted because of numerical problems*/
int insertData( QgsFeature *f, bool zCoord, int attr, InputType type ); int insertData( QgsFeature *f, bool zCoord, int attr, InputType type );
}; };

View File

@ -167,7 +167,7 @@ class ANALYSIS_EXPORT QgsGraph
/** /**
* Find vertex by associated point * Find vertex by associated point
* \return vertex index * \returns vertex index
*/ */
int findVertex( const QgsPoint &pt ) const; int findVertex( const QgsPoint &pt ) const;

View File

@ -45,7 +45,7 @@ class ANALYSIS_EXPORT QgsNetworkStrategy
/** /**
* Returns list of the source layer attributes needed for cost calculation. * Returns list of the source layer attributes needed for cost calculation.
* This method called by QgsGraphDirector. * This method called by QgsGraphDirector.
* \return list of required attributes * \returns list of required attributes
*/ */
virtual QgsAttributeList requiredAttributes() const { return QgsAttributeList(); } virtual QgsAttributeList requiredAttributes() const { return QgsAttributeList(); }

View File

@ -69,13 +69,13 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject
* *
* Only one request may be pending at one point - if you need more requests at once, use several instances. * Only one request may be pending at one point - if you need more requests at once, use several instances.
* *
* \return true if the network request has been issued, false otherwise (and sets error string) * \returns true if the network request has been issued, false otherwise (and sets error string)
*/ */
bool start(); bool start();
/** /**
* @brief Aborts current pending request * @brief Aborts current pending request
* \return true if there is a pending request and has been aborted, false otherwise * \returns true if there is a pending request and has been aborted, false otherwise
*/ */
bool abort(); bool abort();

View File

@ -56,7 +56,7 @@ class ANALYSIS_EXPORT QgsOSMXmlImport : public QObject
/** /**
* Run import. This will parse the XML file and store the data in a SQLite database. * Run import. This will parse the XML file and store the data in a SQLite database.
* \return true on success, false when import failed (see errorString() for the error) * \returns true on success, false when import failed (see errorString() for the error)
*/ */
bool import(); bool import();

View File

@ -145,7 +145,7 @@ class ANALYSIS_EXPORT QgsAlignRaster
{ {
//! Method to be overridden for progress reporting. //! Method to be overridden for progress reporting.
//! \param complete Overall progress of the alignment operation //! \param complete Overall progress of the alignment operation
//! \return false if the execution should be canceled, true otherwise //! \returns false if the execution should be canceled, true otherwise
virtual bool progress( double complete ) = 0; virtual bool progress( double complete ) = 0;
virtual ~ProgressHandler() = default; virtual ~ProgressHandler() = default;
@ -194,14 +194,14 @@ class ANALYSIS_EXPORT QgsAlignRaster
//! If a custom CRS is provided, suggested reprojection is calculated first (using GDAL) in order //! If a custom CRS is provided, suggested reprojection is calculated first (using GDAL) in order
//! to determine suitable defaults for cell size and grid offset. //! to determine suitable defaults for cell size and grid offset.
//! //!
//! \return true on success (may fail if it is not possible to reproject raster to given CRS) //! \returns true on success (may fail if it is not possible to reproject raster to given CRS)
bool setParametersFromRaster( const RasterInfo &rasterInfo, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) ); bool setParametersFromRaster( const RasterInfo &rasterInfo, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );
//! Overridden variant for convenience, taking filename instead RasterInfo object. //! Overridden variant for convenience, taking filename instead RasterInfo object.
//! See the other variant for details. //! See the other variant for details.
bool setParametersFromRaster( const QString &filename, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) ); bool setParametersFromRaster( const QString &filename, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );
//! Determine destination extent from the input rasters and calculate derived values //! Determine destination extent from the input rasters and calculate derived values
//! \return true on success, sets error on error (see errorMessage()) //! \returns true on success, sets error on error (see errorMessage())
bool checkInputParameters(); bool checkInputParameters();
//! Return expected size of the resulting aligned raster //! Return expected size of the resulting aligned raster
@ -212,7 +212,7 @@ class ANALYSIS_EXPORT QgsAlignRaster
QgsRectangle alignedRasterExtent() const; QgsRectangle alignedRasterExtent() const;
//! Run the alignment process //! Run the alignment process
//! \return true on success, sets error on error (see errorMessage()) //! \returns true on success, sets error on error (see errorMessage())
bool run(); bool run();
//! Return error from a previous run() call. //! Return error from a previous run() call.

View File

@ -38,7 +38,7 @@ class ANALYSIS_EXPORT QgsNineCellFilter
/** Starts the calculation, reads from mInputFile and stores the result in mOutputFile /** Starts the calculation, reads from mInputFile and stores the result in mOutputFile
\param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed. \param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed.
\return 0 in case of success*/ \returns 0 in case of success*/
int processRaster( QProgressDialog *p ); int processRaster( QProgressDialog *p );
double cellSizeX() const { return mCellSizeX; } double cellSizeX() const { return mCellSizeX; }
@ -68,11 +68,11 @@ class ANALYSIS_EXPORT QgsNineCellFilter
GDALDatasetH openInputFile( int &nCellsX, int &nCellsY ); GDALDatasetH openInputFile( int &nCellsX, int &nCellsY );
/** Opens the output driver and tests if it supports the creation of a new dataset /** 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*/ \returns nullptr on error and the driver handle on success*/
GDALDriverH openOutputDriver(); GDALDriverH openOutputDriver();
/** Opens the output file and sets the same geotransform and CRS as the input data /** Opens the output file and sets the same geotransform and CRS as the input data
\return the output dataset or nullptr in case of error*/ \returns the output dataset or nullptr in case of error*/
GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver ); GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver );
protected: protected:

View File

@ -81,7 +81,7 @@ class ANALYSIS_EXPORT QgsRasterCalculator
/** Starts the calculation and writes new raster /** Starts the calculation and writes new raster
\param p progress bar (or 0 if called from non-gui code) \param p progress bar (or 0 if called from non-gui code)
\return 0 in case of success*/ \returns 0 in case of success*/
//TODO QGIS 3.0 - return QgsRasterCalculator::Result //TODO QGIS 3.0 - return QgsRasterCalculator::Result
int processCalculation( QProgressDialog *p = nullptr ); int processCalculation( QProgressDialog *p = nullptr );
@ -90,11 +90,11 @@ class ANALYSIS_EXPORT QgsRasterCalculator
QgsRasterCalculator(); QgsRasterCalculator();
/** Opens the output driver and tests if it supports the creation of a new dataset /** 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*/ \returns nullptr on error and the driver handle on success*/
GDALDriverH openOutputDriver(); GDALDriverH openOutputDriver();
/** Opens the output file and sets the same geotransform and CRS as the input data /** Opens the output file and sets the same geotransform and CRS as the input data
\return the output dataset or nullptr in case of error*/ \returns the output dataset or nullptr in case of error*/
GDALDatasetH openOutputFile( GDALDriverH outputDriver ); GDALDatasetH openOutputFile( GDALDriverH outputDriver );
/** Sets gdal 6 parameters array from mOutputRectangle, mNumOutputColumns, mNumOutputRows /** Sets gdal 6 parameters array from mOutputRectangle, mNumOutputColumns, mNumOutputRows

View File

@ -53,7 +53,7 @@ class ANALYSIS_EXPORT QgsRelief
/** Starts the calculation, reads from mInputFile and stores the result in mOutputFile /** Starts the calculation, reads from mInputFile and stores the result in mOutputFile
\param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed. \param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed.
\return 0 in case of success*/ \returns 0 in case of success*/
int processRaster( QProgressDialog *p ); int processRaster( QProgressDialog *p );
double zFactor() const { return mZFactor; } double zFactor() const { return mZFactor; }
@ -65,7 +65,7 @@ class ANALYSIS_EXPORT QgsRelief
void setReliefColors( const QList< ReliefColor > &c ) { mReliefColors = c; } void setReliefColors( const QList< ReliefColor > &c ) { mReliefColors = c; }
/** Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression /** Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression
\return true in case of success*/ \returns true in case of success*/
QList< ReliefColor > calculateOptimizedReliefClasses(); QList< ReliefColor > calculateOptimizedReliefClasses();
//! Write frequency of elevation values to file for manual inspection //! Write frequency of elevation values to file for manual inspection
@ -102,11 +102,11 @@ class ANALYSIS_EXPORT QgsRelief
GDALDatasetH openInputFile( int &nCellsX, int &nCellsY ); GDALDatasetH openInputFile( int &nCellsX, int &nCellsY );
/** Opens the output driver and tests if it supports the creation of a new dataset /** 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*/ \returns nullptr on error and the driver handle on success*/
GDALDriverH openOutputDriver(); GDALDriverH openOutputDriver();
/** Opens the output file and sets the same geotransform and CRS as the input data /** Opens the output file and sets the same geotransform and CRS as the input data
\return the output dataset or nullptr in case of error*/ \returns the output dataset or nullptr in case of error*/
GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver ); GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver );
//! Set elevation color //! Set elevation color
@ -116,7 +116,7 @@ class ANALYSIS_EXPORT QgsRelief
void setDefaultReliefColors(); void setDefaultReliefColors();
/** Returns class (0-255) for an elevation value /** Returns class (0-255) for an elevation value
\return elevation class or -1 in case of error*/ \returns elevation class or -1 in case of error*/
int frequencyClassForElevation( double elevation, double minElevation, double elevationClassRange ); 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<int> &breaks, double *frequencies ); void optimiseClassBreaks( QList<int> &breaks, double *frequencies );

View File

@ -34,7 +34,7 @@ class ANALYSIS_EXPORT QgsPointSample
QgsPointSample( QgsVectorLayer *inputLayer, const QString &outputLayer, const QString &nPointsAttribute, const QString &minDistAttribute = QString() ); QgsPointSample( QgsVectorLayer *inputLayer, const QString &outputLayer, const QString &nPointsAttribute, const QString &minDistAttribute = QString() );
/** Starts calculation of random points /** Starts calculation of random points
\return 0 in case of success*/ \returns 0 in case of success*/
int createRandomPoints( QProgressDialog *pd ); int createRandomPoints( QProgressDialog *pd );
private: private:

View File

@ -82,7 +82,7 @@ class ANALYSIS_EXPORT QgsTransectSample
\param dist out: distance between the segments \param dist out: distance between the segments
\param pt1 out: closest point on first geometry \param pt1 out: closest point on first geometry
\param pt2 out: closest point on secont geometry \param pt2 out: closest point on secont geometry
\return true in case of success*/ \returns true in case of success*/
static bool closestSegmentPoints( const QgsGeometry &g1, const QgsGeometry &g2, double &dist, QgsPoint &pt1, QgsPoint &pt2 ); 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 ); static QgsGeometry closestMultilineElement( const QgsPoint &pt, const QgsGeometry &multiLine );
@ -91,7 +91,7 @@ class ANALYSIS_EXPORT QgsTransectSample
\param stratumGeom stratum polygon \param stratumGeom stratum polygon
\param clippedBaseline base line geometry clipped to the stratum \param clippedBaseline base line geometry clipped to the stratum
\param tolerance buffer distance (in layer units) \param tolerance buffer distance (in layer units)
\return clipped buffer line or 0 in case of error*/ \returns clipped buffer line or 0 in case of error*/
QgsGeometry *clipBufferLine( const QgsGeometry &stratumGeom, QgsGeometry *clippedBaseline, double tolerance ); 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

View File

@ -63,7 +63,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics
Statistics stats = Statistics( Count | Sum | Mean ) ); Statistics stats = Statistics( Count | Sum | Mean ) );
/** Starts the calculation /** Starts the calculation
\return 0 in case of success*/ \returns 0 in case of success*/
int calculateStatistics( QProgressDialog *p ); int calculateStatistics( QProgressDialog *p );
private: private:
@ -111,7 +111,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics
}; };
/** Analysis what cells need to be considered to cover the bounding box of a feature /** Analysis what cells need to be considered to cover the bounding box of a feature
\return 0 in case of success*/ \returns 0 in case of success*/
int cellInfoForBBox( const QgsRectangle &rasterBBox, const QgsRectangle &featureBBox, double cellSizeX, double cellSizeY, int cellInfoForBBox( const QgsRectangle &rasterBBox, const QgsRectangle &featureBBox, double cellSizeX, double cellSizeY,
int &offsetX, int &offsetY, int &nCellsX, int &nCellsY ) const; int &offsetX, int &offsetY, int &nCellsX, int &nCellsY ) const;

View File

@ -35,7 +35,7 @@ class dxfRW
* components being added. * components being added.
* \param interface_ the interface to use * \param interface_ the interface to use
* \param ext should the extrusion be applied to convert in 2D? * \param ext should the extrusion be applied to convert in 2D?
* \return true for success * \returns true for success
*/ */
bool read( DRW_Interface *interface_, bool ext ); bool read( DRW_Interface *interface_, bool ext );
void setBinary( bool b ) {binFile = b;} void setBinary( bool b ) {binFile = b;}

View File

@ -117,13 +117,13 @@ class QWT_POLAR_EXPORT QwtPolarCurve: public QwtPolarItem
PrivateData *d_data; PrivateData *d_data;
}; };
//! \return the curve data //! \returns the curve data
inline QwtData &QwtPolarCurve::data() inline QwtData &QwtPolarCurve::data()
{ {
return *d_points; return *d_points;
} }
//! \return the curve data //! \returns the curve data
inline const QwtData &QwtPolarCurve::data() const inline const QwtData &QwtPolarCurve::data() const
{ {
return *d_points; return *d_points;
@ -131,7 +131,7 @@ inline const QwtData &QwtPolarCurve::data() const
/*! /*!
\param i index \param i index
\return azimuth at position i \returns azimuth at position i
*/ */
inline double QwtPolarCurve::azimuth( int i ) const inline double QwtPolarCurve::azimuth( int i ) const
{ {
@ -140,7 +140,7 @@ inline double QwtPolarCurve::azimuth( int i ) const
/*! /*!
\param i index \param i index
\return radius at position i \returns radius at position i
*/ */
inline double QwtPolarCurve::radius( int i ) const inline double QwtPolarCurve::radius( int i ) const
{ {
@ -149,7 +149,7 @@ inline double QwtPolarCurve::radius( int i ) const
/*! /*!
\param i index \param i index
\return point at position i \returns point at position i
*/ */
inline QwtPolarPoint QwtPolarCurve::sample( int i ) const inline QwtPolarPoint QwtPolarCurve::sample( int i ) const
{ {

View File

@ -143,7 +143,7 @@ private:
PrivateData *d_data; PrivateData *d_data;
}; };
//! \return the curve data //! \returns the curve data
inline const QwtSeriesData<QwtPointPolar> *QwtPolarCurve::data() const inline const QwtSeriesData<QwtPointPolar> *QwtPolarCurve::data() const
{ {
return d_series; return d_series;
@ -151,7 +151,7 @@ inline const QwtSeriesData<QwtPointPolar> *QwtPolarCurve::data() const
/*! /*!
\param i index \param i index
\return point at position i \returns point at position i
*/ */
inline QwtPointPolar QwtPolarCurve::sample( int i ) const inline QwtPointPolar QwtPolarCurve::sample( int i ) const
{ {

View File

@ -141,7 +141,7 @@ private:
PrivateData *d_data; PrivateData *d_data;
}; };
//! \return the the curve data //! \returns the the curve data
inline const QwtSeriesData<QwtPointPolar> *QwtPolarCurve::data() const inline const QwtSeriesData<QwtPointPolar> *QwtPolarCurve::data() const
{ {
return d_series; return d_series;
@ -149,7 +149,7 @@ inline const QwtSeriesData<QwtPointPolar> *QwtPolarCurve::data() const
/*! /*!
\param i index \param i index
\return point at position i \returns point at position i
*/ */
inline QwtPointPolar QwtPolarCurve::sample( int i ) const inline QwtPointPolar QwtPolarCurve::sample( int i ) const
{ {

View File

@ -101,7 +101,7 @@ class QgsMapToolNodeTool: public QgsMapToolEdit
* Function to check if selected feature exists and is same with original one * Function to check if selected feature exists and is same with original one
* stored in internal structures * stored in internal structures
* \param vlayer vector layer for checking * \param vlayer vector layer for checking
* \return if feature is same as one in internal structures * \returns if feature is same as one in internal structures
*/ */
bool checkCorrectnessOfFeature( QgsVectorLayer *vlayer ); bool checkCorrectnessOfFeature( QgsVectorLayer *vlayer );
@ -124,7 +124,7 @@ class QgsMapToolNodeTool: public QgsMapToolEdit
This is useful for snapping operations that just require a position to snap to and not all the This is useful for snapping operations that just require a position to snap to and not all the
snapping results. If the list is empty, the screen coordinates are transformed into map coordinates and returned snapping results. If the list is empty, the screen coordinates are transformed into map coordinates and returned
\param snapResults results collected from the snapping operation. \param snapResults results collected from the snapping operation.
\return the snapped point in map coordinates*/ \returns the snapped point in map coordinates*/
QgsPoint snapPointFromResults( const QList<QgsSnappingResult> &snapResults, QPoint screenCoords ); QgsPoint snapPointFromResults( const QList<QgsSnappingResult> &snapResults, QPoint screenCoords );
/** Inserts vertices to the snapped segments of the editing layer. /** Inserts vertices to the snapped segments of the editing layer.
@ -132,7 +132,7 @@ class QgsMapToolNodeTool: public QgsMapToolEdit
\param snapResults results collected from the snapping operation \param snapResults results collected from the snapping operation
\param editedLayer pointer to the editing layer \param editedLayer pointer to the editing layer
\param skipFids set of feature IDs to avoid inserting vertices in \param skipFids set of feature IDs to avoid inserting vertices in
\return 0 in case of success*/ \returns 0 in case of success*/
int insertSegmentVerticesForSnap( const QList<QgsSnappingResult> &snapResults, QgsVectorLayer *editedLayer, const QgsFeatureIds &skipFids ); int insertSegmentVerticesForSnap( const QList<QgsSnappingResult> &snapResults, QgsVectorLayer *editedLayer, const QgsFeatureIds &skipFids );
/** Snapper object that reads the settings from project and option /** Snapper object that reads the settings from project and option

View File

@ -97,19 +97,19 @@ class QgsSelectedFeature: public QObject
/** /**
* Tells if vertex is selected * Tells if vertex is selected
* \param vertexNr number of vertex for which we are getting info * \param vertexNr number of vertex for which we are getting info
* \return true if vertex is selected, false otherwise * \returns true if vertex is selected, false otherwise
*/ */
bool isSelected( int vertexNr ); bool isSelected( int vertexNr );
/** /**
* Getting feature Id of feature selected * Getting feature Id of feature selected
* \return feature id of selected feature * \returns feature id of selected feature
*/ */
QgsFeatureId featureId(); QgsFeatureId featureId();
/** /**
* Getting vertex map of vertexes * Getting vertex map of vertexes
* \return currently used vertex map * \returns currently used vertex map
*/ */
QList<QgsVertexEntry *> &vertexMap(); QList<QgsVertexEntry *> &vertexMap();
@ -120,7 +120,7 @@ class QgsSelectedFeature: public QObject
/** /**
* Get the layer of the selected feature * Get the layer of the selected feature
* \return used vector layer * \returns used vector layer
*/ */
QgsVectorLayer *vlayer(); QgsVectorLayer *vlayer();

View File

@ -342,7 +342,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
/** Get a unique title from user for new and duplicate composers /** Get a unique title from user for new and duplicate composers
* \param acceptEmpty whether to accept empty titles (one will be generated) * \param acceptEmpty whether to accept empty titles (one will be generated)
* \param currentTitle base name for initial title choice * \param currentTitle base name for initial title choice
* \return QString::null if user cancels input dialog * \returns QString::null if user cancels input dialog
*/ */
bool uniqueComposerTitle( QWidget *parent, QString &composerTitle, bool acceptEmpty, const QString &currentTitle = QString() ); 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
@ -366,7 +366,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
/** /**
* Access the vector layer tools. This will be an instance of {@see QgsGuiVectorLayerTools} * Access the vector layer tools. This will be an instance of {@see QgsGuiVectorLayerTools}
* by default. * by default.
* \return The vector layer tools * \returns The vector layer tools
*/ */
QgsVectorLayerTools *vectorLayerTools() { return mVectorLayerTools; } QgsVectorLayerTools *vectorLayerTools() { return mVectorLayerTools; }
@ -991,7 +991,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
* with the returned QAction. * with the returned QAction.
* *
* \param widget widget to add. The toolbar will take ownership of this widget * \param widget widget to add. The toolbar will take ownership of this widget
* \return the QAction you can use to remove this widget from the toolbar * \returns the QAction you can use to remove this widget from the toolbar
*/ */
QAction *addPluginToolBarWidget( QWidget *widget ); QAction *addPluginToolBarWidget( QWidget *widget );
//! Remove an icon from the plugin toolbar //! Remove an icon from the plugin toolbar
@ -1005,7 +1005,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
* with the returned QAction. * with the returned QAction.
* *
* \param widget widget to add. The toolbar will take ownership of this widget * \param widget widget to add. The toolbar will take ownership of this widget
* \return the QAction you can use to remove this widget from the toolbar * \returns the QAction you can use to remove this widget from the toolbar
*/ */
QAction *addRasterToolBarWidget( QWidget *widget ); QAction *addRasterToolBarWidget( QWidget *widget );
//! Remove an icon from the Raster toolbar //! Remove an icon from the Raster toolbar
@ -1019,7 +1019,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
* with the returned QAction. * with the returned QAction.
* *
* \param widget widget to add. The toolbar will take ownership of this widget * \param widget widget to add. The toolbar will take ownership of this widget
* \return the QAction you can use to remove this widget from the toolbar * \returns the QAction you can use to remove this widget from the toolbar
*/ */
QAction *addVectorToolBarWidget( QWidget *widget ); QAction *addVectorToolBarWidget( QWidget *widget );
//! Remove an icon from the Vector toolbar //! Remove an icon from the Vector toolbar
@ -1033,7 +1033,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
* with the returned QAction. * with the returned QAction.
* *
* \param widget widget to add. The toolbar will take ownership of this widget * \param widget widget to add. The toolbar will take ownership of this widget
* \return the QAction you can use to remove this widget from the toolbar * \returns the QAction you can use to remove this widget from the toolbar
*/ */
QAction *addDatabaseToolBarWidget( QWidget *widget ); QAction *addDatabaseToolBarWidget( QWidget *widget );
//! Remove an icon from the Database toolbar //! Remove an icon from the Database toolbar
@ -1047,7 +1047,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
* with the returned QAction. * with the returned QAction.
* *
* \param widget widget to add. The toolbar will take ownership of this widget * \param widget widget to add. The toolbar will take ownership of this widget
* \return the QAction you can use to remove this widget from the toolbar * \returns the QAction you can use to remove this widget from the toolbar
*/ */
QAction *addWebToolBarWidget( QWidget *widget ); QAction *addWebToolBarWidget( QWidget *widget );
//! Remove an icon from the Web toolbar //! Remove an icon from the Web toolbar
@ -1573,7 +1573,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
bool checkTasksDependOnProject(); bool checkTasksDependOnProject();
/** Helper function to union several geometries together (used in function mergeSelectedFeatures) /** Helper function to union several geometries together (used in function mergeSelectedFeatures)
\return empty geometry in case of error or if canceled */ \returns empty geometry in case of error or if canceled */
QgsGeometry unionGeometries( const QgsVectorLayer *vl, QgsFeatureList &featureList, bool &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
@ -1589,7 +1589,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
/** Paste features from clipboard into a new memory layer. /** Paste features from clipboard into a new memory layer.
* If no features are in clipboard an empty layer is returned. * If no features are in clipboard an empty layer is returned.
* \return pointer to a new layer or 0 if failed * \returns pointer to a new layer or 0 if failed
*/ */
QgsVectorLayer *pasteToNewMemoryVector(); QgsVectorLayer *pasteToNewMemoryVector();

View File

@ -95,7 +95,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
* with the returned QAction. * with the returned QAction.
* *
* \param widget widget to add. The toolbar will take ownership of this widget * \param widget widget to add. The toolbar will take ownership of this widget
* \return the QAction you can use to remove this widget from the toolbar * \returns the QAction you can use to remove this widget from the toolbar
*/ */
QAction *addToolBarWidget( QWidget *widget ) override; QAction *addToolBarWidget( QWidget *widget ) override;
//! Remove an icon (action) from the plugin toolbar //! Remove an icon (action) from the plugin toolbar
@ -109,7 +109,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
* with the returned QAction. * with the returned QAction.
* *
* \param widget widget to add. The toolbar will take ownership of this widget * \param widget widget to add. The toolbar will take ownership of this widget
* \return the QAction you can use to remove this widget from the toolbar * \returns the QAction you can use to remove this widget from the toolbar
*/ */
QAction *addRasterToolBarWidget( QWidget *widget ) override; QAction *addRasterToolBarWidget( QWidget *widget ) override;
//! Remove an icon (action) from the Raster toolbar //! Remove an icon (action) from the Raster toolbar
@ -123,7 +123,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
* with the returned QAction. * with the returned QAction.
* *
* \param widget widget to add. The toolbar will take ownership of this widget * \param widget widget to add. The toolbar will take ownership of this widget
* \return the QAction you can use to remove this widget from the toolbar * \returns the QAction you can use to remove this widget from the toolbar
*/ */
QAction *addVectorToolBarWidget( QWidget *widget ) override; QAction *addVectorToolBarWidget( QWidget *widget ) override;
//! Remove an icon (action) from the Vector toolbar //! Remove an icon (action) from the Vector toolbar
@ -137,7 +137,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
* with the returned QAction. * with the returned QAction.
* *
* \param widget widget to add. The toolbar will take ownership of this widget * \param widget widget to add. The toolbar will take ownership of this widget
* \return the QAction you can use to remove this widget from the toolbar * \returns the QAction you can use to remove this widget from the toolbar
*/ */
QAction *addDatabaseToolBarWidget( QWidget *widget ) override; QAction *addDatabaseToolBarWidget( QWidget *widget ) override;
//! Remove an icon (action) from the Database toolbar //! Remove an icon (action) from the Database toolbar
@ -151,7 +151,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
* with the returned QAction. * with the returned QAction.
* *
* \param widget widget to add. The toolbar will take ownership of this widget * \param widget widget to add. The toolbar will take ownership of this widget
* \return the QAction you can use to remove this widget from the toolbar * \returns the QAction you can use to remove this widget from the toolbar
*/ */
QAction *addWebToolBarWidget( QWidget *widget ) override; QAction *addWebToolBarWidget( QWidget *widget ) override;
//! Remove an icon (action) from the Web toolbar //! Remove an icon (action) from the Web toolbar
@ -459,7 +459,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
* \param layer The layer for which the dialog will be created * \param layer The layer for which the dialog will be created
* \param feature The feature for which the dialog will be created * \param feature The feature for which the dialog will be created
* *
* \return A feature form * \returns A feature form
*/ */
virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *layer, QgsFeature &feature ) override; virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *layer, QgsFeature &feature ) override;
@ -468,7 +468,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
* With the help of this you can access methods like addFeature, startEditing * With the help of this you can access methods like addFeature, startEditing
* or stopEditing while giving the user the appropriate dialogs. * or stopEditing while giving the user the appropriate dialogs.
* *
* \return An instance of the vector layer tools * \returns An instance of the vector layer tools
*/ */
virtual QgsVectorLayerTools *vectorLayerTools() override; virtual QgsVectorLayerTools *vectorLayerTools() override;

View File

@ -125,7 +125,7 @@ class APP_EXPORT QgsAttributeTypeDialog: public QDialog, private Ui::QgsAttribut
/** /**
* Getter for constraint expression description * Getter for constraint expression description
* \return the expression description * \returns the expression description
* \since QGIS 2.16 * \since QGIS 2.16
**/ **/
QString constraintExpressionDescription(); QString constraintExpressionDescription();

View File

@ -211,11 +211,11 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem
void drawAnnotation( QPainter *p, QPointF pos, int rotation, const QString &annotationText ); void drawAnnotation( QPainter *p, QPointF pos, int rotation, const QString &annotationText );
/** Returns the grid lines with associated coordinate value /** Returns the grid lines with associated coordinate value
\return 0 in case of success*/ \returns 0 in case of success*/
int xGridLines( QList< QPair< qreal, QLineF > > &lines ) const; int xGridLines( QList< QPair< qreal, QLineF > > &lines ) const;
/** Returns the grid lines for the y-coordinates. Not vertical in case of rotation /** Returns the grid lines for the y-coordinates. Not vertical in case of rotation
\return 0 in case of success*/ \returns 0 in case of success*/
int yGridLines( QList< QPair< qreal, QLineF > > &lines ) const; 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; Border borderForLineCoord( QPointF point, QPainter *p ) const;

View File

@ -49,7 +49,7 @@ class APP_EXPORT QgsFeatureAction : public QAction
* *
* \param defaultAttributes Provide some default attributes here if desired. * \param defaultAttributes Provide some default attributes here if desired.
* *
* \return true if feature was added if showModal is true. If showModal is false, returns true in every case * \returns true if feature was added if showModal is true. If showModal is false, returns true in every case
*/ */
bool addFeature( const QgsAttributeMap &defaultAttributes = QgsAttributeMap(), bool showModal = true ); bool addFeature( const QgsAttributeMap &defaultAttributes = QgsAttributeMap(), bool showModal = true );

View File

@ -139,11 +139,11 @@ class APP_EXPORT QgsFieldsProperties : public QWidget, private Ui_QgsFieldsPrope
/** Adds an attribute to the table (but does not commit it yet) /** Adds an attribute to the table (but does not commit it yet)
\param field the field to add \param field the field to add
\return false in case of a name conflict, true in case of success */ \returns false in case of a name conflict, true in case of success */
bool addAttribute( const QgsField &field ); bool addAttribute( const QgsField &field );
/** Creates the a proper item to save from the tree /** Creates the a proper item to save from the tree
* \return A widget definition. Containing another container or the final field * \returns A widget definition. Containing another container or the final field
*/ */
QgsAttributeEditorElement *createAttributeEditorWidget( QTreeWidgetItem *item, QgsAttributeEditorElement *parent, bool forceGroup = true ); QgsAttributeEditorElement *createAttributeEditorWidget( QTreeWidgetItem *item, QgsAttributeEditorElement *parent, bool forceGroup = true );

View File

@ -37,7 +37,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools
* \param defaultValues Default values for the feature to add * \param defaultValues Default values for the feature to add
* \param defaultGeometry A default geometry to add to the feature * \param defaultGeometry A default geometry to add to the feature
* *
* \return True in case of success, False if the operation failed/was aborted * \returns True in case of success, False if the operation failed/was aborted
*/ */
bool addFeature( QgsVectorLayer *layer, const QgsAttributeMap &defaultValues, const QgsGeometry &defaultGeometry, QgsFeature *feat = nullptr ) const override; bool addFeature( QgsVectorLayer *layer, const QgsAttributeMap &defaultValues, const QgsGeometry &defaultGeometry, QgsFeature *feat = nullptr ) const override;
@ -47,7 +47,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools
* *
* \param layer The layer on which to start an edit session * \param layer The layer on which to start an edit session
* *
* \return True, if the editing session was started * \returns True, if the editing session was started
*/ */
bool startEditing( QgsVectorLayer *layer ) const override; bool startEditing( QgsVectorLayer *layer ) const override;
@ -59,7 +59,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools
* \param layer The layer to commit * \param layer The layer to commit
* \param allowCancel True if a cancel button should be offered * \param allowCancel True if a cancel button should be offered
* *
* \return True if successful * \returns True if successful
*/ */
bool stopEditing( QgsVectorLayer *layer, bool allowCancel = true ) const override; bool stopEditing( QgsVectorLayer *layer, bool allowCancel = true ) const override;
@ -67,7 +67,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools
* Should be called, when the features should be committed but the editing session is not ended. * Should be called, when the features should be committed but the editing session is not ended.
* *
* \param layer The layer to commit * \param layer The layer to commit
* \return True if successful * \returns True if successful
*/ */
bool saveEdits( QgsVectorLayer *layer ) const override; bool saveEdits( QgsVectorLayer *layer ) const override;

View File

@ -36,20 +36,20 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
/** Returns true if label move can be applied to a layer /** Returns true if label move can be applied to a layer
\param xCol out: index of the attribute for data defined x coordinate \param xCol out: index of the attribute for data defined x coordinate
\param yCol out: index of the attribute for data defined y coordinate \param yCol out: index of the attribute for data defined y coordinate
\return true if labels of layer can be moved*/ \returns true if labels of layer can be moved*/
bool labelMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; bool labelMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const;
bool labelMoveable( QgsVectorLayer *vlayer, const QgsPalLayerSettings &settings, int &xCol, int &yCol ) const; bool labelMoveable( QgsVectorLayer *vlayer, const QgsPalLayerSettings &settings, int &xCol, int &yCol ) const;
/** Returns true if diagram move can be applied to a layer /** Returns true if diagram move can be applied to a layer
\param xCol out: index of the attribute for data defined x coordinate \param xCol out: index of the attribute for data defined x coordinate
\param yCol out: index of the attribute for data defined y coordinate \param yCol out: index of the attribute for data defined y coordinate
\return true if labels of layer can be moved*/ \returns true if labels of layer can be moved*/
bool diagramMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; bool diagramMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const;
/** Returns true if layer has attribute fields set up /** Returns true if layer has attribute fields set up
\param xCol out: index of the attribute for data defined x coordinate \param xCol out: index of the attribute for data defined x coordinate
\param yCol out: index of the attribute for data defined y coordinate \param yCol out: index of the attribute for data defined y coordinate
\return true if layer fields set up and exist*/ \returns true if layer fields set up and exist*/
bool layerCanPin( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; bool layerCanPin( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const;
/** Returns true if layer has attribute field set up for diagrams /** Returns true if layer has attribute field set up for diagrams
@ -89,12 +89,12 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
/** Returns label position for mouse click location /** Returns label position for mouse click location
\param e mouse event \param e mouse event
\param p out: label position \param p out: label position
\return true in case of success, false if no label at this location*/ \returns true in case of success, false if no label at this location*/
bool labelAtPosition( QMouseEvent *e, QgsLabelPosition &p ); bool labelAtPosition( QMouseEvent *e, QgsLabelPosition &p );
/** Finds out rotation point of current label position /** Finds out rotation point of current label position
\param ignoreUpsideDown treat label as right-side-up \param ignoreUpsideDown treat label as right-side-up
\return true in case of success*/ \returns true in case of success*/
bool currentLabelRotationPoint( QgsPoint &pos, bool ignoreUpsideDown = false, bool rotatingUnpinned = false ); 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
@ -110,7 +110,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
void currentAlignment( QString &hali, QString &vali ); void currentAlignment( QString &hali, QString &vali );
/** Gets vector feature for current label pos /** Gets vector feature for current label pos
\return true in case of success*/ \returns true in case of success*/
bool currentFeature( QgsFeature &f, bool fetchGeom = false ); 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)
@ -120,7 +120,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
QString dataDefinedColumnName( QgsPalLayerSettings::Property p, const QgsPalLayerSettings &labelSettings ) const; QString dataDefinedColumnName( QgsPalLayerSettings::Property p, const QgsPalLayerSettings &labelSettings ) const;
/** Returns a data defined attribute column index /** Returns a data defined attribute column index
\return -1 if column does not exist or an expression is used instead */ \returns -1 if column does not exist or an expression is used instead */
int dataDefinedColumnIndex( QgsPalLayerSettings::Property p, const QgsPalLayerSettings &labelSettings, const QgsVectorLayer *vlayer ) const; int dataDefinedColumnIndex( QgsPalLayerSettings::Property 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
@ -133,7 +133,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
\param ySuccess out: false if attribute value is NULL \param ySuccess out: false if attribute value is NULL
\param xCol out: index of the x position column \param xCol out: index of the x position column
\param yCol out: index of the y position column \param yCol out: index of the y position column
\return false if layer does not have data defined label position enabled*/ \returns false if layer does not have data defined label position enabled*/
bool currentLabelDataDefinedPosition( double &x, bool &xSuccess, double &y, bool &ySuccess, int &xCol, int &yCol ) const; bool currentLabelDataDefinedPosition( double &x, bool &xSuccess, double &y, bool &ySuccess, int &xCol, int &yCol ) const;
/** Returns data defined rotation of current label /** Returns data defined rotation of current label
@ -141,7 +141,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
\param rotationSuccess out: false if rotation value is NULL \param rotationSuccess out: false if rotation value is NULL
\param rCol out: index of the rotation column \param rCol out: index of the rotation column
\param ignoreXY ignore that x and y are required to be data-defined \param ignoreXY ignore that x and y are required to be data-defined
\return true if data defined rotation is enabled on the layer \returns true if data defined rotation is enabled on the layer
*/ */
bool currentLabelDataDefinedRotation( double &rotation, bool &rotationSuccess, int &rCol, bool ignoreXY = false ) const; bool currentLabelDataDefinedRotation( double &rotation, bool &rotationSuccess, int &rCol, bool ignoreXY = false ) const;
@ -151,12 +151,12 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
\param show out: show/hide value \param show out: show/hide value
\param showSuccess out: false if show/hide value is NULL \param showSuccess out: false if show/hide value is NULL
\param showCol out: index of the show label column \param showCol out: index of the show label column
\return true if data defined show/hide is enabled on the layer \returns true if data defined show/hide is enabled on the layer
*/ */
bool dataDefinedShowHide( QgsVectorLayer *vlayer, QgsFeatureId featureId, int &show, bool &showSuccess, int &showCol ) const; bool dataDefinedShowHide( QgsVectorLayer *vlayer, QgsFeatureId featureId, int &show, bool &showSuccess, int &showCol ) const;
/** Returns the pin status for the current label/diagram /** Returns the pin status for the current label/diagram
\return true if the label/diagram is pinned, false otherwise \returns true if the label/diagram is pinned, false otherwise
\since QGIS 2.16 \since QGIS 2.16
*/ */
bool isPinned(); bool isPinned();

View File

@ -92,7 +92,7 @@ namespace QgsMapToolSelectUtils
/** /**
Get the current selected canvas map layer. Returns nullptr if it is not a vector layer Get the current selected canvas map layer. Returns nullptr if it is not a vector layer
\param canvas The map canvas used for getting the current layer \param canvas The map canvas used for getting the current layer
\return QgsVectorLayer The layer \returns QgsVectorLayer The layer
*/ */
QgsVectorLayer *getCurrentVectorLayer( QgsMapCanvas *canvas ); QgsVectorLayer *getCurrentVectorLayer( QgsMapCanvas *canvas );

View File

@ -73,7 +73,7 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA
QComboBox *createMergeComboBox( QVariant::Type columnType ) const; QComboBox *createMergeComboBox( QVariant::Type columnType ) const;
/** Returns the table widget column index of a combo box /** Returns the table widget column index of a combo box
\return the column index or -1 in case of error*/ \returns the column index or -1 in case of error*/
int findComboColumn( QComboBox *c ) const; int findComboColumn( QComboBox *c ) const;
//! Calculates the merged value of a column (depending on the selected merge behavior) and inserts the value in the corresponding cell //! Calculates the merged value of a column (depending on the selected merge behavior) and inserts the value in the corresponding cell
void refreshMergedValue( int col ); void refreshMergedValue( int col );

View File

@ -51,7 +51,7 @@ class APP_EXPORT QgsStatusBarScaleWidget : public QWidget
/** /**
* @brief isLocked check if the scale should be locked to use magnifier instead of scale to zoom in/out * @brief isLocked check if the scale should be locked to use magnifier instead of scale to zoom in/out
* \return True if the scale shall be locked * \returns True if the scale shall be locked
*/ */
bool isLocked() const; bool isLocked() const;

View File

@ -38,7 +38,7 @@ class APP_EXPORT QgsTipFactory : public QObject
~QgsTipFactory(); ~QgsTipFactory();
/** Get a random tip (generic or gui-centric) /** Get a random tip (generic or gui-centric)
* \return An QgsTip containing the tip * \returns An QgsTip containing the tip
*/ */
QgsTip getTip(); QgsTip getTip();
@ -47,17 +47,17 @@ class APP_EXPORT QgsTipFactory : public QObject
* number passed in as position. If the * number passed in as position. If the
* position is invalid, an empty string will be * position is invalid, an empty string will be
* returned. * returned.
* \return An QgsTip containing the tip * \returns An QgsTip containing the tip
*/ */
QgsTip getTip( int position ); QgsTip getTip( int position );
/** Get a random generic tip /** Get a random generic tip
* \return An QgsTip containing the tip * \returns An QgsTip containing the tip
*/ */
QgsTip getGenericTip(); QgsTip getGenericTip();
/** Get a random gui-centric tip /** Get a random gui-centric tip
* \return An QgsTip containing the tip * \returns An QgsTip containing the tip
*/ */
QgsTip getGuiTip(); QgsTip getGuiTip();

View File

@ -62,12 +62,12 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private
/** Adds an attribute to the table (but does not commit it yet) /** Adds an attribute to the table (but does not commit it yet)
\param field the field to add \param field the field to add
\return false in case of a name conflict, true in case of success */ \returns false in case of a name conflict, true in case of success */
bool addAttribute( const QgsField &field ); bool addAttribute( const QgsField &field );
/** Deletes an attribute (but does not commit it) /** Deletes an attribute (but does not commit it)
\param name attribute name \param name attribute name
\return false in case of a non-existing attribute.*/ \returns false in case of a non-existing attribute.*/
bool deleteAttribute( int attr ); 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.

View File

@ -122,7 +122,7 @@ class CORE_EXPORT QgsAuthCertUtils
* \param keypath File path to private key * \param keypath File path to private key
* \param keypass Passphrase for private key * \param keypass Passphrase for private key
* \param reencrypt Whether to re-encrypt the private key with the passphrase * \param reencrypt Whether to re-encrypt the private key with the passphrase
* \return certificate, private key, key's algorithm type * \returns certificate, private key, key's algorithm type
*/ */
static QStringList certKeyBundleToPem( const QString &certpath, static QStringList certKeyBundleToPem( const QString &certpath,
const QString &keypath, const QString &keypath,
@ -133,7 +133,7 @@ class CORE_EXPORT QgsAuthCertUtils
* \param bundlepath File path to the PKCS bundle * \param bundlepath File path to the PKCS bundle
* \param bundlepass Passphrase for bundle * \param bundlepass Passphrase for bundle
* \param reencrypt Whether to re-encrypt the private key with the passphrase * \param reencrypt Whether to re-encrypt the private key with the passphrase
* \return certificate, private key, key's algorithm type * \returns certificate, private key, key's algorithm type
*/ */
static QStringList pkcs12BundleToPem( const QString &bundlepath, static QStringList pkcs12BundleToPem( const QString &bundlepath,
const QString &bundlepass = QString(), const QString &bundlepass = QString(),
@ -142,7 +142,7 @@ class CORE_EXPORT QgsAuthCertUtils
/** Write a temporary file for a PEM text of cert/key/CAs bundle component /** Write a temporary file for a PEM text of cert/key/CAs bundle component
* \param pemtext Component content as PEM text * \param pemtext Component content as PEM text
* \param name Name of file * \param name Name of file
* \return File path to temporary file * \returns File path to temporary file
*/ */
static QString pemTextToTempFile( const QString &name, const QByteArray &pemtext ); static QString pemTextToTempFile( const QString &name, const QByteArray &pemtext );

View File

@ -123,7 +123,7 @@ class CORE_EXPORT QgsAuthMethodConfig
/** /**
* Remove a config from map * Remove a config from map
* \param key Config to remove * \param key Config to remove
* \return Number of keys removed (should always be 1 or 0) * \returns Number of keys removed (should always be 1 or 0)
*/ */
int removeConfig( const QString &key ); int removeConfig( const QString &key );

View File

@ -246,14 +246,14 @@ class CORE_EXPORT QgsAuthManager : public QObject
/** /**
* Store an authentication config in the database * Store an authentication config in the database
* \param mconfig Associated authentication config id * \param mconfig Associated authentication config id
* \return Whether operation succeeded * \returns Whether operation succeeded
*/ */
bool storeAuthenticationConfig( QgsAuthMethodConfig &mconfig ); bool storeAuthenticationConfig( QgsAuthMethodConfig &mconfig );
/** /**
* Update an authentication config in the database * Update an authentication config in the database
* \param config Associated authentication config id * \param config Associated authentication config id
* \return Whether operation succeeded * \returns Whether operation succeeded
*/ */
bool updateAuthenticationConfig( const QgsAuthMethodConfig &config ); bool updateAuthenticationConfig( const QgsAuthMethodConfig &config );
@ -262,26 +262,26 @@ class CORE_EXPORT QgsAuthManager : public QObject
* \param authcfg Associated authentication config id * \param authcfg Associated authentication config id
* \param mconfig Subclassed config to load into * \param mconfig Subclassed config to load into
* \param full Whether to decrypt and populate all sensitive data in subclass * \param full Whether to decrypt and populate all sensitive data in subclass
* \return Whether operation succeeded * \returns Whether operation succeeded
*/ */
bool loadAuthenticationConfig( const QString &authcfg, QgsAuthMethodConfig &mconfig, bool full = false ); bool loadAuthenticationConfig( const QString &authcfg, QgsAuthMethodConfig &mconfig, bool full = false );
/** /**
* Remove an authentication config in the database * Remove an authentication config in the database
* \param authcfg Associated authentication config id * \param authcfg Associated authentication config id
* \return Whether operation succeeded * \returns Whether operation succeeded
*/ */
bool removeAuthenticationConfig( const QString &authcfg ); bool removeAuthenticationConfig( const QString &authcfg );
/** /**
* Clear all authentication configs from table in database and from provider caches * Clear all authentication configs from table in database and from provider caches
* \return Whether operation succeeded * \returns Whether operation succeeded
*/ */
bool removeAllAuthenticationConfigs(); bool removeAllAuthenticationConfigs();
/** /**
* Close connection to current authentication database and back it up * Close connection to current authentication database and back it up
* \return Path to backup * \returns Path to backup
*/ */
bool backupAuthenticationDatabase( QString *backuppath = nullptr ); bool backupAuthenticationDatabase( QString *backuppath = nullptr );
@ -289,7 +289,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
* Erase all rows from all tables in authentication database * Erase all rows from all tables in authentication database
* \param backup Whether to backup of current database * \param backup Whether to backup of current database
* \param backuppath Where the backup is locate * \param backuppath Where the backup is locate
* \return Whether operation succeeded * \returns Whether operation succeeded
*/ */
bool eraseAuthenticationDatabase( bool backup, QString *backuppath = nullptr ); bool eraseAuthenticationDatabase( bool backup, QString *backuppath = nullptr );
@ -301,7 +301,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
* \param request The QNetworkRequest * \param request The QNetworkRequest
* \param authcfg Associated authentication config id * \param authcfg Associated authentication config id
* \param dataprovider Provider key filter, offering logic branching in authentication method * \param dataprovider Provider key filter, offering logic branching in authentication method
* \return Whether operation succeeded * \returns Whether operation succeeded
*/ */
bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg, bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg,
const QString &dataprovider = QString() ); const QString &dataprovider = QString() );
@ -311,7 +311,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
* \param reply The QNetworkReply * \param reply The QNetworkReply
* \param authcfg Associated authentication config id * \param authcfg Associated authentication config id
* \param dataprovider Provider key filter, offering logic branching in authentication method * \param dataprovider Provider key filter, offering logic branching in authentication method
* \return Whether operation succeeded * \returns Whether operation succeeded
*/ */
bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg, bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg,
const QString &dataprovider = QString() ); const QString &dataprovider = QString() );
@ -321,7 +321,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
* \param connectionItems The connection items, e.g. username=myname, of QgsDataSourceUri * \param connectionItems The connection items, e.g. username=myname, of QgsDataSourceUri
* \param authcfg Associated authentication config id * \param authcfg Associated authentication config id
* \param dataprovider Provider key filter, offering logic branching in authentication method * \param dataprovider Provider key filter, offering logic branching in authentication method
* \return Whether operation succeeded * \returns Whether operation succeeded
*/ */
bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg, bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg,
const QString &dataprovider = QString() ); const QString &dataprovider = QString() );
@ -451,7 +451,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
bool storeCertTrustPolicy( const QSslCertificate &cert, QgsAuthCertUtils::CertTrustPolicy policy ); bool storeCertTrustPolicy( const QSslCertificate &cert, QgsAuthCertUtils::CertTrustPolicy policy );
/** Get a whether certificate is trusted by user /** Get a whether certificate is trusted by user
\return DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy \returns DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy
*/ */
QgsAuthCertUtils::CertTrustPolicy getCertTrustPolicy( const QSslCertificate &cert ); QgsAuthCertUtils::CertTrustPolicy getCertTrustPolicy( const QSslCertificate &cert );

View File

@ -83,7 +83,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject
* \param authcfg Authentication configuration ID * \param authcfg Authentication configuration ID
* \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows
* for custom updater code specific to the provider * for custom updater code specific to the provider
* \return Whether the update succeeded * \returns Whether the update succeeded
*/ */
virtual bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg, virtual bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg,
const QString &dataprovider = QString() ) const QString &dataprovider = QString() )
@ -99,7 +99,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject
* \param authcfg Authentication configuration ID * \param authcfg Authentication configuration ID
* \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows
* for custom updater code specific to the provider * for custom updater code specific to the provider
* \return Whether the update succeeded * \returns Whether the update succeeded
*/ */
virtual bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg, virtual bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg,
const QString &dataprovider = QString() ) const QString &dataprovider = QString() )
@ -115,7 +115,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject
* \param authcfg Authentication configuration ID * \param authcfg Authentication configuration ID
* \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows
* for custom updater code specific to the provider * for custom updater code specific to the provider
* \return Whether the update succeeded * \returns Whether the update succeeded
*/ */
virtual bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg, virtual bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg,
const QString &dataprovider = QString() ) const QString &dataprovider = QString() )

View File

@ -63,7 +63,7 @@ class CORE_EXPORT QgsAuthMethodRegistry
/** Create an instance of the auth method /** Create an instance of the auth method
\param authMethodKey identificator of the auth method \param authMethodKey identificator of the auth method
\return instance of auth method or nullptr on error \returns instance of auth method or nullptr on error
*/ */
QgsAuthMethod *authMethod( const QString &authMethodKey ); QgsAuthMethod *authMethod( const QString &authMethodKey );
@ -81,7 +81,7 @@ class CORE_EXPORT QgsAuthMethodRegistry
/** Get pointer to auth method function /** Get pointer to auth method function
\param authMethodKey identificator of the auth method \param authMethodKey identificator of the auth method
\param functionName name of function \param functionName name of function
\return pointer to function or nullptr on error \returns pointer to function or nullptr on error
*/ */
QFunctionPointer function( const QString &authMethodKey, QFunctionPointer function( const QString &authMethodKey,
const QString &functionName ); const QString &functionName );

View File

@ -659,7 +659,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
double rectHandlerBorderTolerance() const; double rectHandlerBorderTolerance() const;
/** Returns the zoom factor of the graphics view. /** Returns the zoom factor of the graphics view.
* \return the factor or -1 in case of error (e.g. graphic view does not exist) * \returns the factor or -1 in case of error (e.g. graphic view does not exist)
*/ */
double horizontalViewScaleFactor() const; double horizontalViewScaleFactor() const;

View File

@ -974,11 +974,11 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
QString gridAnnotationString( double value, AnnotationCoordinate coord, QgsExpressionContext &expressionContext ) const; QString gridAnnotationString( double value, AnnotationCoordinate coord, QgsExpressionContext &expressionContext ) const;
/** Returns the grid lines with associated coordinate value /** Returns the grid lines with associated coordinate value
\return 0 in case of success*/ \returns 0 in case of success*/
int xGridLines( QList< QPair< double, QLineF > > &lines ) const; int xGridLines( QList< QPair< double, QLineF > > &lines ) const;
/** Returns the grid lines for the y-coordinates. Not vertical in case of rotation /** Returns the grid lines for the y-coordinates. Not vertical in case of rotation
\return 0 in case of success*/ \returns 0 in case of success*/
int yGridLines( QList< QPair< double, QLineF > > &lines ) const; int yGridLines( QList< QPair< double, QLineF > > &lines ) const;
int xGridLinesCrsTransform( const QgsRectangle &bbox, const QgsCoordinateTransform &t, QList< QPair< double, QPolygonF > > &lines ) const; int xGridLinesCrsTransform( const QgsRectangle &bbox, const QgsCoordinateTransform &t, QList< QPair< double, QPolygonF > > &lines ) const;

View File

@ -81,7 +81,7 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem
/** Gets the position of a node in scene coordinate. /** Gets the position of a node in scene coordinate.
* \param index of the node * \param index of the node
* \param position the position of the node * \param position the position of the node
* \return true if the index is valid and the position is set, false otherwise * \returns true if the index is valid and the position is set, false otherwise
*/ */
bool nodePosition( const int index, QPointF &position ); bool nodePosition( const int index, QPointF &position );
@ -105,7 +105,7 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem
bool setSelectedNode( const int index ); bool setSelectedNode( const int index );
/** Returns the currently selected node. /** Returns the currently selected node.
* \return the index of the selected node, -1 otherwise * \returns the index of the selected node, -1 otherwise
*/ */
int selectedNode() { return mSelectedNode; } int selectedNode() { return mSelectedNode; }

View File

@ -403,14 +403,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
template<class T> void composerItemsOnPage( QList<T *> &itemList, const int pageNumber ) const; template<class T> void composerItemsOnPage( QList<T *> &itemList, const int pageNumber ) const;
/** Returns the composer map with specified id /** Returns the composer map with specified id
* \return QgsComposerMap or 0 pointer if the composer map item does not exist * \returns QgsComposerMap or 0 pointer if the composer map item does not exist
*/ */
const QgsComposerMap *getComposerMapById( const int id ) const; const QgsComposerMap *getComposerMapById( const int id ) const;
/** Returns a composer item given its text identifier. /** Returns a composer item given its text identifier.
* Ids are not necessarely unique, but this function returns only one element. * Ids are not necessarely unique, but this function returns only one element.
* \param id - A QString representing the identifier of the item to retrieve. * \param id - A QString representing the identifier of the item to retrieve.
* \return QgsComposerItem pointer or 0 pointer if no such item exists. * \returns QgsComposerItem pointer or 0 pointer if no such item exists.
*/ */
const QgsComposerItem *getComposerItemById( const QString &id ) const; const QgsComposerItem *getComposerItemById( const QString &id ) const;
@ -960,7 +960,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
void updateZValues( const bool addUndoCommands = true ); void updateZValues( const bool addUndoCommands = true );
/** Returns the bounding rectangle of the selected items in scene coordinates /** Returns the bounding rectangle of the selected items in scene coordinates
\return 0 in case of success*/ \returns 0 in case of success*/
int boundingRectOfSelectedItems( QRectF &bRect ); int boundingRectOfSelectedItems( QRectF &bRect );
//! Loads default composer settings //! Loads default composer settings

View File

@ -87,7 +87,7 @@ class CORE_EXPORT QgsDiagram
* \param s The settings that specify the size type * \param s The settings that specify the size type
* \param c The rendering specifying the proper scale units for pixel conversion * \param c The rendering specifying the proper scale units for pixel conversion
* *
* \return The converted size for rendering * \returns The converted size for rendering
*/ */
QSizeF sizePainterUnits( QSizeF size, const QgsDiagramSettings &s, const QgsRenderContext &c ); QSizeF sizePainterUnits( QSizeF size, const QgsDiagramSettings &s, const QgsRenderContext &c );
@ -96,7 +96,7 @@ class CORE_EXPORT QgsDiagram
* \param s Unused * \param s Unused
* \param c The rendering specifying the proper scale units for pixel conversion * \param c The rendering specifying the proper scale units for pixel conversion
* *
* \return The converted length for rendering * \returns The converted length for rendering
*/ */
double sizePainterUnits( double l, const QgsDiagramSettings &s, const QgsRenderContext &c ); double sizePainterUnits( double l, const QgsDiagramSettings &s, const QgsRenderContext &c );
@ -104,7 +104,7 @@ class CORE_EXPORT QgsDiagram
* \param s The settings that contain the font size and size type * \param s The settings that contain the font size and size type
* \param c The rendering specifying the proper scale units for pixel conversion * \param c The rendering specifying the proper scale units for pixel conversion
* *
* \return The properly scaled font for rendering * \returns The properly scaled font for rendering
*/ */
QFont scaledFont( const QgsDiagramSettings &s, const QgsRenderContext &c ); QFont scaledFont( const QgsDiagramSettings &s, const QgsRenderContext &c );

View File

@ -66,7 +66,7 @@ class CORE_EXPORT QgsTextDiagram: public QgsDiagram
QPen mPen; QPen mPen;
/** Calculates intersection points between a line and an ellipse /** Calculates intersection points between a line and an ellipse
\return intersection points*/ \returns intersection points*/
void lineEllipseIntersection( QPointF lineStart, QPointF lineEnd, QPointF ellipseMid, double r1, double r2, QList<QPointF> &result ) const; void lineEllipseIntersection( QPointF lineStart, QPointF lineEnd, QPointF ellipseMid, double r1, double r2, QList<QPointF> &result ) const;
}; };

View File

@ -219,12 +219,12 @@ class CORE_EXPORT QgsAbstractGeometry
* \param id initial value should be the starting vertex id. The next vertex id will be stored * \param id initial value should be the starting vertex id. The next vertex id will be stored
* in this variable if found. * in this variable if found.
* \param vertex container for found node * \param vertex container for found node
* \return false if at end * \returns false if at end
*/ */
virtual bool nextVertex( QgsVertexId &id, QgsPointV2 &vertex ) const = 0; virtual bool nextVertex( QgsVertexId &id, QgsPointV2 &vertex ) const = 0;
/** Retrieves the sequence of geometries, rings and nodes. /** Retrieves the sequence of geometries, rings and nodes.
* \return coordinate sequence * \returns coordinate sequence
*/ */
virtual QgsCoordinateSequence coordinateSequence() const = 0; virtual QgsCoordinateSequence coordinateSequence() const = 0;
@ -314,14 +314,14 @@ class CORE_EXPORT QgsAbstractGeometry
/** Returns the geometry converted to the more generic curve type. /** Returns the geometry converted to the more generic curve type.
E.g. QgsLineString -> QgsCompoundCurve, QgsPolygonV2 -> QgsCurvePolygon, E.g. QgsLineString -> QgsCompoundCurve, QgsPolygonV2 -> QgsCurvePolygon,
QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygonV2 -> QgsMultiSurface QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygonV2 -> QgsMultiSurface
\return the converted geometry. Caller takes ownership*/ \returns the converted geometry. Caller takes ownership*/
virtual QgsAbstractGeometry *toCurveType() const { return 0; } virtual QgsAbstractGeometry *toCurveType() const { return 0; }
/** Returns approximate angle at a vertex. This is usually the average angle between adjacent /** Returns approximate angle at a vertex. This is usually the average angle between adjacent
* segments, and can be pictured as the orientation of a line following the curvature of the * segments, and can be pictured as the orientation of a line following the curvature of the
* geometry at the specified vertex. * geometry at the specified vertex.
* \param vertex the vertex id * \param vertex the vertex id
* \return rotation in radians, clockwise from north * \returns rotation in radians, clockwise from north
*/ */
virtual double vertexAngle( QgsVertexId vertex ) const = 0; virtual double vertexAngle( QgsVertexId vertex ) const = 0;

View File

@ -121,7 +121,7 @@ class CORE_EXPORT QgsCircularString: public QgsCurve
/** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments.
\param vertex the vertex id \param vertex the vertex id
\return rotation in radians, clockwise from north*/ \returns rotation in radians, clockwise from north*/
double vertexAngle( QgsVertexId vertex ) const override; double vertexAngle( QgsVertexId vertex ) const override;
virtual QgsCircularString *reversed() const override; virtual QgsCircularString *reversed() const override;

View File

@ -110,7 +110,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve
/** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments.
\param vertex the vertex id \param vertex the vertex id
\return rotation in radians, clockwise from north*/ \returns rotation in radians, clockwise from north*/
double vertexAngle( QgsVertexId vertex ) const override; double vertexAngle( QgsVertexId vertex ) const override;
virtual QgsCompoundCurve *reversed() const override; virtual QgsCompoundCurve *reversed() const override;
@ -132,7 +132,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve
QList< QgsCurve * > mCurves; QList< QgsCurve * > mCurves;
/** Turns a vertex id for the compound curve into one or more ids for the subcurves /** Turns a vertex id for the compound curve into one or more ids for the subcurves
\return the index of the subcurve or -1 in case of error*/ \returns the index of the subcurve or -1 in case of error*/
QList< QPair<int, QgsVertexId> > curveVertexId( QgsVertexId id ) const; QList< QPair<int, QgsVertexId> > curveVertexId( QgsVertexId id ) const;
}; };

View File

@ -123,7 +123,7 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface
/** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments.
* \param vertex the vertex id * \param vertex the vertex id
* \return rotation in radians, clockwise from north * \returns rotation in radians, clockwise from north
*/ */
double vertexAngle( QgsVertexId vertex ) const override; double vertexAngle( QgsVertexId vertex ) const override;

View File

@ -317,7 +317,7 @@ class CORE_EXPORT QgsGeometry
/** /**
* Returns coordinates of a vertex. * Returns coordinates of a vertex.
* \param atVertex index of the vertex * \param atVertex index of the vertex
* \return Coordinates of the vertex or QgsPoint(0,0) on error * \returns Coordinates of the vertex or QgsPoint(0,0) on error
*/ */
QgsPoint vertexAt( int atVertex ) const; QgsPoint vertexAt( int atVertex ) const;
@ -344,7 +344,7 @@ class CORE_EXPORT QgsGeometry
* Searches for the closest vertex in this geometry to the given point. * Searches for the closest vertex in this geometry to the given point.
* \param point Specifiest the point for search * \param point Specifiest the point for search
* \param atVertex Receives index of the closest vertex * \param atVertex Receives index of the closest vertex
* \return The squared cartesian distance is also returned in sqrDist, negative number on error * \returns The squared cartesian distance is also returned in sqrDist, negative number on error
*/ */
double closestVertexWithContext( const QgsPoint &point, int &atVertex ) const; double closestVertexWithContext( const QgsPoint &point, int &atVertex ) const;
@ -356,18 +356,18 @@ class CORE_EXPORT QgsGeometry
* before the closest segment is always afterVertex - 1 * before the closest segment is always afterVertex - 1
* \param leftOf Out: Returns if the point lies on the left of right side of the segment ( < 0 means left, > 0 means right ) * \param leftOf Out: Returns if the point lies on the left of right side of the segment ( < 0 means left, > 0 means right )
* \param epsilon epsilon for segment snapping (added in 1.8) * \param epsilon epsilon for segment snapping (added in 1.8)
* \return The squared cartesian distance is also returned in sqrDist, negative number on error * \returns The squared cartesian distance is also returned in sqrDist, negative number on error
*/ */
double closestSegmentWithContext( const QgsPoint &point, QgsPoint &minDistPoint, int &afterVertex, double *leftOf = nullptr, double epsilon = DEFAULT_SEGMENT_EPSILON ) const; double closestSegmentWithContext( const QgsPoint &point, QgsPoint &minDistPoint, int &afterVertex, double *leftOf = nullptr, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;
/** Adds a new ring to this geometry. This makes only sense for polygon and multipolygons. /** Adds a new ring to this geometry. This makes only sense for polygon and multipolygons.
\return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, \returns 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed,
3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/ 3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/
// TODO QGIS 3.0 returns an enum instead of a magic constant // TODO QGIS 3.0 returns an enum instead of a magic constant
int addRing( const QList<QgsPoint> &ring ); int addRing( const QList<QgsPoint> &ring );
/** Adds a new ring to this geometry. This makes only sense for polygon and multipolygons. /** Adds a new ring to this geometry. This makes only sense for polygon and multipolygons.
\return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, \returns 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed,
3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/ 3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/
// TODO QGIS 3.0 returns an enum instead of a magic constant // TODO QGIS 3.0 returns an enum instead of a magic constant
int addRing( QgsCurve *ring ); int addRing( QgsCurve *ring );
@ -401,7 +401,7 @@ class CORE_EXPORT QgsGeometry
/** Adds a new island polygon to a multipolygon feature /** Adds a new island polygon to a multipolygon feature
* \param newPart part to add. Ownership is NOT transferred. * \param newPart part to add. Ownership is NOT transferred.
* \return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring * \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
* not disjoint with existing polygons of the feature * not disjoint with existing polygons of the feature
* \note not available in Python bindings * \note not available in Python bindings
*/ */
@ -409,7 +409,7 @@ class CORE_EXPORT QgsGeometry
int addPart( GEOSGeometry *newPart ); int addPart( GEOSGeometry *newPart );
/** Adds a new island polygon to a multipolygon feature /** Adds a new island polygon to a multipolygon feature
\return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
not disjoint with existing polygons of the feature not disjoint with existing polygons of the feature
\note available in Python bindings as addPartGeometry \note available in Python bindings as addPartGeometry
\since QGIS 2.2 \since QGIS 2.2
@ -426,23 +426,23 @@ class CORE_EXPORT QgsGeometry
QgsGeometry removeInteriorRings( double minimumAllowedArea = -1 ) const; QgsGeometry removeInteriorRings( double minimumAllowedArea = -1 ) const;
/** Translate this geometry by dx, dy /** Translate this geometry by dx, dy
\return 0 in case of success*/ \returns 0 in case of success*/
int translate( double dx, double dy ); int translate( double dx, double dy );
/** Transform this geometry as described by CoordinateTransform ct /** Transform this geometry as described by CoordinateTransform ct
\return 0 in case of success*/ \returns 0 in case of success*/
int transform( const QgsCoordinateTransform &ct ); int transform( const QgsCoordinateTransform &ct );
/** Transform this geometry as described by QTransform ct /** Transform this geometry as described by QTransform ct
\since QGIS 2.8 \since QGIS 2.8
\return 0 in case of success*/ \returns 0 in case of success*/
int transform( const QTransform &ct ); int transform( const QTransform &ct );
/** Rotate this geometry around the Z axis /** Rotate this geometry around the Z axis
\since QGIS 2.8 \since QGIS 2.8
\param rotation clockwise rotation in degrees \param rotation clockwise rotation in degrees
\param center rotation center \param center rotation center
\return 0 in case of success*/ \returns 0 in case of success*/
int rotate( double rotation, const QgsPoint &center ); int rotate( double rotation, const QgsPoint &center );
/** Splits this geometry according to a given line. /** Splits this geometry according to a given line.
@ -450,7 +450,7 @@ class CORE_EXPORT QgsGeometry
\param[out] newGeometries list of new geometries that have been created with the split \param[out] newGeometries list of new geometries that have been created with the split
\param topological true if topological editing is enabled \param topological true if topological editing is enabled
\param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset
\return 0 in case of success, 1 if geometry has not been split, error else*/ \returns 0 in case of success, 1 if geometry has not been split, error else*/
// TODO QGIS 3.0 returns an enum instead of a magic constant // TODO QGIS 3.0 returns an enum instead of a magic constant
int splitGeometry( const QList<QgsPoint> &splitLine, int splitGeometry( const QList<QgsPoint> &splitLine,
QList<QgsGeometry> &newGeometries, QList<QgsGeometry> &newGeometries,
@ -458,21 +458,21 @@ class CORE_EXPORT QgsGeometry
QList<QgsPoint> &topologyTestPoints ); QList<QgsPoint> &topologyTestPoints );
/** Replaces a part of this geometry with another line /** Replaces a part of this geometry with another line
* \return 0 in case of success * \returns 0 in case of success
* \since QGIS 1.3 * \since QGIS 1.3
*/ */
int reshapeGeometry( const QList<QgsPoint> &reshapeWithLine ); int reshapeGeometry( const QList<QgsPoint> &reshapeWithLine );
/** Changes this geometry such that it does not intersect the other geometry /** Changes this geometry such that it does not intersect the other geometry
* \param other geometry that should not be intersect * \param other geometry that should not be intersect
* \return 0 in case of success * \returns 0 in case of success
*/ */
int makeDifference( const QgsGeometry *other ); int makeDifference( const QgsGeometry *other );
/** Returns the geometry formed by modifying this geometry such that it does not /** Returns the geometry formed by modifying this geometry such that it does not
* intersect the other geometry. * intersect the other geometry.
* \param other geometry that should not be intersect * \param other geometry that should not be intersect
* \return difference geometry, or empty geometry if difference could not be calculated * \returns difference geometry, or empty geometry if difference could not be calculated
* \since QGIS 3.0 * \since QGIS 3.0
*/ */
QgsGeometry makeDifference( const QgsGeometry &other ) const; QgsGeometry makeDifference( const QgsGeometry &other ) const;
@ -593,7 +593,7 @@ class CORE_EXPORT QgsGeometry
* \param side side of geometry to buffer * \param side side of geometry to buffer
* \param joinStyle join style for corners * \param joinStyle join style for corners
* \param mitreLimit limit on the mitre ratio used for very sharp corners * \param mitreLimit limit on the mitre ratio used for very sharp corners
* \return buffered geometry, or an empty geometry if buffer could not be * \returns buffered geometry, or an empty geometry if buffer could not be
* calculated * calculated
* \since QGIS 3.0 * \since QGIS 3.0
*/ */
@ -714,7 +714,7 @@ class CORE_EXPORT QgsGeometry
* how far along this linestring you need to traverse to get to the closest location * how far along this linestring you need to traverse to get to the closest location
* where this linestring comes to the specified point. * where this linestring comes to the specified point.
* \param point point to seek proximity to * \param point point to seek proximity to
* \return distance along line, or -1 on error * \returns distance along line, or -1 on error
* \note only valid for linestring geometries * \note only valid for linestring geometries
* @see interpolate() * @see interpolate()
* \since QGIS 3.0 * \since QGIS 3.0
@ -765,12 +765,12 @@ class CORE_EXPORT QgsGeometry
/** Exports the geometry to WKT /** Exports the geometry to WKT
* \note precision parameter added in QGIS 2.4 * \note precision parameter added in QGIS 2.4
* \return true in case of success and false else * \returns true in case of success and false else
*/ */
QString exportToWkt( int precision = 17 ) const; QString exportToWkt( int precision = 17 ) const;
/** Exports the geometry to GeoJSON /** Exports the geometry to GeoJSON
* \return a QString representing the geometry as GeoJSON * \returns a QString representing the geometry as GeoJSON
* \since QGIS 1.8 * \since QGIS 1.8
* \note Available in Python bindings since QGIS 1.9 * \note Available in Python bindings since QGIS 1.9
* \note precision parameter added in QGIS 2.4 * \note precision parameter added in QGIS 2.4
@ -780,7 +780,7 @@ class CORE_EXPORT QgsGeometry
/** Try to convert the geometry to the requested type /** Try to convert the geometry to the requested type
* \param destType the geometry type to be converted to * \param destType the geometry type to be converted to
* \param destMultipart determines if the output geometry will be multipart or not * \param destMultipart determines if the output geometry will be multipart or not
* \return the converted geometry or nullptr if the conversion fails. * \returns the converted geometry or nullptr if the conversion fails.
* \since QGIS 2.2 * \since QGIS 2.2
*/ */
QgsGeometry convertToType( QgsWkbTypes::GeometryType destType, bool destMultipart = false ) const; QgsGeometry convertToType( QgsWkbTypes::GeometryType destType, bool destMultipart = false ) const;
@ -833,12 +833,12 @@ class CORE_EXPORT QgsGeometry
/** Delete a ring in polygon or multipolygon. /** Delete a ring in polygon or multipolygon.
Ring 0 is outer ring and can't be deleted. Ring 0 is outer ring and can't be deleted.
\return true on success \returns true on success
\since QGIS 1.2 */ \since QGIS 1.2 */
bool deleteRing( int ringNum, int partNum = 0 ); bool deleteRing( int ringNum, int partNum = 0 );
/** Delete part identified by the part number /** Delete part identified by the part number
\return true on success \returns true on success
\since QGIS 1.2 */ \since QGIS 1.2 */
bool deletePart( int partNum ); bool deletePart( int partNum );
@ -848,7 +848,7 @@ class CORE_EXPORT QgsGeometry
* If it is already a multipart geometry, it will return true and * If it is already a multipart geometry, it will return true and
* not change the geometry. * not change the geometry.
* *
* \return true in case of success and false else * \returns true in case of success and false else
*/ */
bool convertToMultiType(); bool convertToMultiType();
@ -859,12 +859,12 @@ class CORE_EXPORT QgsGeometry
* If it is already a single part geometry, it will return true and * If it is already a single part geometry, it will return true and
* not change the geometry. * not change the geometry.
* *
* \return true in case of success and false else * \returns true in case of success and false else
*/ */
bool convertToSingleType(); bool convertToSingleType();
/** Modifies geometry to avoid intersections with the layers specified in project properties /** Modifies geometry to avoid intersections with the layers specified in project properties
* \return 0 in case of success, * \returns 0 in case of success,
* 1 if geometry is not of polygon type, * 1 if geometry is not of polygon type,
* 2 if avoid intersection would change the geometry type, * 2 if avoid intersection would change the geometry type,
* 3 other error during intersection removal * 3 other error during intersection removal
@ -884,7 +884,7 @@ class CORE_EXPORT QgsGeometry
* of lower-to-equal dimension geometries or a geometry of lower dimension. * of lower-to-equal dimension geometries or a geometry of lower dimension.
* Single polygons may become multi-geometries in case of self-intersections. * Single polygons may become multi-geometries in case of self-intersections.
* It preserves Z values, but M values will be dropped. * It preserves Z values, but M values will be dropped.
* \return new valid QgsGeometry or null geometry on error * \returns new valid QgsGeometry or null geometry on error
* \since QGIS 3.0 * \since QGIS 3.0
*/ */
QgsGeometry makeValid(); QgsGeometry makeValid();

View File

@ -115,7 +115,7 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry
/** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments.
* \param vertex the vertex id * \param vertex the vertex id
* \return rotation in radians, clockwise from north * \returns rotation in radians, clockwise from north
*/ */
double vertexAngle( QgsVertexId vertex ) const override; double vertexAngle( QgsVertexId vertex ) const override;

View File

@ -36,13 +36,13 @@ class QgsGeometryEditUtils
public: public:
/** Adds interior ring (taking ownership). /** Adds interior ring (taking ownership).
\return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, \returns 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed,
3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/ 3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/
// TODO QGIS 3.0 returns an enum instead of a magic constant // TODO QGIS 3.0 returns an enum instead of a magic constant
static int addRing( QgsAbstractGeometry *geom, QgsCurve *ring ); static int addRing( QgsAbstractGeometry *geom, QgsCurve *ring );
/** Adds part to multi type geometry (taking ownership) /** Adds part to multi type geometry (taking ownership)
\return 0 in case of success, 1 if not a multigeometry, 2 if part is not a valid geometry, 3 if new polygon ring \returns 0 in case of success, 1 if not a multigeometry, 2 if part is not a valid geometry, 3 if new polygon ring
not disjoint with existing polygons of the feature*/ not disjoint with existing polygons of the feature*/
// TODO QGIS 3.0 returns an enum instead of a magic constant // TODO QGIS 3.0 returns an enum instead of a magic constant
static int addPart( QgsAbstractGeometry *geom, QgsAbstractGeometry *part ); static int addPart( QgsAbstractGeometry *geom, QgsAbstractGeometry *part );

View File

@ -83,7 +83,7 @@ class CORE_EXPORT QgsGeometryUtils
* \param q1 Point on the second line * \param q1 Point on the second line
* \param w Direction vector of the second line * \param w Direction vector of the second line
* \param inter Output parameter, the intersection point * \param inter Output parameter, the intersection point
* \return Whether the lines intersect * \returns Whether the lines intersect
*/ */
static bool lineIntersection( const QgsPointV2 &p1, QgsVector v, const QgsPointV2 &q1, QgsVector w, QgsPointV2 &inter ); static bool lineIntersection( const QgsPointV2 &p1, QgsVector v, const QgsPointV2 &q1, QgsVector w, QgsPointV2 &inter );
@ -95,7 +95,7 @@ class CORE_EXPORT QgsGeometryUtils
* \param q2 Second segment end point * \param q2 Second segment end point
* \param inter Output parameter, the intersection point * \param inter Output parameter, the intersection point
* \param tolerance The tolerance to use * \param tolerance The tolerance to use
* \return Whether the segments intersect * \returns Whether the segments intersect
*/ */
static bool segmentIntersection( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &q1, const QgsPointV2 &q2, QgsPointV2 &inter, double tolerance ); static bool segmentIntersection( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &q1, const QgsPointV2 &q2, QgsPointV2 &inter, double tolerance );
@ -104,7 +104,7 @@ class CORE_EXPORT QgsGeometryUtils
* \param p The point * \param p The point
* \param s1 The segment start point * \param s1 The segment start point
* \param s2 The segment end point * \param s2 The segment end point
* \return The projection of the point on the segment * \returns The projection of the point on the segment
*/ */
static QgsPointV2 projPointOnSegment( const QgsPointV2 &p, const QgsPointV2 &s1, const QgsPointV2 &s2 ) static QgsPointV2 projPointOnSegment( const QgsPointV2 &p, const QgsPointV2 &s1, const QgsPointV2 &s2 )
{ {
@ -128,7 +128,7 @@ class CORE_EXPORT QgsGeometryUtils
* \param part The part of the geometry to check * \param part The part of the geometry to check
* \param ring The ring of the geometry part to check * \param ring The ring of the geometry part to check
* \param tolerance The tolerance to use * \param tolerance The tolerance to use
* \return The list of self intersections * \returns The list of self intersections
* \note not available in Python bindings * \note not available in Python bindings
* \since QGIS 2.12 * \since QGIS 2.12
*/ */
@ -274,7 +274,7 @@ class CORE_EXPORT QgsGeometryUtils
* M value is computed if one of this point have M. * M value is computed if one of this point have M.
* \param pt1 first point. * \param pt1 first point.
* \param pt2 second point. * \param pt2 second point.
* \return New point at middle between points pt1 and pt2. * \returns New point at middle between points pt1 and pt2.
* * Example: * * Example:
* \code{.py} * \code{.py}
* p = QgsPointV2( 4, 6 ) # 2D point * p = QgsPointV2( 4, 6 ) # 2D point
@ -294,7 +294,7 @@ class CORE_EXPORT QgsGeometryUtils
/** Return the gradient of a line defined by points \a pt1 and \a pt2. /** Return the gradient of a line defined by points \a pt1 and \a pt2.
* \param pt1 first point. * \param pt1 first point.
* \param pt2 second point. * \param pt2 second point.
* \return The gradient of this linear entity, or infinity if vertical * \returns The gradient of this linear entity, or infinity if vertical
* \since QGIS 3.0 * \since QGIS 3.0
*/ */
static double gradient( const QgsPointV2 &pt1, const QgsPointV2 &pt2 ); static double gradient( const QgsPointV2 &pt1, const QgsPointV2 &pt2 );
@ -314,7 +314,7 @@ class CORE_EXPORT QgsGeometryUtils
* \param p The point * \param p The point
* \param s1 The segment start point * \param s1 The segment start point
* \param s2 The segment end point * \param s2 The segment end point
* \return A line (segment) from p to perpendicular point on segment [s1, s2] * \returns A line (segment) from p to perpendicular point on segment [s1, s2]
*/ */
static QgsLineString perpendicularSegment( const QgsPointV2 &p, const QgsPointV2 &s1, const QgsPointV2 &s2 ); static QgsLineString perpendicularSegment( const QgsPointV2 &p, const QgsPointV2 &s1, const QgsPointV2 &s2 );

View File

@ -79,7 +79,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
\param topological true if topological editing is enabled \param topological true if topological editing is enabled
\param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset
\param[out] errorMsg error messages emitted, if any \param[out] errorMsg error messages emitted, if any
\return 0 in case of success, 1 if geometry has not been split, error else*/ \returns 0 in case of success, 1 if geometry has not been split, error else*/
int splitGeometry( const QgsLineString &splitLine, int splitGeometry( const QgsLineString &splitLine,
QList<QgsAbstractGeometry *> &newGeometries, QList<QgsAbstractGeometry *> &newGeometries,
bool topological, bool topological,
@ -97,7 +97,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
* \param joinStyle join style for corners ( Round (1) / Mitre (2) / Bevel (3) ) * \param joinStyle join style for corners ( Round (1) / Mitre (2) / Bevel (3) )
* \param mitreLimit limit on the mitre ratio used for very sharp corners * \param mitreLimit limit on the mitre ratio used for very sharp corners
* \param errorMsg error messages emitted, if any * \param errorMsg error messages emitted, if any
* \return buffered geometry, or an nullptr if buffer could not be * \returns buffered geometry, or an nullptr if buffer could not be
* calculated * calculated
* \since QGIS 3.0 * \since QGIS 3.0
*/ */
@ -137,7 +137,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
* \param point point to seek proximity to * \param point point to seek proximity to
* \param errorMsg error messages emitted, if any * \param errorMsg error messages emitted, if any
* \note only valid for linestring geometries * \note only valid for linestring geometries
* \return distance along line, or -1 on error * \returns distance along line, or -1 on error
*/ */
double lineLocatePoint( const QgsPointV2 &point, QString *errorMsg = nullptr ) const; double lineLocatePoint( const QgsPointV2 &point, QString *errorMsg = nullptr ) const;

View File

@ -46,7 +46,7 @@ class QgsInternalGeometryEngine
* *
* \param x offset in x direction * \param x offset in x direction
* \param y offset in y direction * \param y offset in y direction
* \return an extruded polygon * \returns an extruded polygon
*/ */
QgsGeometry extrude( double x, double y ) const; QgsGeometry extrude( double x, double y ) const;

View File

@ -137,7 +137,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
void close(); void close();
/** Returns the geometry converted to the more generic curve type QgsCompoundCurve /** Returns the geometry converted to the more generic curve type QgsCompoundCurve
\return the converted geometry. Caller takes ownership*/ \returns the converted geometry. Caller takes ownership*/
QgsAbstractGeometry *toCurveType() const override; QgsAbstractGeometry *toCurveType() const override;
/** /**

View File

@ -45,7 +45,7 @@ class CORE_EXPORT QgsMultiLineString: public QgsMultiCurve
virtual bool addGeometry( QgsAbstractGeometry *g ) override; virtual bool addGeometry( QgsAbstractGeometry *g ) override;
/** Returns the geometry converted to the more generic curve type QgsMultiCurve /** Returns the geometry converted to the more generic curve type QgsMultiCurve
\return the converted geometry. Caller takes ownership*/ \returns the converted geometry. Caller takes ownership*/
QgsAbstractGeometry *toCurveType() const override; QgsAbstractGeometry *toCurveType() const override;
protected: protected:

View File

@ -45,7 +45,7 @@ class CORE_EXPORT QgsMultiPolygonV2: public QgsMultiSurface
virtual bool addGeometry( QgsAbstractGeometry *g ) override; virtual bool addGeometry( QgsAbstractGeometry *g ) override;
/** Returns the geometry converted to the more generic curve type QgsMultiSurface /** Returns the geometry converted to the more generic curve type QgsMultiSurface
\return the converted geometry. Caller takes ownership*/ \returns the converted geometry. Caller takes ownership*/
QgsAbstractGeometry *toCurveType() const override; QgsAbstractGeometry *toCurveType() const override;
virtual QgsAbstractGeometry *boundary() const override; virtual QgsAbstractGeometry *boundary() const override;

View File

@ -234,7 +234,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
* \param distance distance to project * \param distance distance to project
* \param azimuth angle to project in X Y, clockwise in degrees starting from north * \param azimuth angle to project in X Y, clockwise in degrees starting from north
* \param inclination angle to project in Z (3D) * \param inclination angle to project in Z (3D)
* \return The point projected. If a 2D point is projected a 3D point will be returned except if * \returns The point projected. If a 2D point is projected a 3D point will be returned except if
* inclination is 90. A 3D point is always returned if a 3D point is projected. * inclination is 90. A 3D point is always returned if a 3D point is projected.
* Example: * Example:
* \code{.py} * \code{.py}
@ -319,7 +319,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
/** Angle undefined. Always returns 0.0 /** Angle undefined. Always returns 0.0
\param vertex the vertex id \param vertex the vertex id
\return 0.0*/ \returns 0.0*/
double vertexAngle( QgsVertexId vertex ) const override { Q_UNUSED( vertex ); return 0.0; } double vertexAngle( QgsVertexId vertex ) const override { Q_UNUSED( vertex ); return 0.0; }
virtual int vertexCount( int /*part*/ = 0, int /*ring*/ = 0 ) const override { return 1; } virtual int vertexCount( int /*part*/ = 0, int /*ring*/ = 0 ) const override { return 1; }

View File

@ -52,7 +52,7 @@ class CORE_EXPORT QgsPolygonV2: public QgsCurvePolygon
QgsPolygonV2 *surfaceToPolygon() const override; QgsPolygonV2 *surfaceToPolygon() const override;
/** Returns the geometry converted to the more generic curve type QgsCurvePolygon /** Returns the geometry converted to the more generic curve type QgsCurvePolygon
\return the converted geometry. Caller takes ownership*/ \returns the converted geometry. Caller takes ownership*/
QgsAbstractGeometry *toCurveType() const override; QgsAbstractGeometry *toCurveType() const override;
void addInteriorRing( QgsCurve *ring ) override; void addInteriorRing( QgsCurve *ring ) override;

View File

@ -98,13 +98,13 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Returns coordinates of a vertex. * Returns coordinates of a vertex.
* \param atVertex index of the vertex * \param atVertex index of the vertex
* \return Coordinates of the vertex or QgsPointV2(0,0) on error (\a atVertex < 0 or > 3). * \returns Coordinates of the vertex or QgsPointV2(0,0) on error (\a atVertex < 0 or > 3).
*/ */
QgsPointV2 vertexAt( int atVertex ) const; QgsPointV2 vertexAt( int atVertex ) const;
/** /**
* Returns the three lengths of the triangle. * Returns the three lengths of the triangle.
* \return Lengths of triangle ABC where [AB] is at 0, [BC] is at 1, [CA] is at 2 * \returns Lengths of triangle ABC where [AB] is at 0, [BC] is at 1, [CA] is at 2
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -116,7 +116,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Returns the three angles of the triangle. * Returns the three angles of the triangle.
* \return Angles in radians of triangle ABC where angle BAC is at 0, angle ABC is at 1, angle BCA is at 2 * \returns Angles in radians of triangle ABC where angle BAC is at 0, angle ABC is at 1, angle BCA is at 2
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -129,7 +129,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Is the triangle isocele (two sides with the same length)? * Is the triangle isocele (two sides with the same length)?
* \param lengthTolerance The tolerance to use * \param lengthTolerance The tolerance to use
* \return True or False * \returns True or False
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -145,7 +145,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Is the triangle equilateral (three sides with the same length)? * Is the triangle equilateral (three sides with the same length)?
* \param lengthTolerance The tolerance to use * \param lengthTolerance The tolerance to use
* \return True or False * \returns True or False
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 10, 10 ), QgsPointV2( 16, 10 ), QgsPointV2( 13, 15.1962 ) ) * tri = QgsTriangle( QgsPointV2( 10, 10 ), QgsPointV2( 16, 10 ), QgsPointV2( 13, 15.1962 ) )
@ -161,7 +161,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Is the triangle right-angled? * Is the triangle right-angled?
* \param angleTolerance The tolerance to use * \param angleTolerance The tolerance to use
* \return True or False * \returns True or False
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -177,8 +177,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Is the triangle scalene (all sides have differen lengths)? * Is the triangle scalene (all sides have differen lengths)?
* \param lengthTolerance The tolerance to use * \param lengthTolerance The tolerance to use
* \return True or False * \returns True or False
* \return True or False * \returns True or False
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 7.2825, 4.2368 ), QgsPointV2( 13.0058, 3.3218 ), QgsPointV2( 9.2145, 6.5242 ) ) * tri = QgsTriangle( QgsPointV2( 7.2825, 4.2368 ), QgsPointV2( 13.0058, 3.3218 ), QgsPointV2( 9.2145, 6.5242 ) )
@ -193,7 +193,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* An altitude is a segment (defined by a QgsLineString) from a vertex to the opposite side (or, if necessary, to the extension of the opposite side). * An altitude is a segment (defined by a QgsLineString) from a vertex to the opposite side (or, if necessary, to the extension of the opposite side).
* \return Three altitudes from this triangle * \returns Three altitudes from this triangle
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -205,7 +205,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* A median is a segment (defined by a QgsLineString) from a vertex to the midpoint of the opposite side. * A median is a segment (defined by a QgsLineString) from a vertex to the midpoint of the opposite side.
* \return Three medians from this triangle * \returns Three medians from this triangle
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -218,7 +218,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* The segment (defined by a QgsLineString) returned bisect the angle of a vertex to the opposite side. * The segment (defined by a QgsLineString) returned bisect the angle of a vertex to the opposite side.
* \param lengthTolerance The tolerance to use * \param lengthTolerance The tolerance to use
* \return Three angle bisector from this triangle * \returns Three angle bisector from this triangle
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -230,7 +230,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Medial (or midpoint) triangle of a triangle ABC is the triangle with vertices at the midpoints of the triangle's sides. * Medial (or midpoint) triangle of a triangle ABC is the triangle with vertices at the midpoints of the triangle's sides.
* \return The medial from this triangle * \returns The medial from this triangle
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -243,7 +243,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* An orthocenter is the point of intersection of the altitudes of a triangle. * An orthocenter is the point of intersection of the altitudes of a triangle.
* \param lengthTolerance The tolerance to use * \param lengthTolerance The tolerance to use
* \return The orthocenter of the triangle. * \returns The orthocenter of the triangle.
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -255,7 +255,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Center of the circumscribed circle of the triangle. * Center of the circumscribed circle of the triangle.
* \return The center of the circumscribed circle of the triangle * \returns The center of the circumscribed circle of the triangle
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -267,7 +267,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Radius of the circumscribed circle of the triangle. * Radius of the circumscribed circle of the triangle.
* \return The radius of the circumscribed circle of the triangle * \returns The radius of the circumscribed circle of the triangle
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -282,7 +282,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Center of the inscribed circle of the triangle. * Center of the inscribed circle of the triangle.
* \return The center of the inscribed circle of the triangle * \returns The center of the inscribed circle of the triangle
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -294,7 +294,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
/** /**
* Radius of the inscribed circle of the triangle. * Radius of the inscribed circle of the triangle.
* \return The radius of the inscribed circle of the triangle * \returns The radius of the inscribed circle of the triangle
* * Example: * * Example:
* \code{.py} * \code{.py}
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
@ -313,7 +313,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
* \param p1 first point * \param p1 first point
* \param p2 second point * \param p2 second point
* \param p3 third point * \param p3 third point
* \return True if the points can create a triangle, otherwise false. * \returns True if the points can create a triangle, otherwise false.
* \note not available in Python bindings * \note not available in Python bindings
*/ */
bool validateGeom( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &p3 ); bool validateGeom( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &p3 );

View File

@ -930,7 +930,7 @@ class CORE_EXPORT QgsWkbTypes
/** /**
* Will convert the 25D version of the flat type if supported or Unknown if not supported. * Will convert the 25D version of the flat type if supported or Unknown if not supported.
* \param type The type to convert * \param type The type to convert
* \return the 25D version of the type or Unknown * \returns the 25D version of the type or Unknown
*/ */
static Type to25D( Type type ) static Type to25D( Type type )
{ {

View File

@ -117,7 +117,7 @@ Q_OBJECT
* Get value of specified property from the registry. * Get value of specified property from the registry.
* \param key handle to an open key. * \param key handle to an open key.
* \param property property name. * \param property property name.
* \return property value. * \returns property value.
*/ */
static QString getRegKeyValue(HKEY key, LPCTSTR property); static QString getRegKeyValue(HKEY key, LPCTSTR property);
@ -128,7 +128,7 @@ Q_OBJECT
* \param devData pointer to an SP_DEVINFO_DATA structure that defines the device instance. * \param devData pointer to an SP_DEVINFO_DATA structure that defines the device instance.
* this is returned by SetupDiGetDeviceInterfaceDetail() function. * this is returned by SetupDiGetDeviceInterfaceDetail() function.
* \param property registry property. One of defined SPDRP_* constants. * \param property registry property. One of defined SPDRP_* constants.
* \return property string. * \returns property string.
*/ */
static QString getDeviceProperty(HDEVINFO devInfo, PSP_DEVINFO_DATA devData, DWORD property); static QString getDeviceProperty(HDEVINFO devInfo, PSP_DEVINFO_DATA devData, DWORD property);
@ -178,7 +178,7 @@ Q_OBJECT
public: public:
/*! /*!
Get list of ports. Get list of ports.
\return list of ports currently available in the system. \returns list of ports currently available in the system.
*/ */
static QList<QextPortInfo> getPorts(); static QList<QextPortInfo> getPorts();
/*! /*!

View File

@ -200,7 +200,7 @@ class QextSerialPort: public QIODevice
/**! /**!
* Get query mode. * Get query mode.
* \return query mode. * \returns query mode.
*/ */
inline QueryMode queryMode() const { return _queryMode; } inline QueryMode queryMode() const { return _queryMode; }

View File

@ -107,7 +107,7 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject
* \param settings Legend layout configuration * \param settings Legend layout configuration
* \param ctx Context for rendering - may be null if only doing layout without actual rendering * \param ctx Context for rendering - may be null if only doing layout without actual rendering
* \param itemHeight Minimal height of the legend item - used for correct positioning when rendering * \param itemHeight Minimal height of the legend item - used for correct positioning when rendering
* \return Real size of the symbol (may be bigger than "normal" symbol size from settings) * \returns Real size of the symbol (may be bigger than "normal" symbol size from settings)
*/ */
virtual QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const; virtual QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const;
@ -116,7 +116,7 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject
* \param settings Legend layout configuration * \param settings Legend layout configuration
* \param ctx Context for rendering - may be null if only doing layout without actual rendering * \param ctx Context for rendering - may be null if only doing layout without actual rendering
* \param symbolSize Real size of the associated symbol - used for correct positioning when rendering * \param symbolSize Real size of the associated symbol - used for correct positioning when rendering
* \return Size of the label (may span multiple lines) * \returns Size of the label (may span multiple lines)
*/ */
virtual QSizeF drawSymbolText( const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize ) const; virtual QSizeF drawSymbolText( const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize ) const;

View File

@ -124,7 +124,7 @@ namespace pal
* \param bboxMax max values of the map extent * \param bboxMax max values of the map extent
* \param mapShape generate candidates for this spatial entity * \param mapShape generate candidates for this spatial entity
* \param candidates index for candidates * \param candidates index for candidates
* \return the number of candidates generated in lPos * \returns the number of candidates generated in lPos
*/ */
int createCandidates( QList<LabelPosition *> &lPos, double bboxMin[2], double bboxMax[2], PointSet *mapShape, RTree<LabelPosition *, double, 2, double> *candidates ); int createCandidates( QList<LabelPosition *> &lPos, double bboxMin[2], double bboxMax[2], PointSet *mapShape, RTree<LabelPosition *, double, 2, double> *candidates );
@ -203,7 +203,7 @@ namespace pal
/** Generate candidates for polygon features. /** Generate candidates for polygon features.
* \param lPos pointer to an array of candidates, will be filled by generated candidates * \param lPos pointer to an array of candidates, will be filled by generated candidates
* \param mapShape a pointer to the polygon * \param mapShape a pointer to the polygon
* \return the number of generated candidates * \returns the number of generated candidates
*/ */
int createCandidatesForPolygon( QList<LabelPosition *> &lPos, PointSet *mapShape ); int createCandidatesForPolygon( QList<LabelPosition *> &lPos, PointSet *mapShape );

View File

@ -81,7 +81,7 @@ namespace pal
* \param y y coordinates * \param y y coordinates
* \param n Size of subset (vector id) * \param n Size of subset (vector id)
* \param cHull returns the point id (id of id's vector...) whom are parts of the convex hull * \param cHull returns the point id (id of id's vector...) whom are parts of the convex hull
* \return convexHull's size * \returns convexHull's size
*/ */
static int convexHullId( int *id, const double *const x, const double *const y, int n, int *&cHull ); static int convexHullId( int *id, const double *const x, const double *const y, int n, int *&cHull );

View File

@ -121,7 +121,7 @@ namespace pal
* \brief Check whether or not this overlap with another labelPosition * \brief Check whether or not this overlap with another labelPosition
* *
* \param ls other labelposition * \param ls other labelposition
* \return true or false * \returns true or false
*/ */
bool isInConflict( LabelPosition *ls ); bool isInConflict( LabelPosition *ls );
@ -150,13 +150,13 @@ namespace pal
void offsetPosition( double xOffset, double yOffset ); void offsetPosition( double xOffset, double yOffset );
/** \brief return id /** \brief return id
* \return id * \returns id
*/ */
int getId() const; int getId() const;
/** \brief return the feature corresponding to this labelposition /** \brief return the feature corresponding to this labelposition
* \return the feature * \returns the feature
*/ */
FeaturePart *getFeaturePart(); FeaturePart *getFeaturePart();
@ -202,13 +202,13 @@ namespace pal
/** /**
* \brief get the down-left x coordinate * \brief get the down-left x coordinate
* \return x coordinate * \returns x coordinate
*/ */
double getX( int i = 0 ) const; double getX( int i = 0 ) const;
/** /**
* \brief get the down-left y coordinate * \brief get the down-left y coordinate
* \return y coordinate * \returns y coordinate
*/ */
double getY( int i = 0 ) const; double getY( int i = 0 ) const;
@ -217,7 +217,7 @@ namespace pal
/** /**
* \brief get alpha * \brief get alpha
* \return alpha to rotate text (in rad) * \returns alpha to rotate text (in rad)
*/ */
double getAlpha() const; double getAlpha() const;
bool getReversed() const { return reversed; } bool getReversed() const { return reversed; }

View File

@ -225,7 +225,7 @@ namespace pal
* *
* @throws PalException::FeatureExists * @throws PalException::FeatureExists
* *
* \return true on success (i.e. valid geometry) * \returns true on success (i.e. valid geometry)
*/ */
bool registerFeature( QgsLabelFeature *label ); bool registerFeature( QgsLabelFeature *label );

View File

@ -134,7 +134,7 @@ namespace pal
* \param stats A PalStat object (can be NULL) * \param stats A PalStat object (can be NULL)
* \param displayAll if true, all feature will be labelled even though overlaps occur * \param displayAll if true, all feature will be labelled even though overlaps occur
* *
* \return A list of label to display on map * \returns A list of label to display on map
*/ */
QList<LabelPosition *> *labeller( double bbox[4], PalStat **stats, bool displayAll ); QList<LabelPosition *> *labeller( double bbox[4], PalStat **stats, bool displayAll );
@ -160,7 +160,7 @@ namespace pal
/** /**
* \brief Get flag show partial label * \brief Get flag show partial label
* *
* \return value of flag * \returns value of flag
*/ */
bool getShowPartial(); bool getShowPartial();
@ -216,7 +216,7 @@ namespace pal
/** /**
* \brief get the search method in use * \brief get the search method in use
* *
* \return the search method * \returns the search method
*/ */
SearchMethod getSearch(); SearchMethod getSearch();
@ -317,13 +317,13 @@ namespace pal
/** /**
* \brief Get the minimum # of iteration doing in POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN * \brief Get the minimum # of iteration doing in POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN
* \return minimum # of iteration * \returns minimum # of iteration
*/ */
int getMinIt(); int getMinIt();
/** /**
* \brief Get the maximum # of iteration doing in POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN * \brief Get the maximum # of iteration doing in POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN
* \return maximum # of iteration * \returns maximum # of iteration
*/ */
int getMaxIt(); int getMaxIt();

View File

@ -113,7 +113,7 @@ class CORE_EXPORT QgsApplication : public QApplication
* @brief All themes found in ~/.qgis3/themes folder. * @brief All themes found in ~/.qgis3/themes folder.
* The path is to the root folder for the theme * The path is to the root folder for the theme
* \note Valid theme folders must contain a style.qss file. * \note Valid theme folders must contain a style.qss file.
* \return A hash of theme name and theme path. Valid theme folders contain style.qss * \returns A hash of theme name and theme path. Valid theme folders contain style.qss
*/ */
static QHash<QString, QString> uiThemes(); static QHash<QString, QString> uiThemes();
@ -318,7 +318,7 @@ class CORE_EXPORT QgsApplication : public QApplication
* Typically you will use this method by doing: * Typically you will use this method by doing:
* QString myStyle = QgsApplication::reportStyleSheet(); * QString myStyle = QgsApplication::reportStyleSheet();
* textBrowserReport->document()->setDefaultStyleSheet(myStyle); * textBrowserReport->document()->setDefaultStyleSheet(myStyle);
* \return QString containing the CSS 2.1 compliant stylesheet. * \returns QString containing the CSS 2.1 compliant stylesheet.
* \note you can use the special Qt extensions too, for example * \note you can use the special Qt extensions too, for example
* the gradient fills for backgrounds. * the gradient fills for backgrounds.
*/ */

View File

@ -63,14 +63,14 @@ class CORE_EXPORT QgsAttributeEditorElement
/** /**
* Return the name of this element * Return the name of this element
* *
* \return The name for this element * \returns The name for this element
*/ */
QString name() const { return mName; } QString name() const { return mName; }
/** /**
* The type of this element * The type of this element
* *
* \return The type * \returns The type
*/ */
AttributeEditorType type() const { return mType; } AttributeEditorType type() const { return mType; }
@ -86,7 +86,7 @@ class CORE_EXPORT QgsAttributeEditorElement
* *
* \param doc The QDomDocument which is used to create new XML elements * \param doc The QDomDocument which is used to create new XML elements
* *
* \return A DOM element to serialize this element * \returns A DOM element to serialize this element
*/ */
QDomElement toDomElement( QDomDocument &doc ) const; QDomElement toDomElement( QDomDocument &doc ) const;
@ -176,14 +176,14 @@ class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement
/** /**
* Returns if this container is going to be rendered as a group box * Returns if this container is going to be rendered as a group box
* *
* \return True if it will be a group box, false if it will be a tab * \returns True if it will be a group box, false if it will be a tab
*/ */
virtual bool isGroupBox() const { return mIsGroupBox; } virtual bool isGroupBox() const { return mIsGroupBox; }
/** /**
* Get a list of the children elements of this container * Get a list of the children elements of this container
* *
* \return A list of elements * \returns A list of elements
*/ */
QList<QgsAttributeEditorElement *> children() const { return mChildren; } QList<QgsAttributeEditorElement *> children() const { return mChildren; }
@ -192,7 +192,7 @@ class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement
* *
* \param type The type which should be searched * \param type The type which should be searched
* *
* \return A list of elements of the type which has been searched for * \returns A list of elements of the type which has been searched for
*/ */
virtual QList<QgsAttributeEditorElement *> findElements( AttributeEditorType type ) const; virtual QList<QgsAttributeEditorElement *> findElements( AttributeEditorType type ) const;
@ -272,7 +272,7 @@ class CORE_EXPORT QgsAttributeEditorField : public QgsAttributeEditorElement
/** /**
* Return the index of the field * Return the index of the field
* \return * \returns
*/ */
int idx() const { return mIdx; } int idx() const { return mIdx; }
@ -323,7 +323,7 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement
/** /**
* Get the id of the relation which shall be embedded * Get the id of the relation which shall be embedded
* *
* \return the id * \returns the id
*/ */
const QgsRelation &relation() const { return mRelation; } const QgsRelation &relation() const { return mRelation; }
@ -331,7 +331,7 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement
* Initializes the relation from the id * Initializes the relation from the id
* *
* \param relManager The relation manager to use for the initialization * \param relManager The relation manager to use for the initialization
* \return true if the relation was found in the relationmanager * \returns true if the relation was found in the relationmanager
*/ */
bool init( QgsRelationManager *relManager ); bool init( QgsRelationManager *relManager );

View File

@ -94,7 +94,7 @@ class CORE_EXPORT QgsAttributes : public QVector<QVariant>
* handle NULL values for certain types (like int). * handle NULL values for certain types (like int).
* *
* \param v The attributes to compare * \param v The attributes to compare
* \return True if v is equal * \returns True if v is equal
*/ */
bool operator==( const QgsAttributes &v ) const bool operator==( const QgsAttributes &v ) const
{ {

View File

@ -118,7 +118,7 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel
* \param path item path * \param path item path
* \param matchFlag supported is Qt::MatchExactly and Qt::MatchStartsWith which has reverse meaning, i.e. find * \param matchFlag supported is Qt::MatchExactly and Qt::MatchStartsWith which has reverse meaning, i.e. find
* item with the longest match from start with path (to get as close/deep as possible to deleted item). * item with the longest match from start with path (to get as close/deep as possible to deleted item).
* \return model index, invalid if item not found */ * \returns model index, invalid if item not found */
QModelIndex findPath( const QString &path, Qt::MatchFlag matchFlag = Qt::MatchExactly ); QModelIndex findPath( const QString &path, Qt::MatchFlag matchFlag = Qt::MatchExactly );
//! \note not available in Python bindings //! \note not available in Python bindings

View File

@ -42,14 +42,14 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator
/** /**
* Rewind to the beginning of the iterator * Rewind to the beginning of the iterator
* *
* \return bool true if the operation was ok * \returns bool true if the operation was ok
*/ */
virtual bool rewind() override; virtual bool rewind() override;
/** /**
* Close this iterator. No further features will be available. * Close this iterator. No further features will be available.
* *
* \return true if successful * \returns true if successful
*/ */
virtual bool close() override; virtual bool close() override;
@ -60,7 +60,7 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator
* Implementation for fetching a feature. * Implementation for fetching a feature.
* *
* \param f Will write to this feature * \param f Will write to this feature
* \return bool true if the operation was ok * \returns bool true if the operation was ok
* *
* @see bool getFeature( QgsFeature& f ) * @see bool getFeature( QgsFeature& f )
*/ */
@ -70,7 +70,7 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator
* We have a local special iterator for FilterFids, no need to run the generic. * We have a local special iterator for FilterFids, no need to run the generic.
* *
* \param f Will write to this feature * \param f Will write to this feature
* \return bool true if the operation was ok * \returns bool true if the operation was ok
*/ */
virtual bool nextFeatureFilterFids( QgsFeature &f ) override { return fetchFeature( f ); } virtual bool nextFeatureFilterFids( QgsFeature &f ) override { return fetchFeature( f ); }
@ -100,14 +100,14 @@ class CORE_EXPORT QgsCachedFeatureWriterIterator : public QgsAbstractFeatureIter
/** /**
* Rewind to the beginning of the iterator * Rewind to the beginning of the iterator
* *
* \return bool true if the operation was ok * \returns bool true if the operation was ok
*/ */
virtual bool rewind() override; virtual bool rewind() override;
/** /**
* Close this iterator. No further features will be available. * Close this iterator. No further features will be available.
* *
* \return true if successful * \returns true if successful
*/ */
virtual bool close() override; virtual bool close() override;
@ -117,7 +117,7 @@ class CORE_EXPORT QgsCachedFeatureWriterIterator : public QgsAbstractFeatureIter
* Implementation for fetching a feature. * Implementation for fetching a feature.
* *
* \param f Will write to this feature * \param f Will write to this feature
* \return bool true if the operation was ok * \returns bool true if the operation was ok
* *
* @see bool getFeature( QgsFeature& f ) * @see bool getFeature( QgsFeature& f )
*/ */

View File

@ -71,7 +71,7 @@ class CORE_EXPORT QgsAbstractCacheIndex
* value is true. * value is true.
* \param featureRequest The feature request, for which this index is queried. * \param featureRequest The feature request, for which this index is queried.
* *
* \return True, if this index holds the information to answer the request. * \returns True, if this index holds the information to answer the request.
* *
*/ */
virtual bool getCacheIterator( QgsFeatureIterator &featureIterator, const QgsFeatureRequest &featureRequest ) = 0; virtual bool getCacheIterator( QgsFeatureIterator &featureIterator, const QgsFeatureRequest &featureRequest ) = 0;

View File

@ -100,7 +100,7 @@ class CORE_EXPORT QgsClipper
/** Takes a linestring and clips it to clipExtent /** Takes a linestring and clips it to clipExtent
* \param curve the linestring * \param curve the linestring
* \param clipExtent clipping bounds * \param clipExtent clipping bounds
* \return clipped line coordinates * \returns clipped line coordinates
*/ */
static QPolygonF clippedLine( const QgsCurve &curve, const QgsRectangle &clipExtent ); static QPolygonF clippedLine( const QgsCurve &curve, const QgsRectangle &clipExtent );

View File

@ -43,7 +43,7 @@ class CORE_EXPORT QgsConditionalLayerStyles
/** /**
* @brief Returns the conditional styles set for the field UI properties * @brief Returns the conditional styles set for the field UI properties
* \return A list of conditional styles that have been set. * \returns A list of conditional styles that have been set.
*/ */
QList<QgsConditionalStyle> fieldStyles( const QString &fieldName ); QList<QgsConditionalStyle> fieldStyles( const QString &fieldName );
@ -77,13 +77,13 @@ class CORE_EXPORT QgsConditionalStyle
* @brief Check if the rule matches using the given value and feature * @brief Check if the rule matches using the given value and feature
* \param value The current value being checked. The "value" variable from the context is replaced with this value. * \param value The current value being checked. The "value" variable from the context is replaced with this value.
* \param context Expression context for evaluating rule expression * \param context Expression context for evaluating rule expression
* \return True of the rule matches against the given feature * \returns True of the rule matches against the given feature
*/ */
bool matches( const QVariant &value, QgsExpressionContext &context ) const; bool matches( const QVariant &value, QgsExpressionContext &context ) const;
/** /**
* @brief Render a preview icon of the rule. * @brief Render a preview icon of the rule.
* \return QPixmap preview of the style * \returns QPixmap preview of the style
*/ */
QPixmap renderPreview() const; QPixmap renderPreview() const;
@ -126,71 +126,71 @@ class CORE_EXPORT QgsConditionalStyle
/** /**
* @brief The name of the style. * @brief The name of the style.
* \return The name of the style. Names are optional so might be empty. * \returns The name of the style. Names are optional so might be empty.
*/ */
QString displayText() const; QString displayText() const;
/** /**
* @brief The name of the style. * @brief The name of the style.
* \return The name of the style. Names are optional so might be empty. * \returns The name of the style. Names are optional so might be empty.
*/ */
QString name() const { return mName; } QString name() const { return mName; }
/** /**
* @brief The icon set for style generated from the set symbol * @brief The icon set for style generated from the set symbol
* \return A QPixmap that was set for the icon using the symbol * \returns A QPixmap that was set for the icon using the symbol
*/ */
QPixmap icon() const { return mIcon; } QPixmap icon() const { return mIcon; }
/** /**
* @brief The symbol used to generate the icon for the style * @brief The symbol used to generate the icon for the style
* \return The QgsSymbol used for the icon * \returns The QgsSymbol used for the icon
*/ */
QgsSymbol *symbol() const { return mSymbol.get(); } QgsSymbol *symbol() const { return mSymbol.get(); }
/** /**
* @brief The text color set for style * @brief The text color set for style
* \return QColor for text color * \returns QColor for text color
*/ */
QColor textColor() const { return mTextColor; } QColor textColor() const { return mTextColor; }
/** /**
* @brief Check if the text color is valid for render. * @brief Check if the text color is valid for render.
* Valid colors are non invalid QColors and a color with a > 0 alpha * Valid colors are non invalid QColors and a color with a > 0 alpha
* \return True of the color set for text is valid. * \returns True of the color set for text is valid.
*/ */
bool validTextColor() const; bool validTextColor() const;
/** /**
* @brief The background color for style * @brief The background color for style
* \return QColor for background color * \returns QColor for background color
*/ */
QColor backgroundColor() const { return mBackColor; } QColor backgroundColor() const { return mBackColor; }
/** /**
* @brief Check if the background color is valid for render. * @brief Check if the background color is valid for render.
* Valid colors are non invalid QColors and a color with a > 0 alpha * Valid colors are non invalid QColors and a color with a > 0 alpha
* \return True of the color set for background is valid. * \returns True of the color set for background is valid.
*/ */
bool validBackgroundColor() const; bool validBackgroundColor() const;
/** /**
* @brief The font for the style * @brief The font for the style
* \return QFont for the style * \returns QFont for the style
*/ */
QFont font() const { return mFont; } QFont font() const { return mFont; }
/** /**
* @brief The condition rule set for the style. Rule may contain variable \@value * @brief The condition rule set for the style. Rule may contain variable \@value
* to represent the current value * to represent the current value
* \return QString of the current set rule * \returns QString of the current set rule
*/ */
QString rule() const { return mRule; } QString rule() const { return mRule; }
/** /**
* @brief isValid Check if this rule is valid. A valid rule has one or more properties * @brief isValid Check if this rule is valid. A valid rule has one or more properties
* set. * set.
* \return True if the rule is valid. * \returns True if the rule is valid.
*/ */
bool isValid() const { return mValid; } bool isValid() const { return mValid; }
@ -198,7 +198,7 @@ class CORE_EXPORT QgsConditionalStyle
* @brief Find and return the matching styles for the value and feature. * @brief Find and return the matching styles for the value and feature.
* If no match is found a invalid QgsConditionalStyle is return. * If no match is found a invalid QgsConditionalStyle is return.
* *
* \return A condtional style that matches the value and feature. * \returns A condtional style that matches the value and feature.
* Check with QgsConditionalStyle::isValid() * Check with QgsConditionalStyle::isValid()
*/ */
static QList<QgsConditionalStyle> matchingConditionalStyles( const QList<QgsConditionalStyle> &styles, const QVariant &value, QgsExpressionContext &context ); static QList<QgsConditionalStyle> matchingConditionalStyles( const QList<QgsConditionalStyle> &styles, const QVariant &value, QgsExpressionContext &context );
@ -207,7 +207,7 @@ class CORE_EXPORT QgsConditionalStyle
* @brief Find and return the matching style for the value and feature. * @brief Find and return the matching style for the value and feature.
* If no match is found a invalid QgsConditionalStyle is return. * If no match is found a invalid QgsConditionalStyle is return.
* *
* \return A condtional style that matches the value and feature. * \returns A condtional style that matches the value and feature.
* Check with QgsConditionalStyle::isValid() * Check with QgsConditionalStyle::isValid()
*/ */
static QgsConditionalStyle matchingConditionalStyle( const QList<QgsConditionalStyle> &styles, const QVariant &value, QgsExpressionContext &context ); static QgsConditionalStyle matchingConditionalStyle( const QList<QgsConditionalStyle> &styles, const QVariant &value, QgsExpressionContext &context );
@ -216,7 +216,7 @@ class CORE_EXPORT QgsConditionalStyle
* @brief Compress a list of styles into a single style. This can be used to stack the elements of the * @brief Compress a list of styles into a single style. This can be used to stack the elements of the
* styles. The font of the last style is used in the output. * styles. The font of the last style is used in the output.
* \param styles The list of styles to compress down * \param styles The list of styles to compress down
* \return A single style generated from joining each style property. * \returns A single style generated from joining each style property.
*/ */
static QgsConditionalStyle compressStyles( const QList<QgsConditionalStyle> &styles ); static QgsConditionalStyle compressStyles( const QList<QgsConditionalStyle> &styles );

View File

@ -256,7 +256,7 @@ class QgsConnectionPool
} }
//! Try to acquire a connection: if no connections are available, the thread will get blocked. //! Try to acquire a connection: if no connections are available, the thread will get blocked.
//! \return initialized connection or null on error //! \returns initialized connection or null on error
T acquireConnection( const QString &connInfo ) T acquireConnection( const QString &connInfo )
{ {
mMutex.lock(); mMutex.lock();

View File

@ -293,7 +293,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* Sets this CRS by lookup of the given ID in the CRS database. * Sets this CRS by lookup of the given ID in the CRS database.
* \note We encourage you to use EPSG code, WKT or Proj4 to describe CRS's in your code * \note We encourage you to use EPSG code, WKT or Proj4 to describe CRS's in your code
* wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile. * wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile.
* \return True on success else false * \returns True on success else false
*/ */
// TODO QGIS 3: remove type and always use EPSG code, rename to createFromEpsg // TODO QGIS 3: remove type and always use EPSG code, rename to createFromEpsg
bool createFromId( const long id, CrsType type = PostgisCrsId ); bool createFromId( const long id, CrsType type = PostgisCrsId );
@ -305,7 +305,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* It also recognizes "QGIS", "USER", "CUSTOM" authorities, which all have the same meaning * It also recognizes "QGIS", "USER", "CUSTOM" authorities, which all have the same meaning
* and refer to QGIS internal CRS IDs. * and refer to QGIS internal CRS IDs.
* \note this method uses an internal cache. Call invalidateCache() to clear the cache. * \note this method uses an internal cache. Call invalidateCache() to clear the cache.
* \return True on success else false * \returns True on success else false
* @see fromOgcWmsCrs() * @see fromOgcWmsCrs()
*/ */
// TODO QGIS 3: remove "QGIS" and "CUSTOM", only support "USER" (also returned by authid()) // TODO QGIS 3: remove "QGIS" and "CUSTOM", only support "USER" (also returned by authid())
@ -313,7 +313,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
/** Sets this CRS by lookup of the given PostGIS SRID in the CRS database. /** Sets this CRS by lookup of the given PostGIS SRID in the CRS database.
* \param srid The postgis SRID for the desired spatial reference system. * \param srid The postgis SRID for the desired spatial reference system.
* \return True on success else false * \returns True on success else false
*/ */
// TODO QGIS 3: remove unless really necessary - let's use EPSG codes instead // TODO QGIS 3: remove unless really necessary - let's use EPSG codes instead
bool createFromSrid( const long srid ); bool createFromSrid( const long srid );
@ -327,7 +327,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \note Some members may be left blank if no match can be found in CRS database. * \note Some members may be left blank if no match can be found in CRS database.
* \note this method uses an internal cache. Call invalidateCache() to clear the cache. * \note this method uses an internal cache. Call invalidateCache() to clear the cache.
* \param wkt The WKT for the desired spatial reference system. * \param wkt The WKT for the desired spatial reference system.
* \return True on success else false * \returns True on success else false
* @see fromWkt() * @see fromWkt()
*/ */
bool createFromWkt( const QString &wkt ); bool createFromWkt( const QString &wkt );
@ -338,7 +338,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* user's local CRS database from home directory is used. * user's local CRS database from home directory is used.
* \note this method uses an internal cache. Call invalidateCache() to clear the cache. * \note this method uses an internal cache. Call invalidateCache() to clear the cache.
* \param srsId The internal QGIS CRS ID for the desired spatial reference system. * \param srsId The internal QGIS CRS ID for the desired spatial reference system.
* \return True on success else false * \returns True on success else false
* @see fromSrsId() * @see fromSrsId()
*/ */
bool createFromSrsId( const long srsId ); bool createFromSrsId( const long srsId );
@ -362,7 +362,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \note Some members may be left blank if no match can be found in CRS database. * \note Some members may be left blank if no match can be found in CRS database.
* \note this method uses an internal cache. Call invalidateCache() to clear the cache. * \note this method uses an internal cache. Call invalidateCache() to clear the cache.
* \param projString A proj4 format string * \param projString A proj4 format string
* \return True on success else false * \returns True on success else false
* @see fromProj4() * @see fromProj4()
*/ */
bool createFromProj4( const QString &projString ); bool createFromProj4( const QString &projString );
@ -378,7 +378,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* *
* If no prefix is specified, WKT definition is assumed. * If no prefix is specified, WKT definition is assumed.
* \param definition A String containing a coordinate reference system definition. * \param definition A String containing a coordinate reference system definition.
* \return True on success else false * \returns True on success else false
*/ */
bool createFromString( const QString &definition ); bool createFromString( const QString &definition );
@ -394,7 +394,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \note this function generates a WKT string using OSRSetFromUserInput() and * \note this function generates a WKT string using OSRSetFromUserInput() and
* passes it to createFromWkt() function. * passes it to createFromWkt() function.
* \param definition A String containing a coordinate reference system definition. * \param definition A String containing a coordinate reference system definition.
* \return True on success else false * \returns True on success else false
*/ */
// TODO QGIS3: rename to createFromStringOGR so it is clear it's similar to createFromString, just different backend // TODO QGIS3: rename to createFromStringOGR so it is clear it's similar to createFromString, just different backend
bool createFromUserInput( const QString &definition ); bool createFromUserInput( const QString &definition );
@ -428,7 +428,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* stored PROJ.4 string to a database entry in order to fill in further * stored PROJ.4 string to a database entry in order to fill in further
* pieces of information about CRS. * pieces of information about CRS.
* \note The ellipsoid and projection acronyms must be set as well as the proj4string! * \note The ellipsoid and projection acronyms must be set as well as the proj4string!
* \return long the SrsId of the matched CRS, zero if no match was found * \returns long the SrsId of the matched CRS, zero if no match was found
*/ */
// TODO QGIS 3: seems completely obsolete now (only compares proj4 - already done in createFromProj4) // TODO QGIS 3: seems completely obsolete now (only compares proj4 - already done in createFromProj4)
long findMatchingProj(); long findMatchingProj();
@ -447,14 +447,14 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
/** Restores state from the given DOM node. /** Restores state from the given DOM node.
* \param node The node from which state will be restored * \param node The node from which state will be restored
* \return bool True on success, False on failure * \returns bool True on success, False on failure
*/ */
bool readXml( const QDomNode &node ); bool readXml( const QDomNode &node );
/** Stores state to the given Dom node in the given document. /** Stores state to the given Dom node in the given document.
* \param node The node in which state will be restored * \param node The node in which state will be restored
* \param doc The document in which state will be stored * \param doc The document in which state will be stored
* \return bool True on success, False on failure * \returns bool True on success, False on failure
*/ */
bool writeXml( QDomNode &node, QDomDocument &doc ) const; bool writeXml( QDomNode &node, QDomDocument &doc ) const;
@ -473,12 +473,12 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
// Accessors ----------------------------------- // Accessors -----------------------------------
/** Returns the internal CRS ID, if available. /** Returns the internal CRS ID, if available.
* \return the internal sqlite3 srs.db primary key for this CRS * \returns the internal sqlite3 srs.db primary key for this CRS
*/ */
long srsid() const; long srsid() const;
/** Returns PostGIS SRID for the CRS. /** Returns PostGIS SRID for the CRS.
* \return the PostGIS spatial_ref_sys identifier for this CRS (defaults to 0) * \returns the PostGIS spatial_ref_sys identifier for this CRS (defaults to 0)
*/ */
// TODO QGIS 3: remove unless really necessary - let's use EPSG codes instead // TODO QGIS 3: remove unless really necessary - let's use EPSG codes instead
long postgisSrid() const; long postgisSrid() const;
@ -520,7 +520,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
QString ellipsoidAcronym() const; QString ellipsoidAcronym() const;
/** Returns a WKT representation of this CRS. /** Returns a WKT representation of this CRS.
* \return string containing WKT of the CRS * \returns string containing WKT of the CRS
* @see toProj4() * @see toProj4()
*/ */
QString toWkt() const; QString toWkt() const;
@ -530,7 +530,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* If proj and ellps keys are found in the parameters, * If proj and ellps keys are found in the parameters,
* they will be stripped out and the projection and ellipsoid acronyms will be * they will be stripped out and the projection and ellipsoid acronyms will be
* overridden with these. * overridden with these.
* \return Proj4 format string that defines this CRS. * \returns Proj4 format string that defines this CRS.
* \note an empty string will be returned if the CRS could not be represented by a Proj4 string * \note an empty string will be returned if the CRS could not be represented by a Proj4 string
* @see toWkt() * @see toWkt()
*/ */
@ -596,7 +596,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
/** A static helper function to find out the proj4 string for a srsid /** A static helper function to find out the proj4 string for a srsid
* \param srsId The srsid used for the lookup * \param srsId The srsid used for the lookup
* \return QString The proj4 string * \returns QString The proj4 string
*/ */
static QString proj4FromSrsId( const int srsId ); static QString proj4FromSrsId( const int srsId );
@ -663,12 +663,12 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \note only handles queries that return a single record. * \note only handles queries that return a single record.
* \note it will first try the system srs.db then the users qgis.db! * \note it will first try the system srs.db then the users qgis.db!
* \param sql The sql query to execute * \param sql The sql query to execute
* \return An associative array of field name <-> value pairs * \returns An associative array of field name <-> value pairs
*/ */
RecordMap getRecord( const QString &sql ); RecordMap getRecord( const QString &sql );
//! Open SQLite db and show message if cannot be opened //! Open SQLite db and show message if cannot be opened
//! \return the same code as sqlite3_open //! \returns the same code as sqlite3_open
static int openDatabase( const QString &path, sqlite3 **db, bool readonly = true ); static int openDatabase( const QString &path, sqlite3 **db, bool readonly = true );
//! Work out the projection units and set the appropriate local variable //! Work out the projection units and set the appropriate local variable

View File

@ -116,7 +116,7 @@ class CORE_EXPORT QgsCoordinateTransform
* otherwise points are transformed from destination to source CRS. * otherwise points are transformed from destination to source CRS.
* \param point point to transform * \param point point to transform
* \param direction transform direction (defaults to ForwardTransform) * \param direction transform direction (defaults to ForwardTransform)
* \return transformed point * \returns transformed point
*/ */
QgsPoint transform( const QgsPoint &point, TransformDirection direction = ForwardTransform ) const; QgsPoint transform( const QgsPoint &point, TransformDirection direction = ForwardTransform ) const;
@ -126,7 +126,7 @@ class CORE_EXPORT QgsCoordinateTransform
* \param x x coordinate of point to transform * \param x x coordinate of point to transform
* \param y y coordinate of point to transform * \param y y coordinate of point to transform
* \param direction transform direction (defaults to ForwardTransform) * \param direction transform direction (defaults to ForwardTransform)
* \return transformed point * \returns transformed point
*/ */
QgsPoint transform( const double x, const double y, TransformDirection direction = ForwardTransform ) const; QgsPoint transform( const double x, const double y, TransformDirection direction = ForwardTransform ) const;
@ -140,7 +140,7 @@ class CORE_EXPORT QgsCoordinateTransform
* \param direction transform direction (defaults to ForwardTransform) * \param direction transform direction (defaults to ForwardTransform)
* \param handle180Crossover set to true if destination CRS is geographic and handling of extents * \param handle180Crossover set to true if destination CRS is geographic and handling of extents
* crossing the 180 degree longitude line is required * crossing the 180 degree longitude line is required
* \return rectangle in destination CRS * \returns rectangle in destination CRS
*/ */
QgsRectangle transformBoundingBox( const QgsRectangle &rectangle, TransformDirection direction = ForwardTransform, const bool handle180Crossover = false ) const; QgsRectangle transformBoundingBox( const QgsRectangle &rectangle, TransformDirection direction = ForwardTransform, const bool handle180Crossover = false ) const;
@ -221,7 +221,7 @@ class CORE_EXPORT QgsCoordinateTransform
* otherwise points are transformed from destination to source CRS. * otherwise points are transformed from destination to source CRS.
* \param rectangle rectangle to transform * \param rectangle rectangle to transform
* \param direction transform direction (defaults to ForwardTransform) * \param direction transform direction (defaults to ForwardTransform)
* \return transformed rectangle * \returns transformed rectangle
*/ */
QgsRectangle transform( const QgsRectangle &rectangle, TransformDirection direction = ForwardTransform ) const; QgsRectangle transform( const QgsRectangle &rectangle, TransformDirection direction = ForwardTransform ) const;
@ -247,7 +247,7 @@ class CORE_EXPORT QgsCoordinateTransform
static QString datumTransformString( int datumTransform ); static QString datumTransformString( int datumTransform );
/** Gets name of source and dest geographical CRS (to show in a tooltip) /** Gets name of source and dest geographical CRS (to show in a tooltip)
\return epsgNr epsg code of the transformation (or 0 if not in epsg db)*/ \returns epsgNr epsg code of the transformation (or 0 if not in epsg db)*/
static bool datumTransformCrsInfo( int datumTransform, int &epsgNr, QString &srcProjection, QString &dstProjection, QString &remarks, QString &scope, bool &preferred, bool &deprecated ); static bool datumTransformCrsInfo( int datumTransform, int &epsgNr, QString &srcProjection, QString &dstProjection, QString &remarks, QString &scope, bool &preferred, bool &deprecated );
int sourceDatumTransform() const; int sourceDatumTransform() const;
@ -260,7 +260,7 @@ class CORE_EXPORT QgsCoordinateTransform
/** Restores state from the given Dom node. /** Restores state from the given Dom node.
* \param node The node from which state will be restored * \param node The node from which state will be restored
* \return bool True on success, False on failure * \returns bool True on success, False on failure
* @see writeXml() * @see writeXml()
*/ */
bool readXml( const QDomNode &node ); bool readXml( const QDomNode &node );
@ -268,7 +268,7 @@ class CORE_EXPORT QgsCoordinateTransform
/** Stores state to the given Dom node in the given document /** Stores state to the given Dom node in the given document
* \param node The node in which state will be restored * \param node The node in which state will be restored
* \param document The document in which state will be stored * \param document The document in which state will be stored
* \return bool True on success, False on failure * \returns bool True on success, False on failure
* @see readXml() * @see readXml()
*/ */
bool writeXml( QDomNode &node, QDomDocument &document ) const; bool writeXml( QDomNode &node, QDomDocument &document ) const;

View File

@ -368,7 +368,7 @@ class CORE_EXPORT QgsLayerItem : public QgsDataItem
static QIcon iconRaster(); static QIcon iconRaster();
static QIcon iconDefault(); static QIcon iconDefault();
//! \return the layer name //! \returns the layer name
virtual QString layerName() const { return name(); } virtual QString layerName() const { return name(); }
}; };

View File

@ -100,7 +100,7 @@ class CORE_EXPORT QgsDataProvider : public QObject
* Get the data source specification. This may be a path or database * Get the data source specification. This may be a path or database
* connection string * connection string
* \param expandAuthConfig Whether to expand any assigned authentication configuration * \param expandAuthConfig Whether to expand any assigned authentication configuration
* \return data source specification * \returns data source specification
* \note The default authentication configuration expansion is FALSE. This keeps credentials * \note The default authentication configuration expansion is FALSE. This keeps credentials
* out of layer data source URIs and project files. Expansion should be specifically done * out of layer data source URIs and project files. Expansion should be specifically done
* only when needed within a provider * only when needed within a provider
@ -121,7 +121,7 @@ class CORE_EXPORT QgsDataProvider : public QObject
/** /**
* Returns the extent of the layer * Returns the extent of the layer
* \return QgsRectangle containing the extent of the layer * \returns QgsRectangle containing the extent of the layer
*/ */
virtual QgsRectangle extent() const = 0; virtual QgsRectangle extent() const = 0;
@ -336,7 +336,7 @@ class CORE_EXPORT QgsDataProvider : public QObject
* a concept of stack of calls that must be handled by the provider. Only the first * a concept of stack of calls that must be handled by the provider. Only the first
* call to enterUpdateMode() will really turn update mode on. * call to enterUpdateMode() will really turn update mode on.
* *
* \return true in case of success (or no-op implementation), false in case of failure. * \returns true in case of success (or no-op implementation), false in case of failure.
* *
* \since QGIS 2.16 * \since QGIS 2.16
*/ */
@ -354,7 +354,7 @@ class CORE_EXPORT QgsDataProvider : public QObject
* a concept of stack of calls that must be handled by the provider. Only the last * a concept of stack of calls that must be handled by the provider. Only the last
* call to leaveUpdateMode() will really turn update mode off. * call to leaveUpdateMode() will really turn update mode off.
* *
* \return true in case of success (or no-op implementation), false in case of failure. * \returns true in case of success (or no-op implementation), false in case of failure.
* *
* \since QGIS 2.16 * \since QGIS 2.16
*/ */

View File

@ -299,7 +299,7 @@ class CORE_EXPORT QgsDistanceArea
* *
* \note if course1 is not NULL, bearing (in radians) from first point is calculated * \note if course1 is not NULL, bearing (in radians) from first point is calculated
* (the same for course2) * (the same for course2)
* \return distance in meters * \returns distance in meters
*/ */
double computeDistanceBearing( const QgsPoint &p1, const QgsPoint &p2, double computeDistanceBearing( const QgsPoint &p1, const QgsPoint &p2,
double *course1 = nullptr, double *course2 = nullptr ) const; double *course1 = nullptr, double *course2 = nullptr ) const;

View File

@ -165,7 +165,7 @@ class CORE_EXPORT QgsEditFormConfig
* *
* \param widgetName The name of the widget. * \param widgetName The name of the widget.
* *
* \return The configuration for the editor widget or an empty config if the field does not exist * \returns The configuration for the editor widget or an empty config if the field does not exist
*/ */
QVariantMap widgetConfig( const QString &widgetName ) const; QVariantMap widgetConfig( const QString &widgetName ) const;
@ -174,7 +174,7 @@ class CORE_EXPORT QgsEditFormConfig
* *
* \param widgetName The name of the widget. * \param widgetName The name of the widget.
* *
* \return true if a configuration has been removed * \returns true if a configuration has been removed
*/ */
bool removeWidgetConfig( const QString &widgetName ); bool removeWidgetConfig( const QString &widgetName );

View File

@ -39,17 +39,17 @@ class CORE_EXPORT QgsEditorWidgetSetup
QgsEditorWidgetSetup() {} QgsEditorWidgetSetup() {}
/** /**
* \return the widget type to use * \returns the widget type to use
*/ */
QString type() const { return mType; } QString type() const { return mType; }
/** /**
* \return the widget configuration to used * \returns the widget configuration to used
*/ */
QVariantMap config() const { return mConfig; } QVariantMap config() const { return mConfig; }
/** /**
* \return true if there is no widget configured. * \returns true if there is no widget configured.
*/ */
bool isNull() const { return mType.isEmpty(); } bool isNull() const { return mType.isEmpty(); }

View File

@ -103,18 +103,18 @@ class CORE_EXPORT QgsError
void append( const QgsErrorMessage &message ); void append( const QgsErrorMessage &message );
/** Test if any error is set. /** Test if any error is set.
* \return true if contains error * \returns true if contains error
*/ */
bool isEmpty() const { return mMessageList.isEmpty(); } bool isEmpty() const { return mMessageList.isEmpty(); }
/** Full error messages description /** Full error messages description
* \param format output format * \param format output format
* \return error report * \returns error report
*/ */
QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const; QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const;
/** Short error description, usually the first error in chain, the real error. /** Short error description, usually the first error in chain, the real error.
* \return error description * \returns error description
*/ */
QString summary() const; QString summary() const;

View File

@ -568,7 +568,7 @@ class CORE_EXPORT QgsExpression
/** Returns a list of possible aliases for the function. These include /** Returns a list of possible aliases for the function. These include
* other permissible names for the function, e.g., deprecated names. * other permissible names for the function, e.g., deprecated names.
* \return list of known aliases * \returns list of known aliases
* \since QGIS 2.9 * \since QGIS 2.9
*/ */
virtual QStringList aliases() const { return QStringList(); } virtual QStringList aliases() const { return QStringList(); }
@ -788,7 +788,7 @@ class CORE_EXPORT QgsExpression
static int functionIndex( const QString &name ); static int functionIndex( const QString &name );
/** Returns the number of functions defined in the parser /** Returns the number of functions defined in the parser
* \return The number of function defined in the parser. * \returns The number of function defined in the parser.
*/ */
static int functionCount(); static int functionCount();
@ -846,7 +846,7 @@ class CORE_EXPORT QgsExpression
/** /**
* Abstract virtual that returns the type of this node. * Abstract virtual that returns the type of this node.
* *
* \return The type of this node * \returns The type of this node
*/ */
virtual NodeType nodeType() const = 0; virtual NodeType nodeType() const = 0;
@ -867,7 +867,7 @@ class CORE_EXPORT QgsExpression
/** /**
* Abstract virtual dump method * Abstract virtual dump method
* *
* \return An expression which represents this node as string * \returns An expression which represents this node as string
*/ */
virtual QString dump() const = 0; virtual QString dump() const = 0;
@ -877,7 +877,7 @@ class CORE_EXPORT QgsExpression
* generated in prepare and context related. * generated in prepare and context related.
* Ownership is transferred to the caller. * Ownership is transferred to the caller.
* *
* \return a deep copy of this node. * \returns a deep copy of this node.
*/ */
virtual Node *clone() const = 0; virtual Node *clone() const = 0;
@ -889,7 +889,7 @@ class CORE_EXPORT QgsExpression
* evaluate this node and in addition recursively collect all the columns required * evaluate this node and in addition recursively collect all the columns required
* to evaluate child nodes. * to evaluate child nodes.
* *
* \return A list of columns required to evaluate this expression * \returns A list of columns required to evaluate this expression
*/ */
virtual QSet<QString> referencedColumns() const = 0; virtual QSet<QString> referencedColumns() const = 0;
@ -904,7 +904,7 @@ class CORE_EXPORT QgsExpression
* *
* This needs to call `needsGeometry()` recursively on any child nodes. * This needs to call `needsGeometry()` recursively on any child nodes.
* *
* \return true if a geometry is required to evaluate this expression * \returns true if a geometry is required to evaluate this expression
*/ */
virtual bool needsGeometry() const = 0; virtual bool needsGeometry() const = 0;
}; };

View File

@ -249,7 +249,7 @@ class CORE_EXPORT QgsFeature
* The feature will be valid if it was successful. * The feature will be valid if it was successful.
* \param field the index of the field to set * \param field the index of the field to set
* \param attr the value of the attribute * \param attr the value of the attribute
* \return false, if the field index does not exist * \returns false, if the field index does not exist
* \note For Python: raises a KeyError exception instead of returning false * \note For Python: raises a KeyError exception instead of returning false
* \note Alternatively in Python: @code feature[field] = attr @endcode * \note Alternatively in Python: @code feature[field] = attr @endcode
* @see setAttributes * @see setAttributes
@ -364,7 +364,7 @@ class CORE_EXPORT QgsFeature
* The feature will be valid if it was successful * The feature will be valid if it was successful
* \param name The name of the field to set * \param name The name of the field to set
* \param value The value to set * \param value The value to set
* \return false if attribute name could not be converted to index (C++ only) * \returns false if attribute name could not be converted to index (C++ only)
* \note For Python: raises a KeyError exception instead of returning false * \note For Python: raises a KeyError exception instead of returning false
* \note Alternatively in Python: @code feature[name] = attr @endcode * \note Alternatively in Python: @code feature[name] = attr @endcode
* @see setFields * @see setFields
@ -397,7 +397,7 @@ class CORE_EXPORT QgsFeature
/** Removes an attribute value by field name. Field map must be associated using @link setFields @endlink /** Removes an attribute value by field name. Field map must be associated using @link setFields @endlink
* before this method can be used. * before this method can be used.
* \param name The name of the field to delete * \param name The name of the field to delete
* \return false if attribute name could not be converted to index (C++ only) * \returns false if attribute name could not be converted to index (C++ only)
* \note For Python: raises a KeyError exception instead of returning false * \note For Python: raises a KeyError exception instead of returning false
* \note Alternatively in Python: @code del feature[name] @endcode * \note Alternatively in Python: @code del feature[name] @endcode
* @see setFields * @see setFields
@ -423,7 +423,7 @@ class CORE_EXPORT QgsFeature
/** Lookup attribute value from attribute name. Field map must be associated using @link setFields @endlink /** Lookup attribute value from attribute name. Field map must be associated using @link setFields @endlink
* before this method can be used. * before this method can be used.
* \param name The name of the attribute to get * \param name The name of the attribute to get
* \return The value of the attribute (C++: Invalid variant if no such name exists ) * \returns The value of the attribute (C++: Invalid variant if no such name exists )
* \note For Python: raises a KeyError exception if the field is not found * \note For Python: raises a KeyError exception if the field is not found
* \note Alternatively in Python: @code feature[name] @endcode * \note Alternatively in Python: @code feature[name] @endcode
* @see setFields * @see setFields
@ -450,7 +450,7 @@ class CORE_EXPORT QgsFeature
/** Lookup attribute value from its index. Field map must be associated using @link setFields @endlink /** Lookup attribute value from its index. Field map must be associated using @link setFields @endlink
* before this method can be used. * before this method can be used.
* \param fieldIdx The index of the attribute to get * \param fieldIdx The index of the attribute to get
* \return The value of the attribute (C++: Invalid variant if no such index exists ) * \returns The value of the attribute (C++: Invalid variant if no such index exists )
* \note For Python: raises a KeyError exception if the field is not found * \note For Python: raises a KeyError exception if the field is not found
* \note Alternatively in Python: @code feature[fieldIdx] @endcode * \note Alternatively in Python: @code feature[fieldIdx] @endcode
* @see setFields * @see setFields

View File

@ -52,7 +52,7 @@ class CORE_EXPORT QgsFeatureFilterProvider
virtual void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest ) const = 0; virtual void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest ) const = 0;
/** Create a clone of the feature filter provider /** Create a clone of the feature filter provider
* \return a new clone * \returns a new clone
*/ */
virtual QgsFeatureFilterProvider *clone() const = 0; virtual QgsFeatureFilterProvider *clone() const = 0;
}; };

View File

@ -84,7 +84,7 @@ class CORE_EXPORT QgsAbstractFeatureIterator
* need to implement!! * need to implement!!
* *
* \param f The feature to write to * \param f The feature to write to
* \return true if a feature was written to f * \returns true if a feature was written to f
*/ */
virtual bool fetchFeature( QgsFeature &f ) = 0; virtual bool fetchFeature( QgsFeature &f ) = 0;
@ -96,7 +96,7 @@ class CORE_EXPORT QgsAbstractFeatureIterator
* redirect this call to fetchFeature so the default check will be omitted. * redirect this call to fetchFeature so the default check will be omitted.
* *
* \param f The feature to write to * \param f The feature to write to
* \return true if a feature was written to f * \returns true if a feature was written to f
*/ */
virtual bool nextFeatureFilterExpression( QgsFeature &f ); virtual bool nextFeatureFilterExpression( QgsFeature &f );
@ -109,7 +109,7 @@ class CORE_EXPORT QgsAbstractFeatureIterator
* so the default check will be omitted. * so the default check will be omitted.
* *
* \param f The feature to write to * \param f The feature to write to
* \return true if a feature was written to f * \returns true if a feature was written to f
*/ */
virtual bool nextFeatureFilterFids( QgsFeature &f ); virtual bool nextFeatureFilterFids( QgsFeature &f );

View File

@ -132,13 +132,13 @@ class CORE_EXPORT QgsFeatureRequest
/** /**
* The expression * The expression
* \return the expression * \returns the expression
*/ */
QgsExpression expression() const; QgsExpression expression() const;
/** /**
* Order ascending * Order ascending
* \return If ascending order is requested * \returns If ascending order is requested
*/ */
bool ascending() const; bool ascending() const;
@ -149,7 +149,7 @@ class CORE_EXPORT QgsFeatureRequest
/** /**
* Set if NULLS should be returned first * Set if NULLS should be returned first
* \return if NULLS should be returned first * \returns if NULLS should be returned first
*/ */
bool nullsFirst() const; bool nullsFirst() const;
@ -245,7 +245,7 @@ class CORE_EXPORT QgsFeatureRequest
/** /**
* Return the filter type which is currently set on this request * Return the filter type which is currently set on this request
* *
* \return Filter type * \returns Filter type
*/ */
FilterType filterType() const { return mFilter; } FilterType filterType() const { return mFilter; }
@ -308,7 +308,7 @@ class CORE_EXPORT QgsFeatureRequest
* Disables filter conditions. * Disables filter conditions.
* The spatial filter (filterRect) will be kept in place. * The spatial filter (filterRect) will be kept in place.
* *
* \return The object the method is called on for chaining * \returns The object the method is called on for chaining
* *
* \since QGIS 2.12 * \since QGIS 2.12
*/ */
@ -375,7 +375,7 @@ class CORE_EXPORT QgsFeatureRequest
/** /**
* Return the subset of attributes which at least need to be fetched * Return the subset of attributes which at least need to be fetched
* \return A list of attributes to be fetched * \returns A list of attributes to be fetched
*/ */
QgsAttributeList subsetOfAttributes() const { return mAttrs; } QgsAttributeList subsetOfAttributes() const { return mAttrs; }
@ -397,7 +397,7 @@ class CORE_EXPORT QgsFeatureRequest
* *
* \param feature The feature which will be tested * \param feature The feature which will be tested
* *
* \return true, if the filter accepts the feature * \returns true, if the filter accepts the feature
* *
* \since QGIS 2.1 * \since QGIS 2.1
*/ */
@ -435,7 +435,7 @@ class CORE_EXPORT QgsAbstractFeatureSource
/** /**
* Get an iterator for features matching the specified request * Get an iterator for features matching the specified request
* \param request The request * \param request The request
* \return A feature iterator * \returns A feature iterator
*/ */
virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest &request ) = 0; virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest &request ) = 0;

View File

@ -121,19 +121,19 @@ class CORE_EXPORT QgsField
* Gets the field type. Field types vary depending on the data source. Examples * Gets the field type. Field types vary depending on the data source. Examples
* are char, int, double, blob, geometry, etc. The type is stored exactly as * are char, int, double, blob, geometry, etc. The type is stored exactly as
* the data store reports it, with no attempt to standardize the value. * the data store reports it, with no attempt to standardize the value.
* \return QString containing the field type * \returns QString containing the field type
*/ */
QString typeName() const; QString typeName() const;
/** /**
* Gets the length of the field. * Gets the length of the field.
* \return int containing the length of the field * \returns int containing the length of the field
*/ */
int length() const; int length() const;
/** /**
* Gets the precision of the field. Not all field types have a related precision. * Gets the precision of the field. Not all field types have a related precision.
* \return int containing the precision or zero if not applicable to the field type. * \returns int containing the precision or zero if not applicable to the field type.
*/ */
int precision() const; int precision() const;
@ -244,7 +244,7 @@ class CORE_EXPORT QgsField
* *
* \param v The value to convert * \param v The value to convert
* *
* \return True if the conversion was successful * \returns True if the conversion was successful
*/ */
bool convertCompatible( QVariant &v ) const; bool convertCompatible( QVariant &v ) const;
@ -267,7 +267,7 @@ class CORE_EXPORT QgsField
* Defaults may be set by the provider and can be overridden * Defaults may be set by the provider and can be overridden
* by manual field configuration. * by manual field configuration.
* *
* \return the value * \returns the value
*/ */
QgsEditorWidgetSetup editorWidgetSetup() const; QgsEditorWidgetSetup editorWidgetSetup() const;

View File

@ -55,7 +55,7 @@ class CORE_EXPORT QgsFieldFormatter
/** /**
* Create a pretty String representation of the value. * Create a pretty String representation of the value.
* *
* \return By default the string representation of the provided value as implied by the field definition is returned. * \returns By default the string representation of the provided value as implied by the field definition is returned.
* *
* \since QGIS 3.0 * \since QGIS 3.0
*/ */

View File

@ -104,7 +104,7 @@ class CORE_EXPORT QgsFields
int size() const; int size() const;
//! Return if a field index is valid //! Return if a field index is valid
//! \param i Index of the field which needs to be checked //! \param i Index of the field which needs to be checked
//! \return True if the field exists //! \returns True if the field exists
bool exists( int i ) const; bool exists( int i ) const;
//! Get field at particular index (must be in range 0..N-1) //! Get field at particular index (must be in range 0..N-1)
@ -131,7 +131,7 @@ class CORE_EXPORT QgsFields
* *
* \param fieldName The name of the field. * \param fieldName The name of the field.
* *
* \return The field index if found or -1 in case it cannot be found. * \returns The field index if found or -1 in case it cannot be found.
* @see lookupField For a more tolerant alternative. * @see lookupField For a more tolerant alternative.
*/ */
int indexFromName( const QString &fieldName ) const; int indexFromName( const QString &fieldName ) const;
@ -143,7 +143,7 @@ class CORE_EXPORT QgsFields
* *
* \param fieldName The name of the field. * \param fieldName The name of the field.
* *
* \return The field index if found or -1 in case it cannot be found. * \returns The field index if found or -1 in case it cannot be found.
* @see lookupField For a more tolerant alternative. * @see lookupField For a more tolerant alternative.
* \since QGIS 3.0 * \since QGIS 3.0
*/ */
@ -159,7 +159,7 @@ class CORE_EXPORT QgsFields
* *
* \param fieldName The name to look for. * \param fieldName The name to look for.
* *
* \return The field index if found or -1 in case it cannot be found. * \returns The field index if found or -1 in case it cannot be found.
* @see indexFromName For a more performant and precise but less tolerant alternative. * @see indexFromName For a more performant and precise but less tolerant alternative.
* \since QGIS 2.4 * \since QGIS 2.4
*/ */

View File

@ -185,14 +185,14 @@ class CORE_EXPORT QgsGmlStreamingParser
/** Reads attribute srsName="EpsgCrsId:..." /** Reads attribute srsName="EpsgCrsId:..."
\param epsgNr result \param epsgNr result
\param attr attribute strings \param attr attribute strings
\return 0 in case of success \returns 0 in case of success
*/ */
int readEpsgFromAttribute( int &epsgNr, const XML_Char **attr ); int readEpsgFromAttribute( int &epsgNr, const XML_Char **attr );
/** Reads attribute as string /** Reads attribute as string
\param attributeName \param attributeName
\param attr \param attr
\return attribute value or an empty string if no such attribute \returns attribute value or an empty string if no such attribute
*/ */
QString readAttribute( const QString &attributeName, const XML_Char **attr ) const; QString readAttribute( const QString &attributeName, const XML_Char **attr ) const;
//! Creates a rectangle from a coordinate string. //! Creates a rectangle from a coordinate string.
@ -201,7 +201,7 @@ class CORE_EXPORT QgsGmlStreamingParser
/** Creates a set of points from a coordinate string. /** Creates a set of points from a coordinate string.
\param points list that will contain the created points \param points list that will contain the created points
\param coordString the text containing the coordinates \param coordString the text containing the coordinates
\return 0 in case of success \returns 0 in case of success
*/ */
int pointsFromCoordinateString( QList<QgsPoint> &points, const QString &coordString ) const; int pointsFromCoordinateString( QList<QgsPoint> &points, const QString &coordString ) const;
@ -209,7 +209,7 @@ class CORE_EXPORT QgsGmlStreamingParser
\param points list that will contain the created points \param points list that will contain the created points
\param coordString the text containing the coordinates \param coordString the text containing the coordinates
\param dimension number of dimensions \param dimension number of dimensions
\return 0 in case of success \returns 0 in case of success
*/ */
int pointsFromPosListString( QList<QgsPoint> &points, const QString &coordString, int dimension ) const; int pointsFromPosListString( QList<QgsPoint> &points, const QString &coordString, int dimension ) const;
@ -348,7 +348,7 @@ class CORE_EXPORT QgsGml : public QObject
* \param userName username for authentication * \param userName username for authentication
* \param password password for authentication * \param password password for authentication
* \param authcfg authentication configuration id * \param authcfg authentication configuration id
* \return 0 in case of success * \returns 0 in case of success
* \note available in Python as getFeaturesUri * \note available in Python as getFeaturesUri
*/ */
int getFeatures( const QString &uri, int getFeatures( const QString &uri,

View File

@ -86,7 +86,7 @@ class CORE_EXPORT QgsGmlSchema : public QObject
* Currently only recognizes UMN Mapserver GetFeatureInfo GML response. * Currently only recognizes UMN Mapserver GetFeatureInfo GML response.
* Supports only UTF-8, UTF-16, ISO-8859-1, US-ASCII XML encodings. * Supports only UTF-8, UTF-16, ISO-8859-1, US-ASCII XML encodings.
* \param data GML data * \param data GML data
* \return true in case of success */ * \returns true in case of success */
bool guessSchema( const QByteArray &data ); 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
@ -136,7 +136,7 @@ class CORE_EXPORT QgsGmlSchema : public QObject
//helper routines //helper routines
/** Reads attribute as string /** Reads attribute as string
\return attribute value or an empty string if no such attribute*/ \returns attribute value or an empty string if no such attribute*/
QString readAttribute( const QString &attributeName, const XML_Char **attr ) const; 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
@ -160,7 +160,7 @@ class CORE_EXPORT QgsGmlSchema : public QObject
/** Find GML base type for complex type of given name /** Find GML base type for complex type of given name
* \param element input element * \param element input element
* \param name complex type name * \param name complex type name
* \return name of GML base type without NS, e.g. AbstractFeatureType or empty string if not passed on GML type * \returns name of GML base type without NS, e.g. AbstractFeatureType or empty string if not passed on GML type
*/ */
QString xsdComplexTypeGmlBaseType( const QDomElement &element, const QString &name ); QString xsdComplexTypeGmlBaseType( const QDomElement &element, const QString &name );

Some files were not shown because too many files have changed in this diff Show More