sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-17 00:04:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

put \since and \deprecated at the end of comment blocks

Browse Source
This commit is contained in:
Denis Rouzaud 2018-05-28 11:30:38 -04:00
parent 6772f0d74e
commit 0fa85bba1c
186 changed files with 588 additions and 582 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/3d/processing/qgs3dalgorithms.h
View File

@ -25,8 +25,8 @@
/**
* \ingroup analysis
* \class Qgs3DAlgorithms
* \since QGIS 3.0
* \brief QGIS 3D processing algorithm provider.
* \since QGIS 3.0
*/
class _3D_EXPORT Qgs3DAlgorithms: public QgsProcessingProvider
{

4
src/3d/qgs3dmapsettings.h
View File

@ -110,8 +110,8 @@ class _3D_EXPORT Qgs3DMapSettings : public QObject
* Returns the path resolver for conversion between relative and absolute paths
* during rendering operations, e.g. for resolving relative symbol paths.
*
* \since QGIS 3.0
* \see setPathResolver()
* \since QGIS 3.0
*/
const QgsPathResolver &pathResolver() const { return mPathResolver; }
@ -119,8 +119,8 @@ class _3D_EXPORT Qgs3DMapSettings : public QObject
* Sets the path \a resolver for conversion between relative and absolute paths
* during rendering operations, e.g. for resolving relative symbol paths.
*
* \since QGIS 3.0
* \see pathResolver()
* \since QGIS 3.0
*/
void setPathResolver( const QgsPathResolver &resolver ) { mPathResolver = resolver; }

2
src/analysis/raster/qgsrastercalcnode.h
View File

@ -101,8 +101,8 @@ class ANALYSIS_EXPORT QgsRasterCalcNode
* \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
* \since QGIS 2.10
*/
bool calculate( QMap<QString, QgsRasterBlock * > &rasterData, QgsRasterMatrix &result, int row = -1 ) const SIP_SKIP;

6
src/app/qgisapp.h
View File

@ -1687,25 +1687,25 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
/**
* This signal is emitted when a new layout \a designer has been opened.
* \since QGIS 3.0
* \see layoutDesignerWillBeClosed()
* \since QGIS 3.0
*/
void layoutDesignerOpened( QgsLayoutDesignerInterface *designer );
/**
* This signal is emitted before a layout \a designer is going to be closed
* and deleted.
* \since QGIS 3.0
* \see layoutDesignerClosed()
* \see layoutDesignerOpened()
* \since QGIS 3.0
*/
void layoutDesignerWillBeClosed( QgsLayoutDesignerInterface *designer );
/**
* This signal is emitted after a layout designer window is closed.
* \since QGIS 3.0
* \see layoutDesignerWillBeClosed()
* \see layoutDesignerOpened()
* \since QGIS 3.0
*/
void layoutDesignerClosed();

5
src/app/qgisappinterface.h
View File

@ -328,16 +328,17 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
/**
* Register a new custom drop \a handler.
* \since QGIS 3.0
* \note Ownership of the factory is not transferred, and the factory must
* be unregistered when plugin is unloaded.
* \see unregisterCustomDropHandler() */
* \since QGIS 3.0
void registerCustomDropHandler( QgsCustomDropHandler *handler ) override;
/**
* Unregister a previously registered custom drop \a handler.
* \see registerCustomDropHandler()
* \since QGIS 3.0
* \see registerCustomDropHandler() */
*/
void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) override;
void registerCustomLayoutDropHandler( QgsLayoutCustomDropHandler *handler ) override;

4
src/app/qgsattributetypedialog.h
View File

