@param -> \param

qgis · Apr 3, 2017 · 11dcfd9 · 11dcfd9
1 parent 9a4f2e4
commit 11dcfd9
Show file tree

Hide file tree

Showing 533 changed files with 5,633 additions and 5,633 deletions.
diff --git a/src/analysis/interpolation/qgsgridfilewriter.h b/src/analysis/interpolation/qgsgridfilewriter.h
@@ -34,7 +34,7 @@ class ANALYSIS_EXPORT QgsGridFileWriter
     QgsGridFileWriter( QgsInterpolator *i, const QString &outputPath, const QgsRectangle &extent, int nCols, int nRows, double cellSizeX, double cellSizeY );
 
     /** 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*/
 
     int writeFile( bool showProgressDialog = false );

diff --git a/src/analysis/interpolation/qgsidwinterpolator.h b/src/analysis/interpolation/qgsidwinterpolator.h
@@ -30,9 +30,9 @@ class ANALYSIS_EXPORT QgsIDWInterpolator: public QgsInterpolator
     QgsIDWInterpolator( const QList<LayerData> &layerData );
 
     /** Calculates interpolation value for map coordinates x, y
-       @param x x-coordinate (in map units)
-       @param y y-coordinate (in map units)
-       @param result out: interpolation result
+       \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*/
     int interpolatePoint( double x, double y, double &result ) override;
 

diff --git a/src/analysis/interpolation/qgsinterpolator.h b/src/analysis/interpolation/qgsinterpolator.h
@@ -60,9 +60,9 @@ class ANALYSIS_EXPORT QgsInterpolator
     virtual ~QgsInterpolator() = default;
 
     /** Calculates interpolation value for map coordinates x, y
-       @param x x-coordinate (in map units)
-       @param y y-coordinate (in map units)
-       @param result out: interpolation result
+       \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*/
     virtual int interpolatePoint( double x, double y, double &result ) = 0;
 
@@ -88,9 +88,9 @@ class ANALYSIS_EXPORT QgsInterpolator
     QgsInterpolator(); //forbidden
 
     /** Helper method that adds the vertices of a geometry to the mCachedBaseData
-       @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)
+       \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*/
     int addVerticesToCache( const QgsGeometry &geom, bool zCoord, double attributeValue );
 };

diff --git a/src/analysis/interpolation/qgstininterpolator.h b/src/analysis/interpolation/qgstininterpolator.h
@@ -41,9 +41,9 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
     ~QgsTINInterpolator();
 
     /** Calculates interpolation value for map coordinates x, y
-       @param x x-coordinate (in map units)
-       @param y y-coordinate (in map units)
-       @param result out: interpolation result
+       \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*/
     int interpolatePoint( double x, double y, double &result ) override;
 
@@ -66,10 +66,10 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
     void initialize();
 
     /** Inserts the vertices of a feature into the triangulation
-      @param f the feature
-      @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
+      \param f the feature
+      \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*/
     int insertData( QgsFeature *f, bool zCoord, int attr, InputType type );
 };

diff --git a/src/analysis/network/qgsgraph.h b/src/analysis/network/qgsgraph.h
@@ -47,7 +47,7 @@ class ANALYSIS_EXPORT QgsGraphEdge
 
     /**
      * Returns edge cost calculated using specified strategy
-     * @param strategyIndex strategy index
+     * \param strategyIndex strategy index
      */
     QVariant cost( int strategyIndex ) const;
 

diff --git a/src/analysis/network/qgsgraphanalyzer.h b/src/analysis/network/qgsgraphanalyzer.h
@@ -32,19 +32,19 @@ class ANALYSIS_EXPORT QgsGraphAnalyzer
 
     /**
      * Solve shortest path problem using Dijkstra algorithm
-     * @param source source graph
-     * @param startVertexIdx index of the start vertex
-     * @param criterionNum index of the optimization strategy
-     * @param resultTree array that represents shortest path tree. resultTree[ vertexIndex ] == inboundingArcIndex if vertex reachable, otherwise resultTree[ vertexIndex ] == -1
-     * @param resultCost array of the paths costs
+     * \param source source graph
+     * \param startVertexIdx index of the start vertex
+     * \param criterionNum index of the optimization strategy
+     * \param resultTree array that represents shortest path tree. resultTree[ vertexIndex ] == inboundingArcIndex if vertex reachable, otherwise resultTree[ vertexIndex ] == -1
+     * \param resultCost array of the paths costs
      */
     static void dijkstra( const QgsGraph *source, int startVertexIdx, int criterionNum, QVector<int> *resultTree = nullptr, QVector<double> *resultCost = nullptr );
 
     /**
      * Returns shortest path tree with root-node in startVertexIdx
-     * @param source source graph
-     * @param startVertexIdx index of the start vertex
-     * @param criterionNum index of the optimization strategy
+     * \param source source graph
+     * \param startVertexIdx index of the start vertex
+     * \param criterionNum index of the optimization strategy
      */
     static QgsGraph *shortestTree( const QgsGraph *source, int startVertexIdx, int criterionNum );
 };

