\return -> \returns (for consistency)

qgis · Apr 3, 2017 · e47073b · e47073b
1 parent e4daf8e
commit e47073b
Show file tree

Hide file tree

Showing 270 changed files with 1,083 additions and 1,083 deletions.
diff --git a/src/analysis/interpolation/DualEdgeTriangulation.h b/src/analysis/interpolation/DualEdgeTriangulation.h
@@ -101,7 +101,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
     virtual QList<int> *getPointsAroundEdge( double x, double y ) override;
 
     /** 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;
 
   protected:

diff --git a/src/analysis/interpolation/NormVecDecorator.h b/src/analysis/interpolation/NormVecDecorator.h
@@ -66,7 +66,7 @@ class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator
     virtual bool swapEdge( double x, double y ) override;
 
     /** 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;
 
   protected:

diff --git a/src/analysis/interpolation/Triangulation.h b/src/analysis/interpolation/Triangulation.h
@@ -52,7 +52,7 @@ class ANALYSIS_EXPORT Triangulation
 
     /**
      * 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;
 
@@ -148,7 +148,7 @@ class ANALYSIS_EXPORT Triangulation
 
     /**
      * 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;
 };

diff --git a/src/analysis/interpolation/qgsgridfilewriter.h b/src/analysis/interpolation/qgsgridfilewriter.h
@@ -35,7 +35,7 @@ class ANALYSIS_EXPORT QgsGridFileWriter
 
     /** Writes the grid file.
      \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 );
 

diff --git a/src/analysis/interpolation/qgsidwinterpolator.h b/src/analysis/interpolation/qgsidwinterpolator.h
@@ -33,7 +33,7 @@ class ANALYSIS_EXPORT QgsIDWInterpolator: public QgsInterpolator
        \param x x-coordinate (in map units)
        \param y y-coordinate (in map units)
        \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;
 
     void setDistanceCoefficient( double p ) {mDistanceCoefficient = p;}

diff --git a/src/analysis/interpolation/qgsinterpolator.h b/src/analysis/interpolation/qgsinterpolator.h
@@ -63,7 +63,7 @@ class ANALYSIS_EXPORT QgsInterpolator
        \param x x-coordinate (in map units)
        \param y y-coordinate (in map units)
        \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;
 
     //! \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
      will be held in virtual memory
-    \return 0 in case of success*/
+    \returns 0 in case of success*/
     int cacheBaseData();
 
     QVector<vertexData> mCachedBaseData;
@@ -91,7 +91,7 @@ class ANALYSIS_EXPORT QgsInterpolator
        \param geom the geometry
        \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)
-     \return 0 in case of success*/
+     \returns 0 in case of success*/
     int addVerticesToCache( const QgsGeometry &geom, bool zCoord, double attributeValue );
 };
 

diff --git a/src/analysis/interpolation/qgstininterpolator.h b/src/analysis/interpolation/qgstininterpolator.h
@@ -44,7 +44,7 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
        \param x x-coordinate (in map units)
        \param y y-coordinate (in map units)
        \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;
 
     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 attr interpolation attribute index (if zCoord is false)
       \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 );
 };
 

diff --git a/src/analysis/network/qgsgraph.h b/src/analysis/network/qgsgraph.h
@@ -167,7 +167,7 @@ class ANALYSIS_EXPORT QgsGraph
 
     /**
      * Find vertex by associated point
-     * \return vertex index
+     * \returns vertex index
      */
     int findVertex( const QgsPoint &pt ) const;
 

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

diff --git a/src/analysis/openstreetmap/qgsosmdownload.h b/src/analysis/openstreetmap/qgsosmdownload.h
@@ -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.
      *
