Skip to content
Permalink
Browse files
@return(s) -> \return(s)
  • Loading branch information
nyalldawson committed Apr 3, 2017
1 parent 11dcfd9 commit e4daf8ea62a267fc6721902fe063dd8d43339495
Showing 365 changed files with 1,884 additions and 1,884 deletions.
@@ -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*/
\return true in case of success*/
virtual bool saveAsShapefile( const QString &fileName ) const override;

protected:
@@ -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*/
\return true in case of success*/
virtual bool saveAsShapefile( const QString &fileName ) const override;

protected:
@@ -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
* \return 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
* \return true in case of success
*/
virtual bool saveAsShapefile( const QString &fileName ) const = 0;
};
@@ -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*/
\return 0 in case of success*/

int writeFile( bool showProgressDialog = false );

@@ -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*/
\return 0 in case of success*/
int interpolatePoint( double x, double y, double &result ) override;

void setDistanceCoefficient( double p ) {mDistanceCoefficient = p;}
@@ -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*/
\return 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*/
\return 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*/
\return 0 in case of success*/
int addVerticesToCache( const QgsGeometry &geom, bool zCoord, double attributeValue );
};

@@ -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*/
\return 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*/
\return 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 );
};

@@ -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)
* \return 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
* \return true if there is a pending request and has been aborted, false otherwise
*/
bool abort();

@@ -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)
* \return true on success, false when import failed (see errorString() for the error)
*/
bool import();

@@ -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
//! \return 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)
//! \return 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())
//! \return 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())
//! \return true on success, sets error on error (see errorMessage())
bool run();

//! Return error from a previous run() call.
@@ -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*/
\return 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*/
\return 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*/
\return the output dataset or nullptr in case of error*/
GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver );

protected:
@@ -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*/
\return 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*/
\return 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*/
\return the output dataset or nullptr in case of error*/
GDALDatasetH openOutputFile( GDALDriverH outputDriver );

/** Sets gdal 6 parameters array from mOutputRectangle, mNumOutputColumns, mNumOutputRows
@@ -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*/
\return 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*/
\return 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*/
\return 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*/
\return 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*/
\return elevation class or -1 in case of error*/
int frequencyClassForElevation( double elevation, double minElevation, double elevationClassRange );
//! Do one iteration of class break optimisation (algorithm from Garcia and Rodriguez)
void optimiseClassBreaks( QList<int> &breaks, double *frequencies );
@@ -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*/
\return 0 in case of success*/
int createRandomPoints( QProgressDialog *pd );

private:
@@ -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*/
\return true in case of success*/
static bool closestSegmentPoints( const QgsGeometry &g1, const QgsGeometry &g2, double &dist, QgsPoint &pt1, QgsPoint &pt2 );
//! Returns a copy of the multiline element closest to a point (caller takes ownership)
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*/
\return clipped buffer line or 0 in case of error*/
QgsGeometry *clipBufferLine( const QgsGeometry &stratumGeom, QgsGeometry *clippedBaseline, double tolerance );

//! Returns distance to buffer the baseline (takes care of units and buffer settings
@@ -63,7 +63,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics
Statistics stats = Statistics( Count | Sum | Mean ) );

/** Starts the calculation
@return 0 in case of success*/
\return 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*/
\return 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;

@@ -125,7 +125,7 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
/** Loads the contents of a template document into the composer's composition.
* \param templateDoc template document to load
* \param clearExisting set to true to remove all existing composition settings and items before loading template
* @returns true if template load was successful
* \returns true if template load was successful
*/
bool loadFromTemplate( const QDomDocument &templateDoc, bool clearExisting );

@@ -46,7 +46,7 @@ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsCompos
void setResolution( int resolution );

/** Returns the selected resolution from the dialog.
* @returns image resolution in DPI
* \returns image resolution in DPI
* @see setResolution()
*/
int resolution() const;
@@ -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
* \return true for success
*/
bool read( DRW_Interface *interface_, bool ext );
void setBinary( bool b ) {binFile = b;}
@@ -101,7 +101,7 @@ class QgsMapToolNodeTool: public QgsMapToolEdit
* Function to check if selected feature exists and is same with original one
* stored in internal structures
* \param vlayer vector layer for checking
* @return if feature is same as one in internal structures
* \return if feature is same as one in internal structures
*/
bool checkCorrectnessOfFeature( QgsVectorLayer *vlayer );

@@ -124,15 +124,15 @@ class QgsMapToolNodeTool: public QgsMapToolEdit
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
\param snapResults results collected from the snapping operation.
@return the snapped point in map coordinates*/
\return the snapped point in map coordinates*/
QgsPoint snapPointFromResults( const QList<QgsSnappingResult> &snapResults, QPoint screenCoords );

/** Inserts vertices to the snapped segments of the editing layer.
This is useful for topological editing if snap to segment is enabled.
\param snapResults results collected from the snapping operation
\param editedLayer pointer to the editing layer
\param skipFids set of feature IDs to avoid inserting vertices in
@return 0 in case of success*/
\return 0 in case of success*/
int insertSegmentVerticesForSnap( const QList<QgsSnappingResult> &snapResults, QgsVectorLayer *editedLayer, const QgsFeatureIds &skipFids );

/** Snapper object that reads the settings from project and option
@@ -97,19 +97,19 @@ class QgsSelectedFeature: public QObject
/**
* Tells if vertex is selected
* \param vertexNr number of vertex for which we are getting info
* @return true if vertex is selected, false otherwise
* \return true if vertex is selected, false otherwise
*/
bool isSelected( int vertexNr );

/**
* Getting feature Id of feature selected
* @return feature id of selected feature
* \return feature id of selected feature
*/
QgsFeatureId featureId();

/**
* Getting vertex map of vertexes
* @return currently used vertex map
* \return currently used vertex map
*/
QList<QgsVertexEntry *> &vertexMap();

@@ -120,7 +120,7 @@ class QgsSelectedFeature: public QObject

/**
* Get the layer of the selected feature
* @return used vector layer
* \return used vector layer
*/
QgsVectorLayer *vlayer();

Loading

0 comments on commit e4daf8e

Please sign in to comment.