diff --git a/src/analysis/network/qgsgraphbuilderinterface.h b/src/analysis/network/qgsgraphbuilderinterface.h
@@ -36,10 +36,10 @@ class ANALYSIS_EXPORT QgsGraphBuilderInterface
 
     /**
      * Default constructor
-     * @param crs Coordinate reference system for new graph vertex
-     * @param ctfEnabled enable coordinate transform from source graph CRS to CRS graph
-     * @param topologyTolerance sqrt distance between source point as one graph vertex
-     * @param ellipsoidID ellipsoid for edge measurement
+     * \param crs Coordinate reference system for new graph vertex
+     * \param ctfEnabled enable coordinate transform from source graph CRS to CRS graph
+     * \param topologyTolerance sqrt distance between source point as one graph vertex
+     * \param ellipsoidID ellipsoid for edge measurement
      */
     QgsGraphBuilderInterface( const QgsCoordinateReferenceSystem &crs, bool ctfEnabled = true, double topologyTolerance = 0.0, const QString &ellipsoidID = "WGS84" )
       : mCrs( crs )
@@ -80,8 +80,8 @@ class ANALYSIS_EXPORT QgsGraphBuilderInterface
 
     /**
      * Add vertex to the graph
-     * @param id vertex identifier
-     * @param pt vertex coordinates
+     * \param id vertex identifier
+     * \param pt vertex coordinates
      * \note id and pt are redundant. You can use pt or id to identify the vertex
      */
     virtual void addVertex( int id, const QgsPoint &pt )
@@ -92,11 +92,11 @@ class ANALYSIS_EXPORT QgsGraphBuilderInterface
 
     /**
      * Add edge to the graph
-     * @param pt1id first vertex identificator
-     * @param pt1   first vertex coordinates
-     * @param pt2id second vertex identificator
-     * @param pt2   second vertex coordinates
-     * @param strategies optimization strategies
+     * \param pt1id first vertex identificator
+     * \param pt1   first vertex coordinates
+     * \param pt2id second vertex identificator
+     * \param pt2   second vertex coordinates
+     * \param strategies optimization strategies
      * \note pt1id, pt1 and pt2id, pt2 is a redundant interface. You can use vertex coordinates or their identificators.
      */
     virtual void addEdge( int pt1id, const QgsPoint &pt1, int pt2id, const QgsPoint &pt2, const QVector< QVariant > &strategies )