@ -136,15 +136,15 @@ class APP_EXPORT QgsAttributeTypeDialog: public QWidget, private Ui::QgsAttribut
/**
* Setter for constraint expression description
* \param desc the expression description
* \since QGIS 2.16
**/
* \since QGIS 2.16
void setConstraintExpressionDescription( const QString &desc );
/**
* Getter for constraint expression description
* \returns the expression description
* \since QGIS 2.16
**/
* \since QGIS 2.16
QString constraintExpressionDescription();
/**

4
src/core/3d/qgs3drendererregistry.h
View File

@ -28,8 +28,8 @@ class QgsReadWriteContext;
/**
* Base metadata class for 3D renderers. Instances of derived classes may be registered in Qgs3DRendererRegistry.
* \since QGIS 3.0
* \ingroup core
* \since QGIS 3.0
*/
class CORE_EXPORT Qgs3DRendererAbstractMetadata
{
@ -63,8 +63,8 @@ class CORE_EXPORT Qgs3DRendererAbstractMetadata
/**
* Keeps track of available 3D renderers. Should be accessed through QgsApplication::renderer3DRegistry() singleton.
* \since QGIS 3.0
* \ingroup core
* \since QGIS 3.0
*/
class CORE_EXPORT Qgs3DRendererRegistry
{

2
src/core/auth/qgsauthcrypto.h
View File

@ -27,8 +27,8 @@
/**
* \ingroup core
* Functions for hashing/checking master password and encrypt/decrypting data with password
* \since 2.8
* \note not available in Python bindings
* \since 2.8
*/
class CORE_EXPORT QgsAuthCrypto
{

8
src/core/dxf/qgsdxfexport.h
View File

@ -106,15 +106,15 @@ class CORE_EXPORT QgsDxfExport
/**
* Sets the export flags.
* \since QGIS 3.0
* \see flags()
* \since QGIS 3.0
*/
void setFlags( QgsDxfExport::Flags flags );
/**
* Returns the export flags.
* \since QGIS 3.0
* \see setFlags()
* \since QGIS 3.0
*/
QgsDxfExport::Flags flags() const;
@ -136,16 +136,16 @@ class CORE_EXPORT QgsDxfExport
/**
* Set reference \a scale for output.
* The \a scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* \since QGIS 3.0
* \see symbologyScale()
* \since QGIS 3.0
*/
void setSymbologyScale( double scale ) { mSymbologyScale = scale; }
/**
* Returns the reference scale for output.
* The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* \since QGIS 3.0
* \see setSymbologyScale()
* \since QGIS 3.0
*/
double symbologyScale() const { return mSymbologyScale; }

2
src/core/effects/qgsimageoperation.h
View File

@ -184,8 +184,8 @@ class CORE_EXPORT QgsImageOperation
* non-transparent region of the image is smaller than this minimum size,
* it will be centered in the returned rectangle.
* \param center return rectangle will be centered on the center of the original image if set to true
* \since QGIS 2.9
* \see cropTransparent
* \since QGIS 2.9
*/
static QRect nonTransparentImageRect( const QImage &image, QSize minSize = QSize(), bool center = false );

4
src/core/effects/qgspainteffectregistry.h
View File

@ -90,8 +90,8 @@ typedef QgsPaintEffectWidget *( *QgsPaintEffectWidgetFunc )() SIP_SKIP;
* \class QgsPaintEffectMetadata
* \brief Convenience metadata class that uses static functions to create an effect and its widget.
*
* \since QGIS 2.9
* \note not available in Python bindings
* \since QGIS 2.9
*/
class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata SIP_SKIP
{
@ -233,8 +233,8 @@ class CORE_EXPORT QgsPaintEffectRegistry
* Tests whether a paint effect matches the default effects stack.
* \param effect paint effect to test
* \returns true if effect is default stack
* \since QGIS 2.12
* \see defaultStack()
* \since QGIS 2.12
*/
static bool isDefaultStack( QgsPaintEffect *effect );

14
src/core/expression/qgsexpression.h
View File

@ -391,36 +391,36 @@ class CORE_EXPORT QgsExpression
/**
* Returns the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter".
* \note distances are only converted when a geomCalculator() has been set
* \since QGIS 2.14
* \see setDistanceUnits()
* \see areaUnits()
* \since QGIS 2.14
*/
QgsUnitTypes::DistanceUnit distanceUnits() const;
/**
* Sets the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter".
* \note distances are only converted when a geomCalculator() has been set
* \since QGIS 2.14
* \see distanceUnits()
* \see setAreaUnits()
* \since QGIS 2.14
*/
void setDistanceUnits( QgsUnitTypes::DistanceUnit unit );
/**
* Returns the desired areal units for calculations involving geomCalculator(), e.g., "$area".
* \note areas are only converted when a geomCalculator() has been set
* \since QGIS 2.14
* \see setAreaUnits()
* \see distanceUnits()
* \since QGIS 2.14
*/
QgsUnitTypes::AreaUnit areaUnits() const;
/**
* Sets the desired areal units for calculations involving geomCalculator(), e.g., "$area".
* \note areas are only converted when a geomCalculator() has been set
* \since QGIS 2.14
* \see areaUnits()
* \see setDistanceUnits()
* \since QGIS 2.14
*/
void setAreaUnits( QgsUnitTypes::AreaUnit unit );
@ -453,9 +453,9 @@ class CORE_EXPORT QgsExpression
* \param text text to evaluate as expression
* \param fallbackValue value to return if text can not be evaluated as a double
* \returns evaluated double value, or fallback value
* \since QGIS 2.7
* \note this method is inefficient for bulk evaluation of expressions, it is intended
* for one-off evaluations only.
* \since QGIS 2.7
*/
static double evaluateToDouble( const QString &text, const double fallbackValue );
@ -538,9 +538,9 @@ class CORE_EXPORT QgsExpression
* Returns a string representation of a literal value, including appropriate
* quotations where required.
* \param value value to convert to a string representation
* \since QGIS 2.14
* \see quotedString()
* \see quotedColumnRef()
* \since QGIS 2.14
*/
static QString quotedValue( const QVariant &value );
@ -549,9 +549,9 @@ class CORE_EXPORT QgsExpression
* quotations where required.
* \param value value to convert to a string representation
* \param type value type
* \since QGIS 2.14
* \see quotedString()
* \see quotedColumnRef()
* \since QGIS 2.14
*/
static QString quotedValue( const QVariant &value, QVariant::Type type );

2
src/core/expression/qgsexpressionfunction.h
View File

@ -271,8 +271,8 @@ class CORE_EXPORT QgsExpressionFunction
/**
* Returns a list of the groups the function belongs to.
* \since QGIS 3.0
* \see group()
* \since QGIS 3.0
*/
QStringList groups() const { return mGroups; }

2
src/core/expression/qgsexpressionnode.h
View File

@ -85,8 +85,8 @@ class CORE_EXPORT QgsExpressionNode SIP_ABSTRACT
/**
* Named node
* \since QGIS 2.16
* \ingroup core
* \since QGIS 2.16
*/
struct NamedNode
{

4
src/core/geometry/qgsabstractgeometry.h
View File

@ -518,9 +518,9 @@ class CORE_EXPORT QgsAbstractGeometry
* Adds a z-dimension to the geometry, initialized to a preset value.
* \param zValue initial z-value for all nodes
* \returns true on success
* \since QGIS 2.12
* \see dropZValue()
* \see addMValue()
* \since QGIS 2.12
*/
virtual bool addZValue( double zValue = 0 ) = 0;
@ -528,9 +528,9 @@ class CORE_EXPORT QgsAbstractGeometry
* Adds a measure to the geometry, initialized to a preset value.
* \param mValue initial m-value for all nodes
* \returns true on success
* \since QGIS 2.12
* \see dropMValue()
* \see addZValue()
* \since QGIS 2.12
*/
virtual bool addMValue( double mValue = 0 ) = 0;

2
src/core/geometry/qgsbox3d.h
View File

@ -29,8 +29,8 @@
* A box composed of x/y/z minimum and maximum values. It is often used to return the 3D
* extent of a geometry or collection of geometries.
*
* \since QGIS 3.0
* \see QgsRectangle
* \since QGIS 3.0
*/
class CORE_EXPORT QgsBox3d
{

4
src/core/geometry/qgscircle.h
View File

@ -164,9 +164,9 @@ class CORE_EXPORT QgsCircle : public QgsEllipse
*
* \returns true if tangent was found.
*
* \since QGIS 3.2
*
* \see outerTangents()
* \since QGIS 3.2
*/
bool tangentToPoint( const QgsPointXY &p, QgsPointXY &pt1 SIP_OUT, QgsPointXY &pt2 SIP_OUT ) const;
@ -187,9 +187,9 @@ class CORE_EXPORT QgsCircle : public QgsEllipse
*
* Note that this method is 2D only and does not consider the z-value of the circle.
*
* \since QGIS 3.2
*
* \see tangentToPoint()
* \since QGIS 3.2
*/
int outerTangents( const QgsCircle &other,
QgsPointXY &line1P1 SIP_OUT, QgsPointXY &line1P2 SIP_OUT,

2
src/core/geometry/qgscurvepolygon.h
View File

@ -104,8 +104,8 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface
* Removes the interior rings from the polygon. If the minimumAllowedArea
* parameter is specified then only rings smaller than this minimum
* area will be removed.
* \since QGIS 3.0
* \see removeInteriorRing()
* \since QGIS 3.0
*/
void removeInteriorRings( double minimumAllowedArea = -1 );

54
src/core/geometry/qgsgeometry.h
View File

@ -167,9 +167,9 @@ class CORE_EXPORT QgsGeometry
*
* \note In QGIS 2.x this method was named geometry().
*
* \since QGIS 3.0
* \see set()
* \see get()
* \since QGIS 3.0
*/
const QgsAbstractGeometry *constGet() const;
@ -181,9 +181,9 @@ class CORE_EXPORT QgsGeometry
*
* \note In QGIS 2.x this method was named geometry().
*
* \since QGIS 3.0
* \see constGet()
* \see set()
* \since QGIS 3.0
*/
QgsAbstractGeometry *get();
@ -192,9 +192,9 @@ class CORE_EXPORT QgsGeometry
*
* \note In QGIS 2.x this method was named setGeometry().
*
* \since QGIS 3.0
* \see get()
* \see constGet()
* \since QGIS 3.0
*/
void set( QgsAbstractGeometry *geometry SIP_TRANSFER );
@ -202,8 +202,8 @@ class CORE_EXPORT QgsGeometry
* Returns true if the geometry is null (ie, contains no underlying geometry
* accessible via geometry() ).
* \see get
* \since QGIS 2.10
* \see isEmpty()
* \since QGIS 2.10
*/
bool isNull() const;
@ -222,8 +222,8 @@ class CORE_EXPORT QgsGeometry
*
* \note In QGIS 2.x this method was available as fromPolyline().
*
* \since QGIS 3.0
* \see fromPolyline()
* \since QGIS 3.0
*/
static QgsGeometry fromPolylineXY( const QgsPolylineXY &polyline );
@ -314,8 +314,8 @@ class CORE_EXPORT QgsGeometry
*
* \note Comparing two null geometries will return false.
*
* \since QGIS 1.5
* \see isGeosEqual()
* \since QGIS 1.5
*/
bool equals( const QgsGeometry &geometry ) const;
@ -332,8 +332,8 @@ class CORE_EXPORT QgsGeometry
*
* \note Comparing two null geometries will return false.
*
* \since QGIS 1.5
* \see equals()
* \since QGIS 1.5
*/
bool isGeosEqual( const QgsGeometry & ) const;
@ -408,8 +408,8 @@ class CORE_EXPORT QgsGeometry
*
* In case of error -1 will be returned.
*
* \since QGIS 3.0
* \see hausdorffDistanceDensify()
* \since QGIS 3.0
*/
double hausdorffDistance( const QgsGeometry &geom ) const;
@ -428,8 +428,8 @@ class CORE_EXPORT QgsGeometry
*
* In case of error -1 will be returned.
*
* \since QGIS 3.0
* \see hausdorffDistance()
* \since QGIS 3.0
*/
double hausdorffDistanceDensify( const QgsGeometry &geom, double densifyFraction ) const;
@ -460,8 +460,8 @@ class CORE_EXPORT QgsGeometry
* Returns the bisector angle for this geometry at the specified vertex.
* \param vertex vertex index to calculate bisector angle at
* \returns bisector angle, in radians clockwise from north
* \since QGIS 3.0
* \see interpolateAngle()
* \since QGIS 3.0
*/
double angleAtVertex( int vertex ) const;
@ -554,15 +554,15 @@ class CORE_EXPORT QgsGeometry
/**
* Returns the nearest point on this geometry to another geometry.
* \since QGIS 2.14
* \see shortestLine()
* \since QGIS 2.14
*/
QgsGeometry nearestPoint( const QgsGeometry &other ) const;
/**
* Returns the shortest line joining this geometry to another geometry.
* \since QGIS 2.14
* \see nearestPoint()
* \since QGIS 2.14
*/
QgsGeometry shortestLine( const QgsGeometry &other ) const;
@ -722,8 +722,8 @@ class CORE_EXPORT QgsGeometry
* Returns the oriented minimum bounding box for the geometry, which is the smallest (by area)
* rotated rectangle which fully encompasses the geometry. The area, angle (clockwise in degrees from North),
* width and height of the rotated bounding box will also be returned.
* \since QGIS 3.0
* \see boundingBox()
* \since QGIS 3.0
*/
QgsGeometry orientedMinimumBoundingBox( double &area SIP_OUT, double &angle SIP_OUT, double &width SIP_OUT, double &height SIP_OUT ) const;
@ -921,10 +921,10 @@ class CORE_EXPORT QgsGeometry
* \param endCapStyle end cap style
* \param joinStyle join style for corners in geometry
* \param miterLimit limit on the miter ratio used for very sharp corners (JoinStyleMiter only)
* \since QGIS 2.4
*
* \see singleSidedBuffer()
* \see taperedBuffer()
* \since QGIS 2.4
*/
QgsGeometry buffer( double distance, int segments, EndCapStyle endCapStyle, JoinStyle joinStyle, double miterLimit ) const;
@ -948,10 +948,10 @@ class CORE_EXPORT QgsGeometry
* \param miterLimit limit on the miter ratio used for very sharp corners
* \returns buffered geometry, or an empty geometry if buffer could not be
* calculated
* \since QGIS 3.0
*
* \see buffer()
* \see taperedBuffer()
* \since QGIS 3.0
*/
QgsGeometry singleSidedBuffer( double distance, int segments, BufferSide side,
JoinStyle joinStyle = JoinStyleRound,
@ -969,10 +969,10 @@ class CORE_EXPORT QgsGeometry
*
* Non (multi)curve input geometries will return a null output geometry.
*
* \since QGIS 3.2
* \see buffer()
* \see singleSidedBuffer()
* \see variableWidthBufferByM()
* \since QGIS 3.2
*/
QgsGeometry taperedBuffer( double startWidth, double endWidth, int segments ) const;
@ -985,10 +985,10 @@ class CORE_EXPORT QgsGeometry
*
* Non (multi)linestring input geometries will return a null output geometry.
*
* \since QGIS 3.2
* \see buffer()
* \see singleSidedBuffer()
* \see taperedBuffer()
* \since QGIS 3.2
*/
QgsGeometry variableWidthBufferByM( int segments ) const;
@ -1009,8 +1009,8 @@ class CORE_EXPORT QgsGeometry
* If the geometry has z or m values present then these will be linearly interpolated
* at the added nodes.
* Curved geometry types are automatically segmentized by this routine.
* \since QGIS 3.0
* \see densifyByDistance()
* \since QGIS 3.0
*/
QgsGeometry densifyByCount( int extraNodesPerSegment ) const;
@ -1025,8 +1025,8 @@ class CORE_EXPORT QgsGeometry
* If the geometry has z or m values present then these will be linearly interpolated
* at the added nodes.
* Curved geometry types are automatically segmentized by this routine.
* \since QGIS 3.0
* \see densifyByCount()
* \since QGIS 3.0
*/
QgsGeometry densifyByDistance( double distance ) const;
@ -1141,8 +1141,8 @@ class CORE_EXPORT QgsGeometry
* If an error was encountered while creating the result, more information can be retrieved
* by calling `error()` on the returned geometry.
*
* \since QGIS 2.0
* \see lineLocatePoint()
* \since QGIS 2.0
*/
QgsGeometry interpolate( double distance ) const;
@ -1165,8 +1165,8 @@ class CORE_EXPORT QgsGeometry
* If the distance coincides precisely at a node then the average angle from the segment either side
* of the node is returned.
* \param distance distance along geometry
* \since QGIS 3.0
* \see angleAtVertex()
* \since QGIS 3.0
*/
double interpolateAngle( double distance ) const;
@ -1442,9 +1442,9 @@ class CORE_EXPORT QgsGeometry
/**
* Validates geometry and produces a list of geometry errors.
* The \a method argument dictates which validator to utilize.
* \since QGIS 1.5
* \note Available in Python bindings since QGIS 1.6
**/
* \since QGIS 1.5
*/
void validateGeometry( QVector<QgsGeometry::Error> &errors SIP_OUT, ValidationMethod method = ValidatorQgisInternal ) const;
/**
@ -1468,16 +1468,16 @@ class CORE_EXPORT QgsGeometry
* Converts the geometry to straight line segments, if it is a curved geometry type.
* \param tolerance segmentation tolerance
* \param toleranceType maximum segmentation angle or maximum difference between approximation and curve
* \since QGIS 2.10
* \see requiresConversionToStraightSegments
* \since QGIS 2.10
*/
void convertToStraightSegment( double tolerance = M_PI / 180., QgsAbstractGeometry::SegmentationToleranceType toleranceType = QgsAbstractGeometry::MaximumAngle );
/**
* Returns true if the geometry is a curved geometry type which requires conversion to
* display as straight line segments.
* \since QGIS 2.10
* \see convertToStraightSegment
* \since QGIS 2.10
*/
bool requiresConversionToStraightSegments() const;
@ -1502,8 +1502,8 @@ class CORE_EXPORT QgsGeometry
*
* Returns true if vertex was found.
*
* \since QGIS 2.10
* \see vertexNrFromVertexId()
* \since QGIS 2.10
*/
bool vertexIdFromVertexNr( int number, QgsVertexId &id SIP_OUT ) const;
@ -1515,8 +1515,8 @@ class CORE_EXPORT QgsGeometry
*
* Returns -1 if a corresponding vertex could not be found.
*
* \since QGIS 2.10
* \see vertexIdFromVertexNr()
* \since QGIS 2.10
*/
int vertexNrFromVertexId( QgsVertexId id ) const;

2
src/core/geometry/qgsgeometryeditutils.h
View File

@ -32,8 +32,8 @@ class QgsVectorLayer;
* \ingroup core
* \class QgsGeometryEditUtils
* \brief Convenience functions for geometry editing
* \since QGIS 2.10
* \note not available in Python bindings
* \since QGIS 2.10
*/
class QgsGeometryEditUtils
{

2
src/core/geometry/qgsgeometryfactory.h
View File

@ -46,8 +46,8 @@ typedef QVector<QgsPolygonXY> QgsMultiPolygonXY;
* \ingroup core
* \class QgsGeometryFactory
* \brief Contains geometry creation routines.
* \since QGIS 2.10
* \note not available in Python bindings
* \since QGIS 2.10
*/
class CORE_EXPORT QgsGeometryFactory
{

8
src/core/geometry/qgsgeometryutils.h
View File

@ -292,8 +292,8 @@ class CORE_EXPORT QgsGeometryUtils
* to the shorter arc from \a p1 to \a p2. If it is false, the longer arc from \a p1
* to \a p2 will be used (i.e. winding the other way around the circle).
*
* \since QGIS 3.2
* \see segmentMidPoint()
* \since QGIS 3.2
*/
static QgsPoint segmentMidPointFromCenter( const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &center, bool useShortestArc = true );
@ -462,8 +462,8 @@ class CORE_EXPORT QgsGeometryUtils
* use a \a fraction < 0 or > 1, in which case the returned point
* is extrapolated from the supplied line.
*
* \since QGIS 3.0.2
* \see interpolatePointOnLineByValue()
* \since QGIS 3.0.2
*/
static QgsPointXY interpolatePointOnLine( double x1, double y1, double x2, double y2, double fraction );
@ -480,8 +480,8 @@ class CORE_EXPORT QgsGeometryUtils
* Any Z or M values present in the input points will also be interpolated
* and present in the returned point.
*
* \since QGIS 3.0.2
* \see interpolatePointOnLineByValue()
* \since QGIS 3.0.2
*/
static QgsPoint interpolatePointOnLine( const QgsPoint &p1, const QgsPoint &p2, double fraction );
@ -494,8 +494,8 @@ class CORE_EXPORT QgsGeometryUtils
* point will be linearly interpolated to match position corresponding to
* the target \a value.
*
* \since QGIS 3.0.2
* \see interpolatePointOnLine()
* \since QGIS 3.0.2
*/
static QgsPointXY interpolatePointOnLineByValue( double x1, double y1, double v1, double x2, double y2, double v2, double value );

10
src/core/geometry/qgsgeos.h
View File

@ -35,8 +35,8 @@ class QgsGeometryCollection;
/**
* Contains geos related utilities and functions.
* \since QGIS 3.0
* \note not available in Python bindings.
* \since QGIS 3.0
*/
namespace geos
{
@ -184,8 +184,8 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
*
* If the default approximate provided by this method is insufficient, use hausdorffDistanceDensify() instead.
*
* \since QGIS 3.0
* \see hausdorffDistanceDensify()
* \since QGIS 3.0
*/
double hausdorffDistance( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const;
@ -202,8 +202,8 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
* is not sufficient. Decreasing the \a densifyFraction parameter will make the
* distance returned approach the true Hausdorff distance for the geometries.
*
* \since QGIS 3.0
* \see hausdorffDistance()
* \since QGIS 3.0
*/
double hausdorffDistanceDensify( const QgsAbstractGeometry *geom, double densifyFraction, QString *errorMsg = nullptr ) const;
@ -270,15 +270,15 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
/**
* Returns the closest point on the geometry to the other geometry.
* \since QGIS 2.14
* \see shortestLine()
* \since QGIS 2.14
*/
QgsGeometry closestPoint( const QgsGeometry &other, QString *errorMsg = nullptr ) const;
/**
* Returns the shortest line joining this geometry to the other geometry.
* \since QGIS 2.14
* \see closestPoint()
* \since QGIS 2.14
*/
QgsGeometry shortestLine( const QgsGeometry &other, QString *errorMsg = nullptr ) const;

2
src/core/geometry/qgsinternalgeometryengine.h
View File

@ -153,8 +153,8 @@ class QgsInternalGeometryEngine
/**
* A 2D ray which extends from an origin point to an infinite distance in a given direction.
* \ingroup core
* \since QGIS 3.2
* \note not available in Python bindings
* \since QGIS 3.2
*/
class CORE_EXPORT QgsRay2D
{

4
src/core/geometry/qgslinestring.h
View File

@ -98,17 +98,17 @@ class CORE_EXPORT QgsLineString: public QgsCurve
/**
* Returns a const pointer to the x vertex data.
* \since QGIS 3.2
* \note Not available in Python bindings
* \see yData()
* \since QGIS 3.2
*/
const double *xData() const SIP_SKIP;
/**
* Returns a const pointer to the y vertex data.
* \since QGIS 3.2
* \note Not available in Python bindings
* \see xData()
* \since QGIS 3.2
*/
const double *yData() const SIP_SKIP;

4
src/core/geometry/qgspoint.h
View File

@ -246,8 +246,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry
* Returns the distance between this point and a specified x, y coordinate. In certain
* cases it may be more appropriate to call the faster distanceSquared() method, e.g.,
* when comparing distances.
* \since QGIS 3.0
* \see distanceSquared()
* \since QGIS 3.0
*/
double distance( double x, double y ) const;
@ -281,8 +281,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry
* Returns the 3D distance between this point and a specified x, y, z coordinate. In certain
* cases it may be more appropriate to call the faster distanceSquared() method, e.g.,
* when comparing distances.
* \since QGIS 3.0
* \see distanceSquared()
* \since QGIS 3.0
*/
double distance3D( double x, double y, double z ) const;

6
src/core/geometry/qgsrectangle.h
View File

@ -150,17 +150,17 @@ class CORE_EXPORT QgsRectangle
/**
* Returns the area of the rectangle.
* \since QGIS 3.0
* \see width()
* \see height()
* \see perimeter()
* \since QGIS 3.0
*/
double area() const { return ( mXmax - mXmin ) * ( mYmax - mYmin ); }
/**
* Returns the perimeter of the rectangle.
* \since QGIS 3.0
* \see area()
* \since QGIS 3.0
*/
double perimeter() const { return 2 * ( mXmax - mXmin ) + 2 * ( mYmax - mYmin ); }
@ -193,8 +193,8 @@ class CORE_EXPORT QgsRectangle
/**
* Gets rectangle enlarged by buffer.
* \note In earlier QGIS releases this method was named buffer().
* \since QGIS 3.0
* \see grow()
* \since QGIS 3.0
*/
QgsRectangle buffered( double width ) const;

2
src/core/geometry/qgsreferencedgeometry.h
View File

@ -33,8 +33,8 @@
* (such as rectangles) which have an optional coordinate reference system
* associated with them.
*
* \since QGIS 3.0
* \see QgsReferencedRectangle
* \since QGIS 3.0
*/
class CORE_EXPORT QgsReferencedGeometryBase
{

10
src/core/geometry/qgswkbtypes.h
View File

@ -644,8 +644,8 @@ class CORE_EXPORT QgsWkbTypes
* Returns the coordinate dimension of the geometry type as an integer. Returned value will
* be between 2-4, depending on whether the geometry type contains the Z or M dimensions.
* Invalid geometry types will return a dimension of 0.
* \since QGIS 2.14
* \see wkbDimensions()
* \since QGIS 2.14
*/
static int coordDimensions( Type type )
{
@ -856,10 +856,10 @@ class CORE_EXPORT QgsWkbTypes
/**
* Adds the z dimension to a WKB type and returns the new type
* \param type original type
* \since QGIS 2.12
* \see addM()
* \see dropZ()
* \see hasZ()
* \since QGIS 2.12
*/
static Type addZ( Type type )
{
@ -881,10 +881,10 @@ class CORE_EXPORT QgsWkbTypes
/**
* Adds the m dimension to a WKB type and returns the new type
* \param type original type
* \since QGIS 2.12
* \see addZ()
* \see dropM()
* \see hasM()
* \since QGIS 2.12
*/
static Type addM( Type type )
{
@ -913,9 +913,9 @@ class CORE_EXPORT QgsWkbTypes
/**
* Drops the z dimension (if present) for a WKB type and returns the new type.
* \param type original type
* \since QGIS 2.14
* \see dropM()
* \see addZ()
* \since QGIS 2.14
*/
static Type dropZ( Type type )
{
@ -931,9 +931,9 @@ class CORE_EXPORT QgsWkbTypes
/**
* Drops the m dimension (if present) for a WKB type and returns the new type.
* \param type original type
* \since QGIS 2.14
* \see dropZ()
* \see addM()
* \since QGIS 2.14
*/
static Type dropM( Type type )
{

6
src/core/layertree/qgslayertree.h
View File

@ -58,8 +58,8 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
/**
* Cast node to a group. No type checking is done - use isGroup() to find out whether this operation is legal.
*
* \since QGIS 2.4
* \note Not available in Python bindings, because cast is automatic.
* \since QGIS 2.4
*/
static inline QgsLayerTreeGroup *toGroup( QgsLayerTreeNode *node ) SIP_SKIP
{
@ -69,8 +69,8 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
/**
* Cast node to a layer. No type checking is done - use isLayer() to find out whether this operation is legal.
*
* \since QGIS 2.4
* \note Not available in Python bindings, because cast is automatic.
* \since QGIS 2.4
*/
static inline QgsLayerTreeLayer *toLayer( QgsLayerTreeNode *node ) SIP_SKIP
{
@ -80,8 +80,8 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
/**
* Cast node to a layer. No type checking is done - use isLayer() to find out whether this operation is legal.
*
* \since QGIS 2.4
* \note Not available in Python bindings, because cast is automatic.
* \since QGIS 2.4
*/
static inline const QgsLayerTreeLayer *toLayer( const QgsLayerTreeNode *node ) SIP_SKIP
{

8
src/core/layertree/qgslayertreemodel.h
View File

@ -149,16 +149,16 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel
/**
* Returns filtered list of active legend nodes attached to a particular layer node
* (by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is true)
* \since QGIS 2.6
* \note Parameter skipNodeEmbeddedInParent added in QGIS 2.18
* \see layerOriginalLegendNodes()
* \since QGIS 2.6
*/
QList<QgsLayerTreeModelLegendNode *> layerLegendNodes( QgsLayerTreeLayer *nodeLayer, bool skipNodeEmbeddedInParent = false );
/**
* Returns original (unfiltered) list of legend nodes attached to a particular layer node
* \since QGIS 2.14
* \see layerLegendNodes()
* \since QGIS 2.14
*/
QList<QgsLayerTreeModelLegendNode *> layerOriginalLegendNodes( QgsLayerTreeLayer *nodeLayer );
@ -212,8 +212,8 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel
* Force only display of legend nodes which are valid for a given \a scale.
* The \a scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* Setting \a scale <= 0 will disable the functionality.
* \since QGIS 2.6
* \see legendFilterByScale()
* \since QGIS 2.6
*/
void setLegendFilterByScale( double scale );
@ -221,8 +221,8 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel
* Returns the scale which restricts the legend nodes which are visible.
* The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* A scale <= 0 indicates that no scale filtering is being performed.
* \since QGIS 2.6
* \see setLegendFilterByScale()
* \since QGIS 2.6
*/
double legendFilterByScale() const { return mLegendFilterByScale; }

4
src/core/layertree/qgslayertreemodellegendnode.h
View File

@ -250,15 +250,15 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode
/**
* Checks all items belonging to the same layer as this node.
* \since QGIS 2.14
* \see uncheckAllItems()
* \since QGIS 2.14
*/
void checkAllItems();
/**
* Unchecks all items belonging to the same layer as this node.
* \since QGIS 2.14
* \see checkAllItems()
* \since QGIS 2.14
*/
void uncheckAllItems();

2
src/core/layout/qgscompositionconverter.h
View File

@ -48,9 +48,9 @@ class QgsLayoutItemAttributeTable;
/**
* QgsCompositionConverter class converts a QGIS 2.x composition to a QGIS 3.x layout
* \since QGIS 3.0
* \note Not available in Python bindings.
* \ingroup core
* \since QGIS 3.0
*/
class CORE_EXPORT QgsCompositionConverter
{

4
src/core/layout/qgslayoutitemmapgrid.h
View File

@ -39,8 +39,8 @@ class QgsRenderContext;
* \brief A collection of grids which is drawn above the map content in a
* QgsLayoutItemMap. The grid stack controls which grids are drawn and the
* order they are drawn in.
* \since QGIS 3.0
* \see QgsLayoutItemMapGrid
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutItemMapGridStack : public QgsLayoutItemMapItemStack
{
@ -133,8 +133,8 @@ class CORE_EXPORT QgsLayoutItemMapGridStack : public QgsLayoutItemMapItemStack
* \class QgsLayoutItemMapGrid
* \brief An individual grid which is drawn above the map content in a
* QgsLayoutItemMap.
* \since QGIS 3.0
* \see QgsLayoutItemMapGridStack
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutItemMapGrid : public QgsLayoutItemMapItem
{

2
src/core/layout/qgslayoutitemmapitem.h
View File

@ -141,8 +141,8 @@ class CORE_EXPORT QgsLayoutItemMapItem : public QgsLayoutObject
* \brief A collection of map items which are drawn above the map content in a
* QgsLayoutItemMap. The item stack controls which items are drawn and the
* order they are drawn in.
* \since QGIS 3.0
* \see QgsLayoutItemMapItem
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutItemMapItemStack
{

4
src/core/layout/qgslayoutitemmapoverview.h
View File

@ -37,8 +37,8 @@ class QgsLayoutItemMapOverview;
* \brief A collection of overviews which are drawn above the map content in a
* QgsLayoutItemMap. The overview stack controls which overviews are drawn and the
* order they are drawn in.
* \since QGIS 3.0
* \see QgsLayoutItemMapOverview
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutItemMapOverviewStack : public QgsLayoutItemMapItemStack
{
@ -113,8 +113,8 @@ class CORE_EXPORT QgsLayoutItemMapOverviewStack : public QgsLayoutItemMapItemSta
* \class QgsLayoutItemMapOverview
* \brief An individual overview which is drawn above the map content in a
* QgsLayoutItemMap, and shows the extent of another QgsLayoutItemMap.
* \since QGIS 3.0
* \see QgsLayoutItemMapOverviewStack
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutItemMapOverview : public QgsLayoutItemMapItem
{

4
src/core/layout/qgslayoutitemregistry.h
View File

@ -103,8 +103,8 @@ typedef std::function<void( QVariantMap &, const QgsPathResolver &, bool )> QgsL
/**
* \ingroup core
* Convenience metadata class that uses static functions to create layout items and their configuration widgets.
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutItemMetadata : public QgsLayoutItemAbstractMetadata
{
@ -224,8 +224,8 @@ typedef std::function<void( QVariantMap &, const QgsPathResolver &, bool )> QgsL
/**
* \ingroup core
* Convenience metadata class that uses static functions to create layout multiframes and their configuration widgets.
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutMultiFrameMetadata : public QgsLayoutMultiFrameAbstractMetadata
{

2
src/core/layout/qgslayoutpoint.h
View File

@ -29,12 +29,12 @@
* for use in QGIS layouts. Measurement units are stored alongside the position.
*
* \see QgsLayoutMeasurementConverter
* \since QGIS 3.0
* \note This class does not inherit from QPointF since QPointF includes methods which should not apply
* to positions with with units. For instance, the + and - operators would mislead users of this class
* to believe that addition of two QgsLayoutPoints with different unit types would automatically convert
* units. Instead, all unit conversion must be handled by a QgsLayoutMeasurementConverter so that
* conversion between paper and screen units can be correctly performed.
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutPoint
{

2
src/core/layout/qgslayoutsize.h
View File

@ -30,12 +30,12 @@
* for use in QGIS layouts. Measurement units are stored alongside the size.
*
* \see QgsLayoutMeasurementConverter
* \since QGIS 3.0
* \note This class does not inherit from QSizeF since QSizeF includes methods which should not apply to sizes
* with units. For instance, the + and - operators would mislead users of this class to believe that
* addition of two QgsLayoutSize with different unit types would automatically convert units. Instead,
* all unit conversion must be handled by a QgsLayoutMeasurementConverter so that conversion between
* paper and screen units can be correctly performed.
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutSize
{

2
src/core/mesh/qgsmeshlayerinterpolator.h
View File

@ -40,8 +40,8 @@ class QgsSymbol;
* \ingroup core
* Interpolate mesh scalar dataset to raster block
*
* \since QGIS 3.2
* \note not available in Python bindings
* \since QGIS 3.2
*/
class QgsMeshLayerInterpolator : public QgsRasterInterface
{

2
src/core/mesh/qgsmeshlayerrenderer.h
View File

@ -51,8 +51,8 @@ class QgsMeshLayerRendererFeedback : public QgsRasterBlockFeedback
* \ingroup core
* Implementation of threaded rendering for mesh layers.
*
* \since QGIS 3.2
* \note not available in Python bindings
* \since QGIS 3.2
*/
class QgsMeshLayerRenderer : public QgsMapLayerRenderer
{

2
src/core/mesh/qgsmeshvectorrenderer.h
View File

@ -38,8 +38,8 @@
*
* Helper private class for rendering vector datasets (e.g. velocity)
*
* \since QGIS 3.2
* \note not available in Python bindings
* \since QGIS 3.2
*/
class QgsMeshVectorRenderer
{

2
src/core/processing/models/qgsprocessingmodelalgorithm.h
View File

@ -302,8 +302,8 @@ class CORE_EXPORT QgsProcessingModelAlgorithm : public QgsProcessingAlgorithm
/**
* Definition of a expression context variable available during model execution.
* \since QGIS 3.0
* \ingroup core
* \since QGIS 3.0
*/
class CORE_EXPORT VariableDefinition
{

2
src/core/processing/models/qgsprocessingmodelchildalgorithm.h
View File

@ -32,8 +32,8 @@ class QgsProcessingAlgorithm;
/**
* Child algorithm representing a single component of a QgsProcessingModelAlgorithm.
* \since QGIS 3.0
* \ingroup core
* \since QGIS 3.0
*/
class CORE_EXPORT QgsProcessingModelChildAlgorithm : public QgsProcessingModelComponent
{

2
src/core/processing/models/qgsprocessingmodelchildparametersource.h
View File

@ -25,8 +25,8 @@
/**
* Source for the value of a parameter for a child algorithm within a model.
* \since QGIS 3.0
* \ingroup core
* \since QGIS 3.0
*/
class CORE_EXPORT QgsProcessingModelChildParameterSource
{

2
src/core/processing/models/qgsprocessingmodelcomponent.h
View File

@ -26,8 +26,8 @@
/**
* Represents a component of a model algorithm.
* \since QGIS 3.0
* \ingroup core
* \since QGIS 3.0
*/
class CORE_EXPORT QgsProcessingModelComponent
{

2
src/core/processing/models/qgsprocessingmodeloutput.h
View File

@ -27,8 +27,8 @@
/**
* Represents a final output created by the model.
* \since QGIS 3.0
* \ingroup core
* \since QGIS 3.0
*/
class CORE_EXPORT QgsProcessingModelOutput : public QgsProcessingModelComponent
{

2
src/core/processing/models/qgsprocessingmodelparameter.h
View File

@ -27,8 +27,8 @@
/**
* Represents an input parameter used by the model.
* \since QGIS 3.0
* \ingroup core
* \since QGIS 3.0
*/
class CORE_EXPORT QgsProcessingModelParameter : public QgsProcessingModelComponent
{

6
src/core/processing/qgsprocessingalgorithm.h
View File

@ -762,10 +762,10 @@ class CORE_EXPORT QgsProcessingAlgorithm
* The \a parameters argument should give the algorithms parameter map, and the \a name
* should correspond to the invalid source parameter name.
*
* \since QGIS 3.2
*
* \see invalidRasterError()
* \see invalidSinkError()
* \since QGIS 3.2
*/
static QString invalidSourceError( const QVariantMap &parameters, const QString &name );
@ -776,10 +776,10 @@ class CORE_EXPORT QgsProcessingAlgorithm
* The \a parameters argument should give the algorithms parameter map, and the \a name
* should correspond to the invalid source parameter name.
*
* \since QGIS 3.2
*
* \see invalidSourceError()
* \see invalidSinkError()
* \since QGIS 3.2
*/
static QString invalidRasterError( const QVariantMap &parameters, const QString &name );
@ -790,10 +790,10 @@ class CORE_EXPORT QgsProcessingAlgorithm
* The \a parameters argument should give the algorithms parameter map, and the \a name
* should correspond to the invalid source parameter name.
*
* \since QGIS 3.2
*
* \see invalidSourceError()
* \see invalidRasterError()
* \since QGIS 3.2
*/
static QString invalidSinkError( const QVariantMap &parameters, const QString &name );

16
src/core/processing/qgsprocessingcontext.h
View File

@ -186,8 +186,8 @@ class CORE_EXPORT QgsProcessingContext
/**
* Layer post-processor. May be nullptr if no post-processing is required.
* \since QGIS 3.2
* \see setPostProcessor()
* \since QGIS 3.2
*/
QgsProcessingLayerPostProcessorInterface *postProcessor() const;
@ -196,8 +196,8 @@ class CORE_EXPORT QgsProcessingContext
*
* Ownership of \a processor is transferred.
*
* \since QGIS 3.2
* \see postProcessor()
* \since QGIS 3.2
*/
void setPostProcessor( QgsProcessingLayerPostProcessorInterface *processor SIP_TRANSFER );
@ -226,11 +226,11 @@ class CORE_EXPORT QgsProcessingContext
/**
* Returns true if the given \a layer (by ID or datasource) will be loaded into the current project
* upon completion of the algorithm or model.
* \since QGIS 3.2
* \see layersToLoadOnCompletion()
* \see setLayersToLoadOnCompletion()
* \see addLayerToLoadOnCompletion()
* \see layerToLoadOnCompletionDetails()
* \since QGIS 3.2
*/
bool willLoadLayerOnCompletion( const QString &layer ) const
{
@ -263,11 +263,11 @@ class CORE_EXPORT QgsProcessingContext
* \warning First check willLoadLayerOnCompletion(), or calling this method will incorrectly
* add \a layer as a layer to load on completion.
*
* \since QGIS 3.2
* \see willLoadLayerOnCompletion()
* \see addLayerToLoadOnCompletion()
* \see setLayersToLoadOnCompletion()
* \see layersToLoadOnCompletion()
* \since QGIS 3.2
*/
QgsProcessingContext::LayerDetails &layerToLoadOnCompletionDetails( const QString &layer )
{
@ -292,8 +292,8 @@ class CORE_EXPORT QgsProcessingContext
* Sets a callback function to use when encountering an invalid geometry and
* invalidGeometryCheck() is set to GeometryAbortOnInvalid. This function will be
* called using the feature with invalid geometry as a parameter.
* \since QGIS 3.0
* \see invalidGeometryCallback()
* \since QGIS 3.0
*/
#ifndef SIP_RUN
void setInvalidGeometryCallback( const std::function< void( const QgsFeature & ) > &callback ) { mInvalidGeometryCallback = callback; }
@ -316,9 +316,9 @@ class CORE_EXPORT QgsProcessingContext
/**
* Returns the callback function to use when encountering an invalid geometry and
* invalidGeometryCheck() is set to GeometryAbortOnInvalid.
* \since QGIS 3.0
* \note not available in Python bindings
* \see setInvalidGeometryCallback()
* \since QGIS 3.0
*/
SIP_SKIP std::function< void( const QgsFeature & ) > invalidGeometryCallback() const { return mInvalidGeometryCallback; }
@ -326,8 +326,8 @@ class CORE_EXPORT QgsProcessingContext
* Sets a callback function to use when encountering a transform error when iterating
* features. This function will be
* called using the feature which encountered the transform error as a parameter.
* \since QGIS 3.0
* \see transformErrorCallback()
* \since QGIS 3.0
*/
#ifndef SIP_RUN
void setTransformErrorCallback( const std::function< void( const QgsFeature & ) > &callback ) { mTransformErrorCallback = callback; }
@ -350,9 +350,9 @@ class CORE_EXPORT QgsProcessingContext
/**
* Returns the callback function to use when encountering a transform error when iterating
* features.
* \since QGIS 3.0
* \note not available in Python bindings
* \see setTransformErrorCallback()
* \since QGIS 3.0
*/
std::function< void( const QgsFeature & ) > transformErrorCallback() const { return mTransformErrorCallback; } SIP_SKIP

2
src/core/processing/qgsprocessingparametertype.h
View File

@ -27,8 +27,8 @@
/**
* Makes metadata of processing parameters available.
*
* \since QGIS 3.2
* \ingroup core
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterType
{

46
src/core/processing/qgsprocessingparametertypeimpl.h
View File

@ -28,9 +28,9 @@
/**
* A raster layer parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('raster')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeRasterLayer : public QgsProcessingParameterType
{
@ -58,9 +58,9 @@ class CORE_EXPORT QgsProcessingParameterTypeRasterLayer : public QgsProcessingPa
/**
* A vector layer parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('vector')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeVectorLayer : public QgsProcessingParameterType
{
@ -88,9 +88,9 @@ class CORE_EXPORT QgsProcessingParameterTypeVectorLayer : public QgsProcessingPa
/**
* A generic map layer parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('maplayer')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeMapLayer : public QgsProcessingParameterType
{
@ -118,9 +118,9 @@ class CORE_EXPORT QgsProcessingParameterTypeMapLayer : public QgsProcessingParam
/**
* A boolean parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('boolean')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeBoolean : public QgsProcessingParameterType
{
@ -148,9 +148,9 @@ class CORE_EXPORT QgsProcessingParameterTypeBoolean : public QgsProcessingParame
/**
* An expression parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('expression')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeExpression : public QgsProcessingParameterType
{
@ -178,9 +178,9 @@ class CORE_EXPORT QgsProcessingParameterTypeExpression : public QgsProcessingPar
/**
* A crs parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('crs')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeCrs : public QgsProcessingParameterType
{
@ -208,9 +208,9 @@ class CORE_EXPORT QgsProcessingParameterTypeCrs : public QgsProcessingParameterT
/**
* A numeric range parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('range')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeRange : public QgsProcessingParameterType
{
@ -238,9 +238,9 @@ class CORE_EXPORT QgsProcessingParameterTypeRange : public QgsProcessingParamete
/**
* A point parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('point')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypePoint : public QgsProcessingParameterType
{
@ -268,9 +268,9 @@ class CORE_EXPORT QgsProcessingParameterTypePoint : public QgsProcessingParamete
/**
* An enum based parameter for processing algorithms, allowing for selection from predefined values.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('enum')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeEnum : public QgsProcessingParameterType
{
@ -298,9 +298,9 @@ class CORE_EXPORT QgsProcessingParameterTypeEnum : public QgsProcessingParameter
/**
* A rectangular map extent parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('extent')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeExtent : public QgsProcessingParameterType
{
@ -328,9 +328,9 @@ class CORE_EXPORT QgsProcessingParameterTypeExtent : public QgsProcessingParamet
/**
* A table (matrix) parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('matrix')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeMatrix : public QgsProcessingParameterType
{
@ -358,9 +358,9 @@ class CORE_EXPORT QgsProcessingParameterTypeMatrix : public QgsProcessingParamet
/**
* An input file or folder parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('file')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeFile : public QgsProcessingParameterType
{
@ -388,9 +388,9 @@ class CORE_EXPORT QgsProcessingParameterTypeFile : public QgsProcessingParameter
/**
* A vector layer or feature source field parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('field')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeField : public QgsProcessingParameterType
{
@ -419,9 +419,9 @@ class CORE_EXPORT QgsProcessingParameterTypeField : public QgsProcessingParamete
* A vector layer destination parameter, for specifying the destination path for a vector layer
* created by the algorithm.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('vectorDestination')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeVectorDestination : public QgsProcessingParameterType
{
@ -463,9 +463,9 @@ class CORE_EXPORT QgsProcessingParameterTypeVectorDestination : public QgsProces
* A generic file based destination parameter, for specifying the destination path for a file (non-map layer)
* created by the algorithm.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('fileDestination')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeFileDestination : public QgsProcessingParameterType
{
@ -508,9 +508,9 @@ class CORE_EXPORT QgsProcessingParameterTypeFileDestination : public QgsProcessi
* by the algorithm or used for creating new files within the algorithm.
* A folder output parameter.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('folderDestination')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeFolderDestination : public QgsProcessingParameterType
{
@ -552,9 +552,9 @@ class CORE_EXPORT QgsProcessingParameterTypeFolderDestination : public QgsProces
* A raster layer destination parameter, for specifying the destination path for a raster layer
* created by the algorithm.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('rasterDestination')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeRasterDestination : public QgsProcessingParameterType
{
@ -595,9 +595,9 @@ class CORE_EXPORT QgsProcessingParameterTypeRasterDestination : public QgsProces
/**
* A string parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('string')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeString : public QgsProcessingParameterType
{
@ -625,9 +625,9 @@ class CORE_EXPORT QgsProcessingParameterTypeString : public QgsProcessingParamet
/**
* A parameter for processing algorithms which accepts multiple map layers.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('multilayer')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeMultipleLayers : public QgsProcessingParameterType
{
@ -655,9 +655,9 @@ class CORE_EXPORT QgsProcessingParameterTypeMultipleLayers : public QgsProcessin
/**
* An input feature source (such as vector layers) parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('source')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeFeatureSource : public QgsProcessingParameterType
{
@ -685,9 +685,9 @@ class CORE_EXPORT QgsProcessingParameterTypeFeatureSource : public QgsProcessing
/**
* A numeric parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('number')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeNumber : public QgsProcessingParameterType
{
@ -715,9 +715,9 @@ class CORE_EXPORT QgsProcessingParameterTypeNumber : public QgsProcessingParamet
/**
* A distance parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('distance')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeDistance : public QgsProcessingParameterType
{
@ -745,9 +745,9 @@ class CORE_EXPORT QgsProcessingParameterTypeDistance : public QgsProcessingParam
/**
* A raster band parameter for Processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('band')
* \since QGIS 3.2
*/
class CORE_EXPORT QgsProcessingParameterTypeBand : public QgsProcessingParameterType
{

2
src/core/processing/qgsprocessingutils.h
View File

@ -348,8 +348,8 @@ class CORE_EXPORT QgsProcessingFeatureSource : public QgsFeatureSource
* \class QgsProcessingFeatureSink
* \ingroup core
* QgsProxyFeatureSink subclass which reports feature addition errors to a QgsProcessingContext.
* \since QGIS 3.0
* \note Not available in Python bindings.
* \since QGIS 3.0
*/
class CORE_EXPORT QgsProcessingFeatureSink : public QgsProxyFeatureSink
{

10
src/core/qgis.h
View File

@ -175,8 +175,8 @@ class CORE_EXPORT Qgis
* RAII signal blocking class. Used for temporarily blocking signals from a QObject
* for the lifetime of QgsSignalBlocker object.
* \see whileBlocking()
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
template<class Object> class QgsSignalBlocker SIP_SKIP SIP_SKIP // clazy:exclude=rule-of-three
@ -216,9 +216,9 @@ template<class Object> class QgsSignalBlocker SIP_SKIP SIP_SKIP // clazy:exclude
*
* No signals will be emitted when calling these methods.
*
* \since QGIS 2.16
* \see QgsSignalBlocker
* \note not available in Python bindings
* \since QGIS 2.16
*/
// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
template<class Object> inline QgsSignalBlocker<Object> whileBlocking( Object *object ) SIP_SKIP SIP_SKIP
@ -316,8 +316,8 @@ namespace qgis
*
* To be used as a proxy for std::as_const until we target c++17 minimum.
*
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
template <typename T> struct QgsAddConst { typedef const T Type; };
@ -393,8 +393,8 @@ namespace qgis
* \param string string to convert
* \param ok will be set to true if conversion was successful
* \returns string converted to double if possible
* \since QGIS 2.9
* \see permissiveToInt
* \since QGIS 2.9
*/
CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok );
@ -404,8 +404,8 @@ CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok );
* \param string string to convert
* \param ok will be set to true if conversion was successful
* \returns string converted to int if possible
* \since QGIS 2.9
* \see permissiveToDouble
* \since QGIS 2.9
*/
CORE_EXPORT int qgsPermissiveToInt( QString string, bool &ok );

4
src/core/qgsanimatedicon.h
View File

@ -63,9 +63,9 @@ class CORE_EXPORT QgsAnimatedIcon : public QObject
* Connect to the frame changed signal with this method and not directly. This method
* makes sure the annimation is started.
*
* \since QGIS 3.0
* \note Available in Python bindings as
* bool connectFrameChanged( const QObject *receiver, const char *method );.
* \since QGIS 3.0
*/
template <typename Func1>
bool connectFrameChanged( const typename QtPrivate::FunctionPointer<Func1>::Object *receiver, Func1 slot )
@ -82,9 +82,9 @@ class CORE_EXPORT QgsAnimatedIcon : public QObject
/**
* Convenience function to disconnect the same style that the frame change connection was established.
*
* \since QGIS 3.0
* \note Available in Python bindings as
* bool disconnectFrameChanged( const QObject *receiver, const char *method );.
* \since QGIS 3.0
*/
template <typename Func1>
bool disconnectFrameChanged( const typename QtPrivate::FunctionPointer<Func1>::Object *receiver, Func1 slot )

12
src/core/qgsapplication.h
View File

@ -359,29 +359,29 @@ class CORE_EXPORT QgsApplication : public QApplication
/**
* Returns the user's operating system login account name.
* \since QGIS 2.14
* \see userFullName()
* \since QGIS 2.14
*/
static QString userLoginName();
/**
* Returns the user's operating system login account full display name.
* \since QGIS 2.14
* \see userLoginName()
* \since QGIS 2.14
*/
static QString userFullName();
/**
* Returns a string name of the operating system QGIS is running on.
* \since QGIS 2.14
* \see platform()
* \since QGIS 2.14
*/
static QString osName();
/**
* Returns the QGIS platform name, e.g., "desktop" or "server".
* \since QGIS 2.14
* \see osName()
* \since QGIS 2.14
*/
static QString platform();
@ -578,8 +578,8 @@ class CORE_EXPORT QgsApplication : public QApplication
/**
* Returns the application's raster renderer registry, used for managing raster layer renderers.
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
static QgsRasterRendererRegistry *rasterRendererRegistry() SIP_SKIP;
@ -656,8 +656,8 @@ class CORE_EXPORT QgsApplication : public QApplication
/**
* Returns the application's annotation registry, used for managing annotation types.
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
static QgsAnnotationRegistry *annotationRegistry() SIP_SKIP;

2
src/core/qgsattributes.h
View File

@ -113,8 +113,8 @@ class CORE_EXPORT QgsAttributes : public QVector<QVariant>
/**
* Returns a QgsAttributeMap of the attribute values. Null values are
* excluded from the map.
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
QgsAttributeMap toMap() const SIP_SKIP;

4
src/core/qgsbrowsermodel.h
View File

@ -169,15 +169,15 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel
* If \a name is specified, it will be used as the favorite's name. Otherwise
* the name will be set to match \a directory.
*
* \since QGIS 3.0
* \see removeFavorite()
* \since QGIS 3.0
*/
void addFavoriteDirectory( const QString &directory, const QString &name = QString() );
/**
* Removes a favorite directory from its corresponding model index.
* \since QGIS 3.0
* \see addFavoriteDirectory()
* \since QGIS 3.0
*/
void removeFavorite( const QModelIndex &index );

4
src/core/qgscolorscheme.h
View File

@ -248,15 +248,15 @@ class CORE_EXPORT QgsRecentColorScheme : public QgsColorScheme
/**
* Adds a color to the list of recent colors.
* \param color color to add
* \since QGIS 2.14
* \see lastUsedColor()
* \since QGIS 2.14
*/
static void addRecentColor( const QColor &color );
/**
* Returns the most recently used color.
* \since QGIS 3.0
* \see addRecentColor()
* \since QGIS 3.0
*/
static QColor lastUsedColor();
};

8
src/core/qgscoordinatereferencesystem.h
View File

@ -259,8 +259,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* Creates a CRS from a given OGC WMS-format Coordinate Reference System string.
* \param ogcCrs OGR compliant CRS definition, e.g., "EPSG:4326"
* \returns matching CRS, or an invalid CRS if string could not be matched
* \since QGIS 3.0
* \see createFromOgcWmsCrs()
* \since QGIS 3.0
*/
static QgsCoordinateReferenceSystem fromOgcWmsCrs( const QString &ogcCrs );
@ -276,8 +276,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* Creates a CRS from a proj4 style formatted string.
* \param proj4 proj4 format string
* \returns matching CRS, or an invalid CRS if string could not be matched
* \since QGIS 3.0
* \see createFromProj4()
* \since QGIS 3.0
*/
static QgsCoordinateReferenceSystem fromProj4( const QString &proj4 );
@ -285,8 +285,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* Creates a CRS from a WKT spatial ref sys definition string.
* \param wkt WKT for the desired spatial reference system.
* \returns matching CRS, or an invalid CRS if string could not be matched
* \since QGIS 3.0
* \see createFromWkt()
* \since QGIS 3.0
*/
static QgsCoordinateReferenceSystem fromWkt( const QString &wkt );
@ -294,9 +294,9 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* Creates a CRS from a specified QGIS SRS ID.
* \param srsId internal QGIS SRS ID
* \returns matching CRS, or an invalid CRS if ID could not be found
* \since QGIS 3.0
* \see createFromSrsId()
* \see validSrsIds()
* \since QGIS 3.0
*/
static QgsCoordinateReferenceSystem fromSrsId( long srsId );

2
src/core/qgscoordinatetransform.h
View File

@ -68,12 +68,12 @@ class CORE_EXPORT QgsCoordinateTransform
* Constructs a QgsCoordinateTransform using QgsCoordinateReferenceSystem objects.
* \param source source CRS, typically of the layer's coordinate system
* \param destination CRS, typically of the map canvas coordinate system
* \deprecated Use of this constructor is strongly discouraged, as it will not
* correctly handle the user's datum transform setup. Instead the constructor
* variant which accepts a QgsCoordinateTransformContext or QgsProject
* argument should be used instead. It is highly likely that this constructor
* will be removed in future QGIS versions.
* \note Not available in Python bindings.
* \deprecated Use of this constructor is strongly discouraged, as it will not
*/
Q_DECL_DEPRECATED explicit QgsCoordinateTransform( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) SIP_SKIP;

2
src/core/qgsdataprovider.h
View File

@ -505,9 +505,9 @@ class CORE_EXPORT QgsDataProvider : public QObject
*
* The base implementation returns true if lastRenderingTimeMs <= maxRenderingTimeMs.
*
* \since QGIS 3.0
*
* \note not available in Python bindings
* \since QGIS 3.0
*/
virtual bool renderInPreview( const QgsDataProvider::PreviewContext &context ); // SIP_SKIP

12
src/core/qgsdiagramrenderer.h
View File

@ -227,8 +227,8 @@ class CORE_EXPORT QgsDiagramLayerSettings
/**
* Returns the diagram renderer associated with the layer.
* \see setRenderer()
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
const QgsDiagramRenderer *renderer() const { return mRenderer; } SIP_SKIP
@ -300,24 +300,24 @@ class CORE_EXPORT QgsDiagramLayerSettings
/**
* Returns a reference to the diagram's property collection, used for data defined overrides.
* \since QGIS 3.0
* \see setDataDefinedProperties()
* \since QGIS 3.0
*/
QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
/**
* Returns a reference to the diagram's property collection, used for data defined overrides.
* \since QGIS 3.0
* \see setDataDefinedProperties()
* \note not available in Python bindings
* \since QGIS 3.0
*/
const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } SIP_SKIP
/**
* Sets the diagram's property collection, used for data defined overrides.
* \param collection property collection. Existing properties will be replaced.
* \since QGIS 3.0
* \see dataDefinedProperties()
* \since QGIS 3.0
*/
void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
@ -582,16 +582,16 @@ class CORE_EXPORT QgsDiagramRenderer
/**
* Returns true if renderer will show legend items for diagram attributes.
* \since QGIS 2.16
* \see setAttributeLegend()
* \since QGIS 2.16
*/
bool attributeLegend() const { return mShowAttributeLegend; }
/**
* Sets whether the renderer will show legend items for diagram attributes.
* \param enabled set to true to show diagram attribute legend
* \since QGIS 2.16
* \see attributeLegend()
* \since QGIS 2.16
*/
void setAttributeLegend( bool enabled ) { mShowAttributeLegend = enabled; }

16
src/core/qgsdistancearea.h
View File

@ -56,15 +56,15 @@ class CORE_EXPORT QgsDistanceArea
/**
* Returns whether calculations will use the ellipsoid. Calculations will only use the
* ellipsoid if a valid ellipsoid() has been set.
* \since QGIS 2.14
* \see ellipsoid()
* \since QGIS 2.14
*/
bool willUseEllipsoid() const;
/**
* Sets source spatial reference system \a crs.
* \since QGIS 2.2
* \see sourceCrs()
* \since QGIS 2.2
*/
void setSourceCrs( const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context );
@ -131,10 +131,10 @@ class CORE_EXPORT QgsDistanceArea
* \param geometry geometry to measure
* \returns area of geometry. For geometry collections, non surface geometries will be ignored. The units for the
* returned area can be retrieved by calling areaUnits().
* \since QGIS 2.12
* \see measureLength()
* \see measurePerimeter()
* \see areaUnits()
* \since QGIS 2.12
*/
double measureArea( const QgsGeometry &geometry ) const;
@ -143,10 +143,10 @@ class CORE_EXPORT QgsDistanceArea
* \param geometry geometry to measure
* \returns length of geometry. For geometry collections, non curve geometries will be ignored. The units for the
* returned distance can be retrieved by calling lengthUnits().
* \since QGIS 2.12
* \see lengthUnits()
* \see measureArea()
* \see measurePerimeter()
* \since QGIS 2.12
*/
double measureLength( const QgsGeometry &geometry ) const;
@ -155,10 +155,10 @@ class CORE_EXPORT QgsDistanceArea
* \param geometry geometry to measure
* \returns perimeter of geometry. For geometry collections, any non-polygon geometries will be ignored. The units for the
* returned perimeter can be retrieved by calling lengthUnits().
* \since QGIS 2.12
* \see lengthUnits()
* \see measureArea()
* \see measurePerimeter()
* \since QGIS 2.12
*/
double measurePerimeter( const QgsGeometry &geometry ) const;
@ -204,8 +204,8 @@ class CORE_EXPORT QgsDistanceArea
/**
* Returns the units of area for areal calculations made by this object.
* \since QGIS 2.14
* \see lengthUnits()
* \since QGIS 2.14
*/
QgsUnitTypes::AreaUnit areaUnits() const;
@ -227,8 +227,8 @@ class CORE_EXPORT QgsDistanceArea
* \param keepBaseUnit set to false to allow conversion of large distances to more suitable units, e.g., meters to
* kilometers
* \returns formatted distance string
* \since QGIS 2.16
* \see formatArea()
* \since QGIS 2.16
*/
static QString formatDistance( double distance, int decimals, QgsUnitTypes::DistanceUnit unit, bool keepBaseUnit = false );
@ -240,8 +240,8 @@ class CORE_EXPORT QgsDistanceArea
* \param keepBaseUnit set to false to allow conversion of large areas to more suitable units, e.g., square meters to
* square kilometers
* \returns formatted area string
* \since QGIS 2.14
* \see formatDistance()
* \since QGIS 2.14
*/
static QString formatArea( double area, int decimals, QgsUnitTypes::AreaUnit unit, bool keepBaseUnit = false );

10
src/core/qgsexpressioncontext.h
View File

@ -312,8 +312,8 @@ class CORE_EXPORT QgsExpressionContextScope
/**
* Returns true if the scope has a feature associated with it.
* \since QGIS 3.0
* \see feature()
* \since QGIS 3.0
*/
bool hasFeature() const { return mHasFeature; }
@ -336,9 +336,9 @@ class CORE_EXPORT QgsExpressionContextScope
/**
* Removes any feature associated with the scope.
* \since QGIS 3.0
* \see setFeature()
* \see hasFeature()
* \since QGIS 3.0
*/
void removeFeature() { mHasFeature = false; mFeature = QgsFeature(); }
@ -588,8 +588,8 @@ class CORE_EXPORT QgsExpressionContext
* any context.
* Ownership is transferred to the caller.
*
* \since QGIS 3.0
* \note Not available in Python
* \since QGIS 3.0
*/
QList<QgsExpressionContextScope *> takeScopes() SIP_SKIP;
@ -611,8 +611,8 @@ class CORE_EXPORT QgsExpressionContext
/**
* Returns true if the context has a feature associated with it.
* \since QGIS 3.0
* \see feature()
* \since QGIS 3.0
*/
bool hasFeature() const;
@ -912,9 +912,9 @@ class CORE_EXPORT QgsExpressionContextUtils
/**
* Creates a new scope which contains variables and functions relating to a QgsLayoutItem.
* For instance, item size and position.
* \since QGIS 3.0
* \see setLayoutItemVariable()
* \see setLayoutItemVariables()
* \since QGIS 3.0
*/
static QgsExpressionContextScope *layoutItemScope( const QgsLayoutItem *item ) SIP_FACTORY;

4
src/core/qgsfeature.h
View File

@ -238,8 +238,8 @@ class CORE_EXPORT QgsFeature
* Returns the feature's attributes.
* \returns list of feature's attributes
* \see setAttributes
* \since QGIS 2.9
* \note Alternatively in Python: iterate feature, eg. @code [attr for attr in feature] @endcode
* \since QGIS 2.9
*/
QgsAttributes attributes() const;
@ -366,8 +366,8 @@ class CORE_EXPORT QgsFeature
* \param initAttributes If true, attributes are initialized. Clears any data previously assigned.
* C++: Defaults to false
* Python: Defaults to true
* \since QGIS 2.9
* \see fields
* \since QGIS 2.9
*/
void setFields( const QgsFields &fields, bool initAttributes = false SIP_PYARGDEFAULT( true ) );

2
src/core/qgsfeaturefilterprovider.h
View File

@ -35,7 +35,7 @@ class QgsFeatureRequest;
* A QgsFeatureFilterProvider provides a method for modifying a QgsFeatureRequest in place to apply
* additional filters to the request.
* \since QGIS 2.14
**/
*/
class CORE_EXPORT QgsFeatureFilterProvider
{

4
src/core/qgsfeatureiterator.h
View File

@ -57,8 +57,8 @@ class CORE_EXPORT QgsAbstractFeatureIterator
* nextFeature()/fetchFeature() iteration might be very long. A typical use case is the
* WFS provider. When nextFeature()/fetchFeature() is reasonably fast, it is not necessary
* to implement this method. The default implementation does nothing.
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
virtual void setInterruptionChecker( QgsFeedback *interruptionChecker ) SIP_SKIP;
@ -312,8 +312,8 @@ class CORE_EXPORT QgsFeatureIterator
* if it must stopped. This is mostly useful for iterators where a single
* nextFeature()/fetchFeature() iteration might be very long. A typical use case is the
* WFS provider.
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
void setInterruptionChecker( QgsFeedback *interruptionChecker ) SIP_SKIP;

12
src/core/qgsfeaturerequest.h
View File

@ -354,8 +354,8 @@ class CORE_EXPORT QgsFeatureRequest
* Sets a callback function to use when encountering an invalid geometry and
* invalidGeometryCheck() is set to GeometryAbortOnInvalid or GeometrySkipInvalid. This function will be
* called using the feature with invalid geometry as a parameter.
* \since QGIS 3.0
* \see invalidGeometryCallback()
* \since QGIS 3.0
*/
#ifndef SIP_RUN
QgsFeatureRequest &setInvalidGeometryCallback( const std::function< void( const QgsFeature & )> &callback );
@ -380,9 +380,9 @@ class CORE_EXPORT QgsFeatureRequest
/**
* Returns the callback function to use when encountering an invalid geometry and
* invalidGeometryCheck() is set to GeometryAbortOnInvalid or GeometrySkipInvalid.
* \since QGIS 3.0
* \note not available in Python bindings
* \see setInvalidGeometryCallback()
* \since QGIS 3.0
*/
std::function< void( const QgsFeature & ) > invalidGeometryCallback() const { return mInvalidGeometryCallback; } SIP_SKIP
@ -411,17 +411,17 @@ class CORE_EXPORT QgsFeatureRequest
/**
* Returns the expression context used to evaluate filter expressions.
* \since QGIS 2.12
* \see setExpressionContext
* \see filterExpression
* \since QGIS 2.12
*/
QgsExpressionContext *expressionContext() { return &mExpressionContext; }
/**
* Sets the expression context used to evaluate filter expressions.
* \since QGIS 2.12
* \see expressionContext
* \see setFilterExpression
* \since QGIS 2.12
*/
QgsFeatureRequest &setExpressionContext( const QgsExpressionContext &context );
@ -570,9 +570,9 @@ class CORE_EXPORT QgsFeatureRequest
* Sets a callback function to use when encountering a transform error when iterating
* features and a destinationCrs() is set. This function will be
* called using the feature which encountered the transform error as a parameter.
* \since QGIS 3.0
* \see transformErrorCallback()
* \see setDestinationCrs()
* \since QGIS 3.0
*/
#ifndef SIP_RUN
QgsFeatureRequest &setTransformErrorCallback( const std::function< void( const QgsFeature & )> &callback );
@ -597,10 +597,10 @@ class CORE_EXPORT QgsFeatureRequest
/**
* Returns the callback function to use when encountering a transform error when iterating
* features and a destinationCrs() is set.
* \since QGIS 3.0
* \note not available in Python bindings
* \see setTransformErrorCallback()
* \see destinationCrs()
* \since QGIS 3.0
*/
std::function< void( const QgsFeature & ) > transformErrorCallback() const { return mTransformErrorCallback; } SIP_SKIP

2
src/core/qgsfeedback.h
View File

@ -98,9 +98,9 @@ class CORE_EXPORT QgsFeedback : public QObject
* Emitted when the feedback object reports a progress change. Depending on how the
* feedback object is used progress reporting may not be supported. The \a progress
* argument is in percentage and ranges from 0-100.
* \since QGIS 3.0
* \see setProgress()
* \see progress()
* \since QGIS 3.0
*/
void progressChanged( double progress );

8
src/core/qgsfield.h
View File

@ -205,8 +205,8 @@ class CORE_EXPORT QgsField
* Returns the expression used when calculating the default value for the field.
* \returns expression evaluated when calculating default values for field, or an
* empty string if no default is set
* \since QGIS 3.0
* \see setDefaultValueDefinition()
* \since QGIS 3.0
*/
QgsDefaultValue defaultValueDefinition() const;
@ -214,22 +214,22 @@ class CORE_EXPORT QgsField
* Sets an expression to use when calculating the default value for the field.
* \param defaultValueDefinition expression to evaluate when calculating default values for field. Pass
* a default constructed QgsDefaultValue() to reset.
* \since QGIS 3.0
* \see defaultValueDefinition()
* \since QGIS 3.0
*/
void setDefaultValueDefinition( const QgsDefaultValue &defaultValueDefinition );
/**
* Returns constraints which are present for the field.
* \since QGIS 3.0
* \see setConstraints()
* \since QGIS 3.0
*/
const QgsFieldConstraints &constraints() const;
/**
* Sets constraints which are present for the field.
* \since QGIS 3.0
* \see constraints()
* \since QGIS 3.0
*/
void setConstraints( const QgsFieldConstraints &constraints );

12
src/core/qgsfields.h
View File

@ -428,40 +428,40 @@ class CORE_EXPORT QgsFields
/**
* Returns a const STL-style iterator pointing to the first item in the list.
*
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
const_iterator constBegin() const noexcept;
/**
* Returns a const STL-style iterator pointing to the imaginary item after the last item in the list.
*
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
const_iterator constEnd() const noexcept;
/**
* Returns a const STL-style iterator pointing to the first item in the list.
*
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
const_iterator begin() const noexcept;
/**
* Returns a const STL-style iterator pointing to the imaginary item after the last item in the list.
*
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
const_iterator end() const noexcept;
/**
* Returns an STL-style iterator pointing to the first item in the list.
*
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
iterator begin();
@ -469,8 +469,8 @@ class CORE_EXPORT QgsFields
/**
* Returns an STL-style iterator pointing to the imaginary item after the last item in the list.
*
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
iterator end();

12
src/core/qgsfontutils.h
View File

@ -105,8 +105,8 @@ class CORE_EXPORT QgsFontUtils
* \param document DOM document
* \param elementName name for DOM element
* \returns DOM element containing font settings
* \since QGIS 2.10
* \see setFromXmlElement
* \since QGIS 2.10
*/
static QDomElement toXmlElement( const QFont &font, QDomDocument &document, const QString &elementName );
@ -116,9 +116,9 @@ class CORE_EXPORT QgsFontUtils
* \param font font to update
* \param element DOM element
* \returns true if properties were successfully read from element
* \since QGIS 2.10
* \see toXmlElement
* \see setFromXmlChildNode
* \since QGIS 2.10
*/
static bool setFromXmlElement( QFont &font, const QDomElement &element );
@ -129,9 +129,9 @@ class CORE_EXPORT QgsFontUtils
* \param element DOM element
* \param childNode name of child node
* \returns true if child node exists and properties were successfully read from node
* \since QGIS 2.10
* \see setFromXmlElement
* \see toXmlElement
* \since QGIS 2.10
*/
static bool setFromXmlChildNode( QFont &font, const QDomElement &element, const QString &childNode );
@ -155,8 +155,8 @@ class CORE_EXPORT QgsFontUtils
* Returns the localized named style of a font, if such a translation is available.
* \param namedStyle a named style, i.e. "Bold", "Italic", etc
* \returns The localized named style
* \since QGIS 2.12
* \see untranslateNamedStyle
* \since QGIS 2.12
*/
static QString translateNamedStyle( const QString &namedStyle );
@ -164,8 +164,8 @@ class CORE_EXPORT QgsFontUtils
* Returns the english named style of a font, if possible.
* \param namedStyle a localized named style, i.e. "Fett", "Kursiv", etc
* \returns The english named style
* \since QGIS 2.12
* \see translateNamedStyle
* \since QGIS 2.12
*/
static QString untranslateNamedStyle( const QString &namedStyle );
@ -183,8 +183,8 @@ class CORE_EXPORT QgsFontUtils
/**
* Adds a font \a family to the list of recently used font families.
* \since QGIS 3.0
* \see recentFontFamilies()
* \since QGIS 3.0
*/
static void addRecentFontFamily( const QString &family );

8
src/core/qgsinterval.h
View File

@ -202,8 +202,8 @@ Q_DECLARE_METATYPE( QgsInterval )
* Returns the interval between two datetimes.
* \param datetime1 start datetime
* \param datetime2 datetime to subtract, ie subtract datetime2 from datetime1
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
QgsInterval CORE_EXPORT operator-( const QDateTime &datetime1, const QDateTime &datetime2 );
@ -211,8 +211,8 @@ QgsInterval CORE_EXPORT operator-( const QDateTime &datetime1, const QDateTime &
* Returns the interval between two dates.
* \param date1 start date
* \param date2 date to subtract, ie subtract date2 from date1
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
QgsInterval CORE_EXPORT operator-( QDate date1, QDate date2 );
@ -220,8 +220,8 @@ QgsInterval CORE_EXPORT operator-( QDate date1, QDate date2 );
* Returns the interval between two times.
* \param time1 start time
* \param time2 time to subtract, ie subtract time2 from time1
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
QgsInterval CORE_EXPORT operator-( QTime time1, QTime time2 );
@ -229,8 +229,8 @@ QgsInterval CORE_EXPORT operator-( QTime time1, QTime time2 );
* Adds an interval to a datetime
* \param start initial datetime
* \param interval interval to add
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
QDateTime CORE_EXPORT operator+( const QDateTime &start, const QgsInterval &interval );

10
src/core/qgslabelfeature.h
View File

@ -47,8 +47,8 @@ class QgsGeometry;
* more data to the instances that will be later used for drawing of labels.
*
* \note this class is not a part of public API yet. See notes in QgsLabelingEngine
* \since QGIS 2.12
* \note not available in Python bindings
* \since QGIS 2.12
*/
class CORE_EXPORT QgsLabelFeature
{
@ -71,15 +71,15 @@ class CORE_EXPORT QgsLabelFeature
* buffer around a point geometry to prevent labels being placed too close to the
* point itself. It not set, the feature's geometry is used for obstacle detection.
* Ownership of obstacle geometry is transferred.
* \since QGIS 2.14
* \see obstacleGeometry()
* \since QGIS 2.14
*/
void setObstacleGeometry( geos::unique_ptr obstacleGeom );
/**
* Returns the label's obstacle geometry, if different to the feature geometry.
* \since QGIS 2.14
* \see setObstacleGeometry()
* \since QGIS 2.14
*/
GEOSGeometry *obstacleGeometry() const { return mObstacleGeometry.get(); }
@ -89,8 +89,8 @@ class CORE_EXPORT QgsLabelFeature
* are not contained within the zone.
* \param geometry permissible zone geometry. If an invalid QgsGeometry is passed then no zone limit
* will be applied to the label candidates (this is the default behavior).
* \since QGIS 3.0
* \see permissibleZone()
* \since QGIS 3.0
*/
void setPermissibleZone( const QgsGeometry &geometry );
@ -98,9 +98,9 @@ class CORE_EXPORT QgsLabelFeature
* Returns the label's permissible zone geometry. If a valid geometry is returned, the feature's label
* MUST be fully contained within this zone, and the feature will not be labeled if no candidates can be
* generated which are not contained within the zone.
* \since QGIS 3.0
* \see setPermissibleZone()
* \see permissibleZonePrepared()
* \since QGIS 3.0
*/
QgsGeometry permissibleZone() const { return mPermissibleZone; }

4
src/core/qgslabelingengine.h
View File

@ -164,8 +164,8 @@ Q_DECLARE_OPERATORS_FOR_FLAGS( QgsAbstractLabelProvider::Flags )
* (equivalent of pal::Layer) instead of subProviders(), label providers integrated
* into feature loop vs providers with independent feature loop), split labeling
* computation from drawing of labels, improved results class with label iterator).
* \since QGIS 2.12
* \note not available in Python bindings
* \since QGIS 2.12
*/
class CORE_EXPORT QgsLabelingEngine
{
@ -231,8 +231,8 @@ class CORE_EXPORT QgsLabelingEngine
* \class QgsLabelingUtils
* \brief Contains helper utilities for working with QGIS' labeling engine.
* \note this class is not a part of public API yet. See notes in QgsLabelingEngine
* \since QGIS 2.14
* \note not available in Python bindings
* \since QGIS 2.14
*/
class CORE_EXPORT QgsLabelingUtils

6
src/core/qgsmaphittest.h
View File

@ -57,8 +57,8 @@ class CORE_EXPORT QgsMapHitTest
* Tests whether a symbol is visible for a specified layer.
* \param symbol symbol to find
* \param layer vector layer
* \since QGIS 2.12
* \see legendKeyVisible()
* \since QGIS 2.12
*/
bool symbolVisible( QgsSymbol *symbol, QgsVectorLayer *layer ) const;
@ -66,8 +66,8 @@ class CORE_EXPORT QgsMapHitTest
* Tests whether a given legend key is visible for a specified layer.
* \param ruleKey legend rule key
* \param layer vector layer
* \since QGIS 2.14
* \see symbolVisible()
* \since QGIS 2.14
*/
bool legendKeyVisible( const QString &ruleKey, QgsVectorLayer *layer ) const;
@ -85,8 +85,8 @@ class CORE_EXPORT QgsMapHitTest
* \param usedSymbols set for storage of visible symbols
* \param usedSymbolsRuleKey set of storage of visible legend rule keys
* \param context render context
* \since QGIS 2.12
* \note not available in Python bindings
* \since QGIS 2.12
*/
void runHitTestLayer( QgsVectorLayer *vl, SymbolSet &usedSymbols, SymbolSet &usedSymbolsRuleKey, QgsRenderContext &context );

26
src/core/qgsmaplayer.h
View File

@ -157,8 +157,8 @@ class CORE_EXPORT QgsMapLayer : public QObject
/**
* Set the display \a name of the layer.
* \since QGIS 2.16
* \see name()
* \since QGIS 2.16
*/
void setName( const QString &name );
@ -780,8 +780,8 @@ class CORE_EXPORT QgsMapLayer : public QObject
* \param errorMessage reference to string that will be updated with any error messages
* \param context reading context (used for transform from relative to absolute paths)
* \returns true in case of success.
* \since QGIS 2.16
* \note To be implemented in subclasses. Default implementation does nothing and returns false.
* \since QGIS 2.16
*/
virtual bool readStyle( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context );
@ -802,8 +802,8 @@ class CORE_EXPORT QgsMapLayer : public QObject
* \param errorMessage reference to string that will be updated with any error messages
* \param context writing context (used for transform from absolute to relative paths)
* \returns true in case of success.
* \since QGIS 2.16
* \note To be implemented in subclasses. Default implementation does nothing and returns false.
* \since QGIS 2.16
*/
virtual bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context ) const;
@ -871,10 +871,10 @@ class CORE_EXPORT QgsMapLayer : public QObject
* Tests whether the layer should be visible at the specified \a scale.
* The \a scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* \returns true if the layer is visible at the given scale.
* \since QGIS 2.16
* \see minimumScale()
* \see maximumScale()
* \see hasScaleBasedVisibility()
* \since QGIS 2.16
*/
bool isInScaleRange( double scale ) const;
@ -914,18 +914,18 @@ class CORE_EXPORT QgsMapLayer : public QObject
/**
* Returns true if auto refresh is enabled for the layer.
* \since QGIS 3.0
* \see autoRefreshInterval()
* \see setAutoRefreshEnabled()
* \since QGIS 3.0
*/
bool hasAutoRefreshEnabled() const;
/**
* Returns the auto refresh interval (in milliseconds). Note that
* auto refresh is only active when hasAutoRefreshEnabled() is true.
* \since QGIS 3.0
* \see hasAutoRefreshEnabled()
* \see setAutoRefreshInterval()
* \since QGIS 3.0
*/
int autoRefreshInterval() const;
@ -936,33 +936,33 @@ class CORE_EXPORT QgsMapLayer : public QObject
*
* Note that auto refresh triggers deferred repaints of the layer. Any map
* canvas must be refreshed separately in order to view the refreshed layer.
* \since QGIS 3.0
* \see autoRefreshInterval()
* \see setAutoRefreshEnabled()
* \since QGIS 3.0
*/
void setAutoRefreshInterval( int interval );
/**
* Sets whether auto refresh is enabled for the layer.
* \since QGIS 3.0
* \see hasAutoRefreshEnabled()
* \see setAutoRefreshInterval()
* \since QGIS 3.0
*/
void setAutoRefreshEnabled( bool enabled );
/**
* Returns a reference to the layer's metadata store.
* \since QGIS 3.0
* \see setMetadata()
* \see metadataChanged()
* \since QGIS 3.0
*/
virtual const QgsLayerMetadata &metadata() const;
/**
* Sets the layer's \a metadata store.
* \since QGIS 3.0
* \see metadata()
* \see metadataChanged()
* \since QGIS 3.0
*/
virtual void setMetadata( const QgsLayerMetadata &metadata );
@ -1115,8 +1115,8 @@ class CORE_EXPORT QgsMapLayer : public QObject
* Signal emitted whenever a change affects the layer's style. Ie this may be triggered
* by renderer changes, label style changes, or other style changes such as blend
* mode or layer opacity changes.
* \since QGIS 2.16
* \see rendererChanged()
* \since QGIS 2.16
*/
void styleChanged();
@ -1379,15 +1379,15 @@ Q_DECLARE_METATYPE( QgsMapLayer * )
/**
* Weak pointer for QgsMapLayer
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
typedef QPointer< QgsMapLayer > QgsWeakMapLayerPointer;
/**
* A list of weak pointers to QgsMapLayers.
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
typedef QList< QgsWeakMapLayerPointer > QgsWeakMapLayerPointerList;
#endif

2
src/core/qgsmaplayermodel.h
View File

@ -116,8 +116,8 @@ class CORE_EXPORT QgsMapLayerModel : public QAbstractItemModel
/**
* Returns the map layer corresponding to the specified \a index.
* \since QGIS 3.0
* \see indexFromLayer()
* \since QGIS 3.0
*/
QgsMapLayer *layerFromIndex( const QModelIndex &index ) const;

2
src/core/qgsmaplayerproxymodel.h
View File

@ -86,8 +86,8 @@ class CORE_EXPORT QgsMapLayerProxyModel : public QSortFilterProxyModel
/**
* Sets a list of data providers which should be excluded from the model.
* \since QGIS 3.0
* \see excludedProviders()
* \since QGIS 3.0
*/
void setExcludedProviders( const QStringList &providers );

2
src/core/qgsmaprenderercache.h
View File

@ -71,8 +71,8 @@ class CORE_EXPORT QgsMapRendererCache : public QObject
/**
* Returns true if the cache contains an image with the specified \a cacheKey.
* \since QGIS 3.0
* \see cacheImage()
* \since QGIS 3.0
*/
bool hasCacheImage( const QString &cacheKey ) const;

6
src/core/qgsmaprendererjob.h
View File

@ -161,18 +161,18 @@ class CORE_EXPORT QgsMapRendererJob : public QObject
virtual QgsLabelingResults *takeLabelingResults() = 0 SIP_TRANSFER;
/**
* \since QGIS 3.0
* Set the feature filter provider used by the QgsRenderContext of
* each LayerRenderJob.
* Ownership is not transferred and the provider must not be deleted
* before the render job.
* \since QGIS 3.0
*/
void setFeatureFilterProvider( const QgsFeatureFilterProvider *f ) { mFeatureFilterProvider = f; }
/**
* \since QGIS 3.0
* Returns the feature filter provider used by the QgsRenderContext of
* each LayerRenderJob.
* \since QGIS 3.0
*/
const QgsFeatureFilterProvider *featureFilterProvider() const { return mFeatureFilterProvider; }
@ -281,8 +281,8 @@ class CORE_EXPORT QgsMapRendererJob : public QObject
/**
* Handles clean up tasks for a label job, including deletion of images and storing cached
* label results.
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
void cleanupLabelJob( LabelRenderJob &job ) SIP_SKIP;

24
src/core/qgsmapsettings.h
View File

@ -83,15 +83,15 @@ class CORE_EXPORT QgsMapSettings
/**
* Returns the rotation of the resulting map image, in degrees clockwise.
* \since QGIS 2.8
* \see setRotation()
* \since QGIS 2.8
*/
double rotation() const;
/**
* Sets the \a rotation of the resulting map image, in degrees clockwise.
* \since QGIS 2.8
* \see rotation()
* \since QGIS 2.8
*/
void setRotation( double rotation );
@ -106,15 +106,15 @@ class CORE_EXPORT QgsMapSettings
/**
* Set the magnification factor.
* \param factor the factor of magnification
* \since QGIS 2.16
* \see magnificationFactor()
* \since QGIS 2.16
*/
void setMagnificationFactor( double factor );
/**
* Returns the magnification factor.
* \since QGIS 2.16
* \see setMagnificationFactor()
* \since QGIS 2.16
*/
double magnificationFactor() const;
@ -153,16 +153,16 @@ class CORE_EXPORT QgsMapSettings
/**
* Gets custom rendering flags. Layers might honour these to alter their rendering.
* \returns custom flags strings, separated by ';'
* \since QGIS 2.16
* \see setCustomRenderFlags()
* \since QGIS 2.16
*/
QString customRenderFlags() const { return mCustomRenderFlags; }
/**
* Sets the custom rendering flags. Layers might honour these to alter their rendering.
* \param customRenderFlags custom flags strings, separated by ';'
* \since QGIS 2.16
* \see customRenderFlags()
* \since QGIS 2.16
*/
void setCustomRenderFlags( const QString &customRenderFlags ) { mCustomRenderFlags = customRenderFlags; }
@ -179,16 +179,16 @@ class CORE_EXPORT QgsMapSettings
* retrieved using QgsEllipsoidUtils::acronyms().
* Calculations will only use the ellipsoid if a valid ellipsoid has been set.
* \returns true if ellipsoid was successfully set
* \since QGIS 3.0
* \see ellipsoid()
* \since QGIS 3.0
*/
bool setEllipsoid( const QString &ellipsoid );
/**
* Returns ellipsoid's acronym. Calculations will only use the
* ellipsoid if a valid ellipsoid has been set.
* \since QGIS 3.0
* \see setEllipsoid()
* \since QGIS 3.0
*/
QString ellipsoid() const { return mEllipsoid; }
@ -274,8 +274,8 @@ class CORE_EXPORT QgsMapSettings
* information regarding which datum transforms should be used when transforming points
* from a source to destination coordinate reference system.
*
* \since QGIS 3.0
* \see setTransformContext()
* \since QGIS 3.0
*/
QgsCoordinateTransformContext transformContext() const;
@ -284,8 +284,8 @@ class CORE_EXPORT QgsMapSettings
* information regarding which datum transforms should be used when transforming points
* from a source to destination coordinate reference system.
*
* \since QGIS 3.0
* \see transformContext()
* \since QGIS 3.0
*/
void setTransformContext( const QgsCoordinateTransformContext &context );
@ -293,8 +293,8 @@ class CORE_EXPORT QgsMapSettings
* Returns the path resolver for conversion between relative and absolute paths
* during rendering operations, e.g. for resolving relative symbol paths.
*
* \since QGIS 3.0
* \see setPathResolver()
* \since QGIS 3.0
*/
const QgsPathResolver &pathResolver() const { return mPathResolver; }
@ -302,8 +302,8 @@ class CORE_EXPORT QgsMapSettings
* Sets the path \a resolver for conversion between relative and absolute paths
* during rendering operations, e.g. for resolving relative symbol paths.
*
* \since QGIS 3.0
* \see pathResolver()
* \since QGIS 3.0
*/
void setPathResolver( const QgsPathResolver &resolver ) { mPathResolver = resolver; }

4
src/core/qgsmapthemecollection.h
View File

@ -301,8 +301,8 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject
/**
* Returns the master layer order (this will always match the project's QgsProject::layerOrder() ).
* All map themes will maintain the same layer order as the master layer order.
* \since QGIS 3.0
* \see masterVisibleLayers()
* \since QGIS 3.0
*/
QList< QgsMapLayer * > masterLayerOrder() const;
@ -310,8 +310,8 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject
* Returns the master list of visible layers. The order of returned layers will always match those
* of masterLayerOrder(), but the returned layers are filtered to only include those visible
* in the project's layer tree.
* \since QGIS 3.0
* \see masterLayerOrder()
* \since QGIS 3.0
*/
QList< QgsMapLayer * > masterVisibleLayers() const;

2
src/core/qgsnetworkaccessmanager.h
View File

@ -31,7 +31,6 @@
* \class QgsNetworkAccessManager
* \brief network access manager for QGIS
* \ingroup core
* \since 1.5
*
* This class implements the QGIS network access manager. It's a singleton
* that can be used across QGIS.
@ -43,6 +42,7 @@
* fallback proxy can be set. There's also a exclude list that defines URLs
* that the fallback proxy should not be used for, then no proxy will be used.
*
* \since 1.5
*/
class CORE_EXPORT QgsNetworkAccessManager : public QNetworkAccessManager
{

2
src/core/qgsnetworkcontentfetcher.h
View File

@ -31,8 +31,8 @@
* \brief HTTP network content fetcher. A simple method for fetching remote HTTP content
* and converting the content to standard formats. Url redirects are automatically
* handled.
* \since QGIS 2.5
* \see QgsNetworkContentFetcherTask
* \since QGIS 2.5
*/
class CORE_EXPORT QgsNetworkContentFetcher : public QObject
{

6
src/core/qgsogcutils.h
View File

@ -165,8 +165,8 @@ class CORE_EXPORT QgsOgcUtils
* according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT)
* \returns valid \verbatim <Filter> \endverbatim QDomElement on success,
* otherwise null QDomElement
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
static QDomElement expressionToOgcFilter( const QgsExpression &exp,
QDomDocument &doc,
@ -205,8 +205,8 @@ class CORE_EXPORT QgsOgcUtils
/**
* \ingroup core
* Layer properties. Used by SQLStatementToOgcFilter().
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
class LayerProperties
{
@ -238,8 +238,8 @@ class CORE_EXPORT QgsOgcUtils
* custom functions
* \returns valid \verbatim <Filter> \endverbatim QDomElement on success,
* otherwise null QDomElement
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
static QDomElement SQLStatementToOgcFilter( const QgsSQLStatement &statement,
QDomDocument &doc,

2
src/core/qgsogrutils.h
View File

@ -155,8 +155,8 @@ namespace gdal
* \brief Utilities for working with OGR features and layers
*
* Contains helper utilities for assisting work with both OGR features and layers.
* \since QGIS 2.16
* \note not available in Python bindings
* \since QGIS 2.16
*/
class CORE_EXPORT QgsOgrUtils
{

6
src/core/qgspallabeling.h
View File

@ -763,24 +763,24 @@ class CORE_EXPORT QgsPalLayerSettings
/**
* Returns a reference to the label's property collection, used for data defined overrides.
* \since QGIS 3.0
* \see setDataDefinedProperties()
* \since QGIS 3.0
*/
QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
/**
* Returns a reference to the label's property collection, used for data defined overrides.
* \since QGIS 3.0
* \see setDataDefinedProperties()
* \note not available in Python bindings
* \since QGIS 3.0
*/
const QgsPropertyCollection &dataDefinedProperties() const SIP_SKIP { return mDataDefinedProperties; }
/**
* Sets the label's property collection, used for data defined overrides.
* \param collection property collection. Existing properties will be replaced.
* \since QGIS 3.0
* \see dataDefinedProperties()
* \since QGIS 3.0
*/
void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }

44
src/core/qgsproject.h
View File

@ -112,11 +112,11 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
/**
* Sets the project's title.
* \param title new title
* \since QGIS 2.4
*
* \note Since QGIS 3.2 this is just a shortcut to setting the title in the project's metadata().
*
* \see title()
* \since QGIS 2.4
*/
void setTitle( const QString &title );
@ -191,17 +191,17 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
/**
* Returns the project's native coordinate reference system.
* \since QGIS 3.0
* \see setCrs()
* \see ellipsoid()
* \since QGIS 3.0
*/
QgsCoordinateReferenceSystem crs() const;
/**
* Sets the project's native coordinate reference system.
* \since QGIS 3.0
* \see crs()
* \see setEllipsoid()
* \since QGIS 3.0
*/
void setCrs( const QgsCoordinateReferenceSystem &crs );
@ -227,9 +227,9 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
* information regarding which datum transforms should be used when transforming points
* from a source to destination coordinate reference system.
*
* \since QGIS 3.0
* \see setTransformContext()
* \see transformContextChanged()
* \since QGIS 3.0
*/
QgsCoordinateTransformContext transformContext() const;
@ -238,9 +238,9 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
* information regarding which datum transforms should be used when transforming points
* from a source to destination coordinate reference system.
*
* \since QGIS 3.0
* \see transformContext()
* \see transformContextChanged()
* \since QGIS 3.0
*/
void setTransformContext( const QgsCoordinateTransformContext &context );
@ -434,32 +434,32 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
/**
* Convenience function to query default distance measurement units for project.
* \since QGIS 2.14
* \see setDistanceUnits()
* \see areaUnits()
* \since QGIS 2.14
*/
QgsUnitTypes::DistanceUnit distanceUnits() const;
/**
* Sets the default distance measurement units for the project.
* \since QGIS 3.0
* \see distanceUnits()
* \see setAreaUnits()
* \since QGIS 3.0
*/
void setDistanceUnits( QgsUnitTypes::DistanceUnit unit );
/**
* Convenience function to query default area measurement units for project.
* \since QGIS 2.14
* \see distanceUnits()
* \since QGIS 2.14
*/
QgsUnitTypes::AreaUnit areaUnits() const;
/**
* Sets the default area measurement units for the project.
* \since QGIS 3.0
* \see areaUnits()
* \see setDistanceUnits()
* \since QGIS 3.0
*/
void setAreaUnits( QgsUnitTypes::AreaUnit unit );
@ -496,8 +496,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
/**
* Returns the project's layout manager, which manages compositions within
* the project.
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
const QgsLayoutManager *layoutManager() const SIP_SKIP;
@ -522,8 +522,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
/**
* Returns pointer to the project's map theme collection.
* \since QGIS 2.12
* \note renamed in QGIS 3.0, formerly QgsVisibilityPresetCollection
* \since QGIS 2.12
*/
QgsMapThemeCollection *mapThemeCollection();
@ -579,8 +579,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
*
* QPair( providerKey, connString ) -> transactionGroup
*
* \since QGIS 2.16
* \note Not available in Python bindings
* \since QGIS 2.16
*/
QMap< QPair< QString, QString>, QgsTransactionGroup *> transactionGroups() SIP_SKIP;
@ -707,8 +707,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
* QVector<QgsVectorLayer*> vectorLayers = QgsProject::instance()->layers<QgsVectorLayer*>();
*
* \note not available in Python bindings
* \since QGIS 2.16
* \see mapLayers()
* \since QGIS 2.16
*/
template <typename T>
QVector<T> layers() const
@ -739,8 +739,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
* \note As a side-effect QgsProject is made dirty.
* \note takeOwnership is not available in the Python bindings - the registry will always
* take ownership
* \since QGIS 1.8
* \see addMapLayer()
* \since QGIS 1.8
*/
QList<QgsMapLayer *> addMapLayers( const QList<QgsMapLayer *> &mapLayers SIP_TRANSFER,
bool addToLegend = true,
@ -787,9 +787,9 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
* \param layerIds list of IDs of the layers to remove
*
* \note As a side-effect the QgsProject instance is marked dirty.
* \since QGIS 1.8
* \see removeMapLayer()
* \see removeAllMapLayers()
* \since QGIS 1.8
*/
void removeMapLayers( const QStringList &layerIds );
@ -914,17 +914,17 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
/**
* Returns a reference to the project's metadata store.
* \since QGIS 3.2
* \see setMetadata()
* \see metadataChanged()
* \since QGIS 3.2
*/
const QgsProjectMetadata &metadata() const;
/**
* Sets the project's \a metadata store.
* \since QGIS 3.2
* \see metadata()
* \see metadataChanged()
* \since QGIS 3.2
*/
void setMetadata( const QgsProjectMetadata &metadata );
@ -1030,9 +1030,9 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
/**
* Emitted when the project \a ellipsoid is changed.
*
* \since QGIS 3.0
* \see setEllipsoid()
* \see ellipsoid()
* \since QGIS 3.0
*/
void ellipsoidChanged( const QString &ellipsoid );
@ -1040,8 +1040,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
/**
* Emitted when the project transformContext() is changed.
*
* \since QGIS 3.0
* \see transformContext()
* \since QGIS 3.0
*/
void transformContextChanged();
@ -1205,8 +1205,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
* Emitted when the project dirty status changes.
*
* \param dirty True if the project is in a dirty state and has pending unsaved changes.
* \since QGIS 3.2
*
* \since QGIS 3.2
*/
void isDirtyChanged( bool dirty );
@ -1225,18 +1225,18 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
* Flag the project as dirty (modified). If this flag is set, the user will
* be asked to save changes to the project before closing the current project.
*
* \since QGIS 2.4
* \note promoted to public slot in 2.16
* \since QGIS 2.4
*/
void setDirty( bool b = true );
/**
* Sets the project's home \a path. If an empty path is specified than the
* home path will be automatically determined from the project's file path.
* \since QGIS 3.2
* \see presetHomePath()
* \see homePath()
* \see homePathChanged()
* \since QGIS 3.2
*/
void setPresetHomePath( const QString &path );

2
src/core/qgsprojectproperty.h
View File

@ -198,8 +198,8 @@ class CORE_EXPORT QgsProjectPropertyKey : public QgsProjectProperty
/**
* The name of the property is used as identifier.
*
* \since QGIS 3.0
* \see name()
* \since QGIS 3.0
*/
void setName( const QString &name );

4
src/core/qgsprovidermetadata.h
View File

@ -58,8 +58,8 @@ class CORE_EXPORT QgsProviderMetadata
/**
* Metadata for provider with direct provider creation function pointer, where
* no library is involved.
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
SIP_SKIP QgsProviderMetadata( const QString &key, const QString &description, const QgsProviderMetadata::CreateDataProviderFunction &createFunc );
@ -87,8 +87,8 @@ class CORE_EXPORT QgsProviderMetadata
/**
* Returns a pointer to the direct provider creation function, if supported
* by the provider.
* \since QGIS 3.0
* \note not available in Python bindings
* \since QGIS 3.0
*/
SIP_SKIP CreateDataProviderFunction createFunction() const;

12
src/core/qgsrange.h
View File

@ -34,10 +34,10 @@
* The inclusivity or exclusivity of bounds is considered when determining things like
* whether ranges overlap or during calculation of range intersections.
*
* \since QGIS 3.0
* \see QgsDoubleRange
* \see QgsIntRange
* \note not available in Python bindings (but class provided for template-based inheritance)
* \since QGIS 3.0
*/
template <typename T>
class QgsRange
@ -178,10 +178,10 @@ class QgsRange
/**
* QgsRange which stores a range of double values.
* \since QGIS 3.0
* \see QgsIntRange
* \see QgsDateRange
* \see QgsDateTimeRange
* \since QGIS 3.0
*/
typedef QgsRange< double > QgsDoubleRange;
@ -190,10 +190,10 @@ typedef QgsRange< double > QgsDoubleRange;
/**
* QgsRange which stores a range of integer values.
* \since QGIS 3.0
* \see QgsDoubleRange
* \see QgsDateRange
* \see QgsDateTimeRange
* \since QGIS 3.0
*/
typedef QgsRange< int > QgsIntRange;
@ -210,9 +210,9 @@ typedef QgsRange< int > QgsIntRange;
* The inclusivity or exclusivity of bounds is considered when determining things like
* whether ranges overlap or during calculation of range intersections.
*
* \since QGIS 3.0
* \see QgsDateRange
* \note not available in Python bindings (but class provided for template-based inheritance)
* \since QGIS 3.0
*/
template <typename T>
class QgsTemporalRange
@ -417,8 +417,8 @@ class QgsTemporalRange
* the bound is considered to be infinite. E.g. QgsDateRange(QDate(),QDate(2017,1,1))
* is treated as a range containing all dates before 2017-1-1.
* QgsDateRange(QDate(2017,1,1),QDate()) is treated as a range containing all dates after 2017-1-1.
* \since QGIS 3.0
* \see QgsDateTimeRange
* \since QGIS 3.0
*/
typedef QgsTemporalRange< QDate > QgsDateRange SIP_DOC_TEMPLATE;
@ -429,8 +429,8 @@ typedef QgsTemporalRange< QDate > QgsDateRange SIP_DOC_TEMPLATE;
* the bound is considered to be infinite. E.g. QgsDateTimeRange(QDateTime(),QDateTime(2017,1,1))
* is treated as a range containing all dates before 2017-1-1.
* QgsDateTimeRange(QDateTime(2017,1,1),QDateTime()) is treated as a range containing all dates after 2017-1-1.
* \since QGIS 3.0
* \see QgsDateRange
* \since QGIS 3.0
*/
typedef QgsTemporalRange< QDateTime > QgsDateTimeRange SIP_DOC_TEMPLATE;

2
src/core/qgsrelation.h
View File

@ -185,9 +185,9 @@ class CORE_EXPORT QgsRelation
* which have a foreign key pointing to the provided feature.
* \param feature A feature from the referenced (parent) layer
* \returns expression filter string for all the referencing features
* \since QGIS 2.16
* \see getRelatedFeatures()
* \see getRelatedFeaturesRequest()
* \since QGIS 2.16
*/
QString getRelatedFeaturesFilter( const QgsFeature &feature ) const;

2
src/core/qgsrelationmanager.h
View File

@ -92,8 +92,8 @@ class CORE_EXPORT QgsRelationManager : public QObject
* Returns a list of relations with matching names.
* \param name relation name to search for. Searching is case insensitive.
* \returns a list of matching relations
* \since QGIS 2.16
* \see relation()
* \since QGIS 2.16
*/
QList<QgsRelation> relationsByName( const QString &name ) const;

20
src/core/qgsrendercontext.h
View File

@ -138,8 +138,8 @@ class CORE_EXPORT QgsRenderContext
* information regarding which datum transforms should be used when transforming points
* from a source to destination coordinate reference system.
*
* \since QGIS 3.0
* \see setTransformContext()
* \since QGIS 3.0
*/
QgsCoordinateTransformContext transformContext() const;
@ -148,8 +148,8 @@ class CORE_EXPORT QgsRenderContext
* information regarding which datum transforms should be used when transforming points
* from a source to destination coordinate reference system.
*
* \since QGIS 3.0
* \see transformContext()
* \since QGIS 3.0
*/
void setTransformContext( const QgsCoordinateTransformContext &context );
@ -157,8 +157,8 @@ class CORE_EXPORT QgsRenderContext
* Returns the path resolver for conversion between relative and absolute paths
* during rendering operations, e.g. for resolving relative symbol paths.
*
* \since QGIS 3.0
* \see setPathResolver()
* \since QGIS 3.0
*/
const QgsPathResolver &pathResolver() const { return mPathResolver; }
@ -166,8 +166,8 @@ class CORE_EXPORT QgsRenderContext
* Sets the path \a resolver for conversion between relative and absolute paths
* during rendering operations, e.g. for resolving relative symbol paths.
*
* \since QGIS 3.0
* \see pathResolver()
* \since QGIS 3.0
*/
void setPathResolver( const QgsPathResolver &resolver ) { mPathResolver = resolver; }
@ -313,8 +313,8 @@ class CORE_EXPORT QgsRenderContext
* Gets the expression context (const version). This context should be used for all expression evaluation
* associated with this render context.
* \see setExpressionContext()
* \since QGIS 2.12
* \note not available in Python bindings
* \since QGIS 2.12
*/
const QgsExpressionContext &expressionContext() const { return mExpressionContext; } SIP_SKIP
@ -326,16 +326,16 @@ class CORE_EXPORT QgsRenderContext
/**
* Set a filter feature provider used for additional filtering of rendered features.
* \param ffp the filter feature provider
* \since QGIS 2.14
* \see featureFilterProvider()
* \since QGIS 2.14
*/
void setFeatureFilterProvider( const QgsFeatureFilterProvider *ffp );
/**
* Gets the filter feature provider used for additional filtering of rendered features.
* \returns the filter feature provider
* \since QGIS 2.14
* \see setFeatureFilterProvider()
* \since QGIS 2.14
*/
const QgsFeatureFilterProvider *featureFilterProvider() const;
@ -358,23 +358,23 @@ class CORE_EXPORT QgsRenderContext
/**
* Converts a size from the specified units to painter units (pixels). The conversion respects the limits
* specified by the optional scale parameter.
* \since QGIS 3.0
* \see convertToMapUnits()
* \since QGIS 3.0
*/
double convertToPainterUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale = QgsMapUnitScale() ) const;
/**
* Converts a size from the specified units to map units. The conversion respects the limits
* specified by the optional scale parameter.
* \since QGIS 3.0
* \see convertToPainterUnits()
* \since QGIS 3.0
*/
double convertToMapUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale = QgsMapUnitScale() ) const;
/**
* Converts a size from map units to the specified units.
* \since QGIS 3.0
* \see convertToMapUnits()
* \since QGIS 3.0
*/
double convertFromMapUnits( double sizeInMapUnits, QgsUnitTypes::RenderUnit outputUnit ) const;

2
src/core/qgssqlexpressioncompiler.h
View File

@ -31,9 +31,9 @@ class QgsExpressionNode;
*
* This class is designed to be overridden by providers to take advantage of expression compilation,
* so that feature requests can take advantage of the provider's native filtering support.
* \since QGIS 2.14
* \note Not part of stable API, may change in future versions of QGIS
* \note Not available in Python bindings
* \since QGIS 2.14
*/
class CORE_EXPORT QgsSqlExpressionCompiler

2
src/core/qgssqliteexpressioncompiler.h
View File

@ -29,9 +29,9 @@
* \brief Expression compiler for translation to SQlite SQL WHERE clauses.
*
* This class is designed to be used by SpatiaLite and OGR providers.
* \since QGIS 2.16
* \note Not part of stable API, may change in future versions of QGIS
* \note Not available in Python bindings
* \since QGIS 2.16
*/
class CORE_EXPORT QgsSQLiteExpressionCompiler : public QgsSqlExpressionCompiler

4
src/core/qgstextrenderer.h
View File

@ -1230,8 +1230,8 @@ class CORE_EXPORT QgsTextFormat
* Returns a text format matching the settings from an input \a font.
* Unlike setFont(), this method also handles the size and size units
* from \a font.
* \since QGIS 3.2
* \see toQFont()
* \since QGIS 3.2
*/
static QgsTextFormat fromQFont( const QFont &font );
@ -1239,8 +1239,8 @@ class CORE_EXPORT QgsTextFormat
* Returns a QFont matching the relevant settings from this text format.
* Unlike font(), this method also handles the size and size units
* from the text format.
* \since QGIS 3.2
* \see fromQFont()
* \since QGIS 3.2
*/
QFont toQFont() const;

4
src/core/qgsunittypes.h
View File

@ -364,8 +364,8 @@ class CORE_EXPORT QgsUnitTypes
* \param keepBaseUnit set to false to allow conversion of large distances to more suitable units, e.g., meters to
* kilometers
* \returns formatted distance string
* \since QGIS 3.0
* \see formatArea()
* \since QGIS 3.0
*/
Q_INVOKABLE static QString formatDistance( double distance, int decimals, QgsUnitTypes::DistanceUnit unit, bool keepBaseUnit = false );
@ -377,8 +377,8 @@ class CORE_EXPORT QgsUnitTypes
* \param keepBaseUnit set to false to allow conversion of large areas to more suitable units, e.g., square meters to
* square kilometers
* \returns formatted area string
* \since QGIS 3.0
* \see formatDistance()
* \since QGIS 3.0
*/
Q_INVOKABLE static QString formatArea( double area, int decimals, QgsUnitTypes::AreaUnit unit, bool keepBaseUnit = false );

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