Skip to content

Commit

Permalink
put \since and \deprecated at the end of comment blocks
Browse files Browse the repository at this point in the history
  • Loading branch information
3nids committed May 28, 2018
1 parent 6772f0d commit 0fa85bb
Show file tree
Hide file tree
Showing 186 changed files with 588 additions and 582 deletions.
2 changes: 1 addition & 1 deletion src/3d/processing/qgs3dalgorithms.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
4 changes: 2 additions & 2 deletions src/3d/qgs3dmapsettings.h
Original file line number Diff line number Diff line change
Expand Up @@ -110,17 +110,17 @@ 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; }

/**
* 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; }

Expand Down
2 changes: 1 addition & 1 deletion src/analysis/raster/qgsrastercalcnode.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
6 changes: 3 additions & 3 deletions src/app/qgisapp.h
Original file line number Diff line number Diff line change
Expand Up @@ -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();

Expand Down
5 changes: 3 additions & 2 deletions src/app/qgisappinterface.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions src/app/qgsattributetypedialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -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();

/**
Expand Down
4 changes: 2 additions & 2 deletions src/core/3d/qgs3drendererregistry.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion src/core/auth/qgsauthcrypto.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
8 changes: 4 additions & 4 deletions src/core/dxf/qgsdxfexport.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -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; }

Expand Down
2 changes: 1 addition & 1 deletion src/core/effects/qgsimageoperation.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 );

Expand Down
4 changes: 2 additions & 2 deletions src/core/effects/qgspainteffectregistry.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down Expand Up @@ -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 );

Expand Down
14 changes: 7 additions & 7 deletions src/core/expression/qgsexpression.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 );

Expand Down Expand Up @@ -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 );

Expand Down Expand Up @@ -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 );

Expand All @@ -549,9 +549,9 @@ class CORE_EXPORT QgsExpression
* quotations where required.