diff --git a/src/analysis/network/qgsgraphdirector.h b/src/analysis/network/qgsgraphdirector.h
@@ -47,9 +47,9 @@ class ANALYSIS_EXPORT QgsGraphDirector : public QObject
     /**
      * Make a graph using QgsGraphBuilder
      *
-     * @param builder the graph builder
-     * @param additionalPoints list of points that should be snapped to the graph
-     * @param snappedPoints list of snapped points
+     * \param builder the graph builder
+     * \param additionalPoints list of points that should be snapped to the graph
+     * \param snappedPoints list of snapped points
      * \note if snappedPoints[i] == QgsPoint(0.0,0.0) then snapping failed.
      */
     virtual void makeGraph( QgsGraphBuilderInterface *builder,

diff --git a/src/analysis/network/qgsvectorlayerdirector.h b/src/analysis/network/qgsvectorlayerdirector.h
@@ -49,12 +49,12 @@ class ANALYSIS_EXPORT QgsVectorLayerDirector : public QgsGraphDirector
 
     /**
      * Default constructor
-     * @param myLayer source vector layer
-     * @param directionFieldId field containing direction value
-     * @param directDirectionValue value for direct one-way road
-     * @param reverseDirectionValue value for reversed one-way road
-     * @param bothDirectionValue value for two-way (bidirectional) road
-     * @param defaultDirection default direction. Will be used if corresponding
+     * \param myLayer source vector layer
+     * \param directionFieldId field containing direction value
+     * \param directDirectionValue value for direct one-way road
+     * \param reverseDirectionValue value for reversed one-way road
+     * \param bothDirectionValue value for two-way (bidirectional) road
+     * \param defaultDirection default direction. Will be used if corresponding
      * attribute value is not set or does not equal to the given values
      */
     QgsVectorLayerDirector( QgsVectorLayer *myLayer,

diff --git a/src/analysis/raster/qgsalignraster.h b/src/analysis/raster/qgsalignraster.h
@@ -144,7 +144,7 @@ class ANALYSIS_EXPORT QgsAlignRaster
     struct ProgressHandler
     {
       //! 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
       virtual bool progress( double complete ) = 0;
 

diff --git a/src/analysis/raster/qgsninecellfilter.h b/src/analysis/raster/qgsninecellfilter.h
@@ -37,7 +37,7 @@ class ANALYSIS_EXPORT QgsNineCellFilter
     virtual ~QgsNineCellFilter() = default;
 
     /** 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*/
     int processRaster( QProgressDialog *p );
 

diff --git a/src/analysis/raster/qgsrastercalcnode.h b/src/analysis/raster/qgsrastercalcnode.h
@@ -89,9 +89,9 @@ class ANALYSIS_EXPORT QgsRasterCalcNode
     void setRight( QgsRasterCalcNode *right ) { delete mRight; mRight = right; }
 
     /** Calculates result of raster calculation (might be real matrix or single number).
-     * @param rasterData input raster data references, map of raster name to raster data block
-     * @param result destination raster matrix for calculation results
-     * @param row optional row number to calculate for calculating result by rows, or -1 to
+     * \param rasterData input raster data references, map of raster name to raster data block
+     * \param result destination raster matrix for calculation results
+     * \param row optional row number to calculate for calculating result by rows, or -1 to
      * calculate entire result
      * \since QGIS 2.10
      * \note not available in Python bindings

diff --git a/src/analysis/raster/qgsrastercalculator.h b/src/analysis/raster/qgsrastercalculator.h
@@ -54,33 +54,33 @@ class ANALYSIS_EXPORT QgsRasterCalculator
     };
 
     /** QgsRasterCalculator constructor.
-     * @param formulaString formula for raster calculation
-     * @param outputFile output file path
-     * @param outputFormat output file format
-     * @param outputExtent output extent. CRS for output is taken from first entry in rasterEntries.
-     * @param nOutputColumns number of columns in output raster
-     * @param nOutputRows number of rows in output raster
-     * @param rasterEntries list of referenced raster layers
+     * \param formulaString formula for raster calculation
+     * \param outputFile output file path
+     * \param outputFormat output file format
+     * \param outputExtent output extent. CRS for output is taken from first entry in rasterEntries.
+     * \param nOutputColumns number of columns in output raster
+     * \param nOutputRows number of rows in output raster
+     * \param rasterEntries list of referenced raster layers
      */
     QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat,
                          const QgsRectangle &outputExtent, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries );
 
     /** QgsRasterCalculator constructor.
-     * @param formulaString formula for raster calculation
-     * @param outputFile output file path
-     * @param outputFormat output file format
-     * @param outputExtent output extent, CRS is specified by outputCrs parameter
-     * @param outputCrs destination CRS for output raster
-     * @param nOutputColumns number of columns in output raster
-     * @param nOutputRows number of rows in output raster
-     * @param rasterEntries list of referenced raster layers
+     * \param formulaString formula for raster calculation
+     * \param outputFile output file path
+     * \param outputFormat output file format
+     * \param outputExtent output extent, CRS is specified by outputCrs parameter
+     * \param outputCrs destination CRS for output raster
+     * \param nOutputColumns number of columns in output raster
+     * \param nOutputRows number of rows in output raster
+     * \param rasterEntries list of referenced raster layers
      * \since QGIS 2.10
      */
     QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat,
                          const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &outputCrs, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries );
 
     /** 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*/
     //TODO QGIS 3.0 - return QgsRasterCalculator::Result
     int processCalculation( QProgressDialog *p = nullptr );
@@ -98,7 +98,7 @@ class ANALYSIS_EXPORT QgsRasterCalculator
     GDALDatasetH openOutputFile( GDALDriverH outputDriver );
 
     /** Sets gdal 6 parameters array from mOutputRectangle, mNumOutputColumns, mNumOutputRows
-      @param transform double[6] array that receives the GDAL parameters*/
+      \param transform double[6] array that receives the GDAL parameters*/
     void outputGeoTransform( double *transform ) const;
 
     QString mFormulaString;

diff --git a/src/analysis/raster/qgsrelief.h b/src/analysis/raster/qgsrelief.h
@@ -52,7 +52,7 @@ class ANALYSIS_EXPORT QgsRelief
     QgsRelief &operator=( const QgsRelief &rh ) = delete;
 
     /** 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*/
     int processRaster( QProgressDialog *p );
 
@@ -122,9 +122,9 @@ class ANALYSIS_EXPORT QgsRelief
     void optimiseClassBreaks( QList<int> &breaks, double *frequencies );
 
     /** Calculates coefficients a and b
-      @param input data points ( elevation class / frequency )
-      @param a slope
-      @param b y value for x=0
+      \param input data points ( elevation class / frequency )
+      \param a slope
+      \param b y value for x=0
      */
     bool calculateRegression( const QList< QPair < int, double > > &input, double &a, double &b );