-     * \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();
 
     /**
      * @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();
 

diff --git a/src/analysis/openstreetmap/qgsosmimport.h b/src/analysis/openstreetmap/qgsosmimport.h
@@ -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.
-     * \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();
 

diff --git a/src/analysis/raster/qgsalignraster.h b/src/analysis/raster/qgsalignraster.h
@@ -145,7 +145,7 @@ class ANALYSIS_EXPORT QgsAlignRaster
     {
       //! Method to be overridden for progress reporting.
       //! \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 ~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
     //! 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 ) );
     //! Overridden variant for convenience, taking filename instead RasterInfo object.
     //! See the other variant for details.
     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
-    //! \return true on success, sets error on error (see errorMessage())
+    //! \returns true on success, sets error on error (see errorMessage())
     bool checkInputParameters();
 
     //! Return expected size of the resulting aligned raster
@@ -212,7 +212,7 @@ class ANALYSIS_EXPORT QgsAlignRaster
     QgsRectangle alignedRasterExtent() const;
 
     //! 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();
 
     //! Return error from a previous run() call.

diff --git a/src/analysis/raster/qgsninecellfilter.h b/src/analysis/raster/qgsninecellfilter.h
@@ -38,7 +38,7 @@ class ANALYSIS_EXPORT QgsNineCellFilter
 
     /** 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.
-      \return 0 in case of success*/
+      \returns 0 in case of success*/
     int processRaster( QProgressDialog *p );
 
     double cellSizeX() const { return mCellSizeX; }
@@ -68,11 +68,11 @@ class ANALYSIS_EXPORT QgsNineCellFilter
     GDALDatasetH openInputFile( int &nCellsX, int &nCellsY );
 
     /** Opens the output driver and tests if it supports the creation of a new dataset
-      \return nullptr on error and the driver handle on success*/
+      \returns nullptr on error and the driver handle on success*/
     GDALDriverH openOutputDriver();
 
     /** 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 );
 
   protected:

diff --git a/src/analysis/raster/qgsrastercalculator.h b/src/analysis/raster/qgsrastercalculator.h
@@ -81,7 +81,7 @@ class ANALYSIS_EXPORT QgsRasterCalculator
 
     /** Starts the calculation and writes new raster
       \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
     int processCalculation( QProgressDialog *p = nullptr );
 
@@ -90,11 +90,11 @@ class ANALYSIS_EXPORT QgsRasterCalculator
     QgsRasterCalculator();
 
     /** 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();
 
     /** 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 );
 
     /** Sets gdal 6 parameters array from mOutputRectangle, mNumOutputColumns, mNumOutputRows

diff --git a/src/analysis/raster/qgsrelief.h b/src/analysis/raster/qgsrelief.h
@@ -53,7 +53,7 @@ class ANALYSIS_EXPORT QgsRelief
 
     /** 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.
-      \return 0 in case of success*/
+      \returns 0 in case of success*/
     int processRaster( QProgressDialog *p );
 
     double zFactor() const { return mZFactor; }
@@ -65,7 +65,7 @@ class ANALYSIS_EXPORT QgsRelief
     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
-      \return true in case of success*/
+      \returns true in case of success*/
     QList< ReliefColor > calculateOptimizedReliefClasses();
 
     //! Write frequency of elevation values to file for manual inspection
@@ -102,11 +102,11 @@ class ANALYSIS_EXPORT QgsRelief
     GDALDatasetH openInputFile( int &nCellsX, int &nCellsY );
 
     /** Opens the output driver and tests if it supports the creation of a new dataset
-      \return nullptr on error and the driver handle on success*/
+      \returns nullptr on error and the driver handle on success*/
     GDALDriverH openOutputDriver();
 
     /** 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 );
 
     //! Set elevation color
@@ -116,7 +116,7 @@ class ANALYSIS_EXPORT QgsRelief
     void setDefaultReliefColors();
 
     /** 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 );
     //! Do one iteration of class break optimisation (algorithm from Garcia and Rodriguez)
     void optimiseClassBreaks( QList<int> &breaks, double *frequencies );

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

diff --git a/src/analysis/vector/qgstransectsample.h b/src/analysis/vector/qgstransectsample.h
@@ -82,7 +82,7 @@ class ANALYSIS_EXPORT QgsTransectSample
         \param dist out: distance between the segments
         \param pt1 out: closest point on first 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 );
     //! Returns a copy of the multiline element closest to a point (caller takes ownership)
     static QgsGeometry closestMultilineElement( const QgsPoint &pt, const QgsGeometry &multiLine );
@@ -91,7 +91,7 @@ class ANALYSIS_EXPORT QgsTransectSample
         \param stratumGeom stratum polygon
         \param clippedBaseline base line geometry clipped to the stratum
         \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 );
 
     //! Returns distance to buffer the baseline (takes care of units and buffer settings

diff --git a/src/analysis/vector/qgszonalstatistics.h b/src/analysis/vector/qgszonalstatistics.h
@@ -63,7 +63,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics
                         Statistics stats = Statistics( Count | Sum | Mean ) );
 
     /** Starts the calculation
-      \return 0 in case of success*/
+      \returns 0 in case of success*/
     int calculateStatistics( QProgressDialog *p );
 
   private:
@@ -111,7 +111,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics
     };
 
     /** 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 &offsetX, int &offsetY, int &nCellsX, int &nCellsY ) const;
 

diff --git a/src/app/dwg/libdxfrw/libdxfrw.h b/src/app/dwg/libdxfrw/libdxfrw.h
@@ -35,7 +35,7 @@ class dxfRW
      * components being added.
      * \param interface_ the interface to use
      * \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 );
     void setBinary( bool b ) {binFile = b;}

diff --git a/src/app/gps/qwtpolar-0.1/qwt_polar_curve.h b/src/app/gps/qwtpolar-0.1/qwt_polar_curve.h
@@ -117,21 +117,21 @@ class QWT_POLAR_EXPORT QwtPolarCurve: public QwtPolarItem
     PrivateData *d_data;
 };
 
-//! \return the curve data
+//! \returns the curve data
 inline QwtData &QwtPolarCurve::data()
 {
   return *d_points;
 }
 
-//! \return the curve data
+//! \returns the curve data
 inline const QwtData &QwtPolarCurve::data() const
 {
   return *d_points;
 }
 
 /*!
     \param i index
-    \return azimuth at position i
+    \returns azimuth at position i
 */
 inline double QwtPolarCurve::azimuth( int i ) const
 {
@@ -140,7 +140,7 @@ inline double QwtPolarCurve::azimuth( int i ) const
 
 /*!
     \param i index
-    \return radius at position i
+    \returns radius at position i
 */
 inline double QwtPolarCurve::radius( int i ) const
 {
@@ -149,7 +149,7 @@ inline double QwtPolarCurve::radius( int i ) const
 
 /*!
     \param i index
-    \return point at position i
+    \returns point at position i
 */
 inline QwtPolarPoint QwtPolarCurve::sample( int i ) const
 {

diff --git a/src/app/gps/qwtpolar-1.0/qwt_polar_curve.h b/src/app/gps/qwtpolar-1.0/qwt_polar_curve.h
@@ -143,15 +143,15 @@ class QWT_POLAR_EXPORT QwtPolarCurve: public QwtPolarItem
     PrivateData *d_data;
 };
 
-//! \return the curve data
+//! \returns the curve data
 inline const QwtSeriesData<QwtPointPolar> *QwtPolarCurve::data() const
 {
     return d_series;
 }
 
 /*!
     \param i index
-    \return point at position i
+    \returns point at position i
 */
 inline QwtPointPolar QwtPolarCurve::sample( int i ) const
 {

diff --git a/src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h b/src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h
@@ -141,15 +141,15 @@ class QWT_POLAR_EXPORT QwtPolarCurve: public QwtPolarItem
     PrivateData *d_data;
 };
 
-//! \return the the curve data
+//! \returns the the curve data
 inline const QwtSeriesData<QwtPointPolar> *QwtPolarCurve::data() const
 {
     return d_series;
 }
 
 /*!
     \param i index
-    \return point at position i
+    \returns point at position i
 */
 inline QwtPointPolar QwtPolarCurve::sample( int i ) const
 {