Skip to content
Permalink
Browse files
Merge pull request #4321 from m-kuhn/sinceNow
Use \since instead of \note added in
  • Loading branch information
nyalldawson committed Apr 3, 2017
2 parents 106d95b + beb185a commit c8e4e68254444764b9d38cc55b8f7b103bc8a922
Showing 465 changed files with 2,166 additions and 2,162 deletions.
@@ -446,7 +446,7 @@ Setup the coordinate system transformation for the layer

@return The index of the new field

.. versionadded:: 2.6
.. versionadded:: 2.9
%End

void removeExpressionField( int index );
@@ -12,7 +12,7 @@ sub processDoxygenLine
if ( $_[0] =~ m/[\\@](ingroup|class)/ ) {
return ""
}
if ( $_[0] =~ m/[\\@]note added .*?([\d\.]+)/i ) {
if ( $_[0] =~ m/\\since .*?([\d\.]+)/i ) {
return ".. versionadded:: $1\n";
}
if ( $_[0] =~ m/[\\@]note (.*)/ ) {
@@ -37,7 +37,7 @@ class QgsGraphVertex;
/**
* \ingroup analysis
* \class QgsGraphEdge
* \note added in QGIS 3.0
* \since QGIS 3.0
* \brief This class implements a graph edge
*/
class ANALYSIS_EXPORT QgsGraphEdge
@@ -21,7 +21,7 @@

/** \ingroup analysis
* \class QgsNetworkDistanceStrategy
* \note added in QGIS 3.0
* \since QGIS 3.0
* \brief Strategy for caclulating edge cost based on its length. Should be
* used for finding shortest path between two points.
*/
@@ -21,7 +21,7 @@

/** \ingroup analysis
* \class QgsNetworkSpeedStrategy
* \note added in QGIS 3.0
* \since QGIS 3.0
* \brief Strategy for calculating edge cost based on travel time. Should be
* used for finding fastest path between two points.
*/
@@ -25,7 +25,7 @@
/**
* \ingroup analysis
* \class QgsNetworkStrategy
* \note added in QGIS 3.0
* \since QGIS 3.0
* \brief QgsNetworkStrategy defines strategy used for calculation of the edge cost. For example it can
* take into account travel distance, amount of time or money. Currently there are two strategies
* implemented in the analysis library: QgsNetworkDistanceStrategy and QgsNetworkSpeedStrategy.
@@ -25,7 +25,7 @@ class QgsVectorLayer;
/**
* \ingroup analysis
* \class QgsVectorLayerDirector
* \note added in QGIS 3.0
* \since QGIS 3.0
* \brief Determine making the graph from vector line layer
*/
class ANALYSIS_EXPORT QgsVectorLayerDirector : public QgsGraphDirector
@@ -35,7 +35,7 @@ typedef void *GDALDatasetH;
* - cell size and raster size
* - offset of the raster grid
*
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
class ANALYSIS_EXPORT QgsAlignRaster
{
@@ -34,7 +34,7 @@ class QgsFeature;
* \class QgsKernelDensityEstimation
* \ingroup analysis
* Performs Kernel Density Estimation ("heatmap") calculations on a vector layer.
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
class ANALYSIS_EXPORT QgsKernelDensityEstimation
{
@@ -93,7 +93,7 @@ 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
* @note added in QGIS 2.10
* \since QGIS 2.10
* @note not available in Python bindings
*/
bool calculate( QMap<QString, QgsRasterBlock * > &rasterData, QgsRasterMatrix &result, int row = -1 ) const;
@@ -74,7 +74,7 @@ class ANALYSIS_EXPORT QgsRasterCalculator
* @param nOutputColumns number of columns in output raster
* @param nOutputRows number of rows in output raster
* @param rasterEntries list of referenced raster layers
* @note added in QGIS 2.10
* \since QGIS 2.10
*/
QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat,
const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &outputCrs, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries );
@@ -34,7 +34,7 @@ class QgsVectorLayer;
* QgsGeometrySnapper allows a geometry to be snapped to the geometries within a
* different reference layer. Vertices in the geometries will be modified to
* match the reference layer features within a specified snap tolerance.
* \note added in QGIS 3.0
* \since QGIS 3.0
*/
class ANALYSIS_EXPORT QgsGeometrySnapper : public QObject
{
@@ -126,7 +126,7 @@ class ANALYSIS_EXPORT QgsGeometrySnapper : public QObject
* The returned QgsGeometryMap can be passed to QgsVectorDataProvider::changeGeometryValues() to save
* the snapped geometries back to the source layer.
*
* \note added in QGIS 3.0
* \since QGIS 3.0
*/
class ANALYSIS_EXPORT QgsInternalGeometrySnapper
{
@@ -130,7 +130,7 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
bool loadFromTemplate( const QDomDocument &templateDoc, bool clearExisting );

//! Sets the specified feature as the current atlas feature
//! @note added in 2.1
//! \since QGIS 2.1
void setAtlasFeature( QgsMapLayer *layer, const QgsFeature &feat );

protected:
@@ -592,7 +592,7 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
QMenu *mirrorOtherMenu( QMenu *otherMenu );

//! Toggles the state of the atlas preview and navigation controls
//! @note added in 2.1
//! \since QGIS 2.1
void toggleAtlasControls( bool atlasEnabled );

//! Sets the printer page orientation when the page orientation changes
@@ -24,7 +24,7 @@ class QgsComposerPolygon;

/**
* Input widget for QgsComposerPolygon
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
class QgsComposerPolygonWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerPolygonWidgetBase
{
@@ -24,7 +24,7 @@ class QgsComposerPolyline;

/**
* Input widget for QgsComposerPolyline
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
class QgsComposerPolylineWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerPolylineWidgetBase
{
@@ -192,7 +192,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QgsRasterLayer *addRasterLayer( const QString &rasterFile, const QString &baseName, bool guiWarning = true );

/** Returns and adjusted uri for the layer based on current and available CRS as well as the last selected image format
* @note added in 2.8
* \since QGIS 2.8
*/
QString crsAndFormatAdjustedLayerUri( const QString &uri, const QStringList &supportedCrs, const QStringList &supportedFormats ) const;

@@ -323,7 +323,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
/** Add a toolbar to the main window. Overloaded from QMainWindow.
* After adding the toolbar to the ui (by delegating to the QMainWindow
* parent class, it will also add it to the View menu list of toolbars.
* @note added in 2.3
* \since QGIS 2.3
*/
void addToolBar( QToolBar *toolBar, Qt::ToolBarArea area = Qt::TopToolBarArea );

@@ -466,7 +466,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QAction *actionLayerSaveAs() { return mActionLayerSaveAs; }
QAction *actionRemoveLayer() { return mActionRemoveLayer; }
QAction *actionDuplicateLayer() { return mActionDuplicateLayer; }
//! @note added in 2.4
//! \since QGIS 2.4
QAction *actionSetLayerScaleVisibility() { return mActionSetLayerScaleVisibility; }
QAction *actionSetLayerCrs() { return mActionSetLayerCRS; }
QAction *actionSetProjectCrsFromLayer() { return mActionSetProjectCRSFromLayer; }
@@ -514,7 +514,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QMenu *viewMenu() { return mViewMenu; }
QMenu *layerMenu() { return mLayerMenu; }
QMenu *newLayerMenu() { return mNewLayerMenu; }
//! @note added in 2.5
//! \since QGIS 2.5
QMenu *addLayerMenu() { return mAddLayerMenu; }
QMenu *settingsMenu() { return mSettingsMenu; }
QMenu *pluginMenu() { return mPluginMenu; }
@@ -585,7 +585,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QList<QgsDecorationItem *> decorationItems() { return mDecorationItems; }
void addDecorationItem( QgsDecorationItem *item ) { mDecorationItems.append( item ); }

//! @note added in 2.1
//! \since QGIS 2.1
static QString normalizedMenuName( const QString &name ) { return name.normalized( QString::NormalizationForm_KD ).remove( QRegExp( "[^a-zA-Z]" ) ); }

#ifdef Q_OS_WIN
@@ -794,7 +794,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void showOptionsDialog( QWidget *parent = nullptr, const QString &currentPage = QString() );

/** Refreshes the state of the layer actions toolbar action
* @note added in 2.1 */
* \since QGIS 2.1 */
void refreshActionFeatureAction();

QMenu *panelMenu() { return mPanelMenu; }
@@ -874,7 +874,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
//! Slot to show current map scale;
void showScale( double scale );
//! Slot to handle user rotation input;
//! @note added in 2.8
//! \since QGIS 2.8
void userRotation();
//! Remove a layer from the map and legend
void removeLayer();
@@ -945,7 +945,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void loadPythonSupport();

/** Install plugin from ZIP file
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void installPluginFromZip();
//! Find the QMenu with the given name within plugin menu (ie the user visible text on the menu item)
@@ -1070,7 +1070,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow

/** Attempts to run a Python script
* @param filePath full path to Python script
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
void runScript( const QString &filePath );
//! Save the map view as an image - user is prompted for image name using a dialog
@@ -1429,23 +1429,23 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void deleteComposerManager();

/** Disable any preview modes shown on the map canvas
* @note added in 2.3 */
* \since QGIS 2.3 */
void disablePreviewMode();

/** Enable a grayscale preview mode on the map canvas
* @note added in 2.3 */
* \since QGIS 2.3 */
void activateGrayscalePreview();

/** Enable a monochrome preview mode on the map canvas
* @note added in 2.3 */
* \since QGIS 2.3 */
void activateMonoPreview();

/** Enable a color blindness (protanope) preview mode on the map canvas
* @note added in 2.3 */
* \since QGIS 2.3 */
void activateProtanopePreview();

/** Enable a color blindness (deuteranope) preview mode on the map canvas
* @note added in 2.3 */
* \since QGIS 2.3 */
void activateDeuteranopePreview();

void toggleFilterLegendByExpression( bool );
@@ -1518,7 +1518,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void customCrsValidation( QgsCoordinateReferenceSystem &crs );

/** This signal is emitted when a layer has been saved using save as
@note added in version 2.7
\since QGIS 2.7
*/
void layerSavedAs( QgsMapLayer *l, const QString &path );

@@ -161,7 +161,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
QToolBar *addToolBar( const QString &name ) override;

//! Add a toolbar
//! @note added in 2.3
//! \since QGIS 2.3
void addToolBar( QToolBar *toolbar, Qt::ToolBarArea area = Qt::TopToolBarArea ) override;

/** Open a url in the users browser. By default the QGIS doc directory is used
@@ -186,7 +186,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
/**
* Returns a pointer to the layer tree canvas bridge
*
* @note added in 2.12
* \since QGIS 2.12
*/
QgsLayerTreeMapCanvasBridge *layerTreeCanvasBridge() override;

@@ -293,14 +293,14 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
virtual void unregisterOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) override;

/** Register a new custom drop handler.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @note Ownership of the factory is not transferred, and the factory must
* be unregistered when plugin is unloaded.
* @see unregisterCustomDropHandler() */
virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) override;

/** Unregister a previously registered custom drop handler.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see registerCustomDropHandler() */
virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) override;

@@ -314,7 +314,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
virtual QMenu *viewMenu() override;
virtual QMenu *layerMenu() override;
virtual QMenu *newLayerMenu() override;
//! @note added in 2.5
//! \since QGIS 2.5
virtual QMenu *addLayerMenu() override;
virtual QMenu *settingsMenu() override;
virtual QMenu *pluginMenu() override;
@@ -119,26 +119,26 @@ class APP_EXPORT QgsAttributeTypeDialog: public QDialog, private Ui::QgsAttribut
/**
* Setter for constraint expression description
* @param desc the expression description
* @note added in QGIS 2.16
* \since QGIS 2.16
**/
void setConstraintExpressionDescription( const QString &desc );

/**
* Getter for constraint expression description
* @return the expression description
* @note added in QGIS 2.16
* \since QGIS 2.16
**/
QString constraintExpressionDescription();

/**
* Getter for the constraint expression
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
QString constraintExpression() const;

/**
* Setter for the constraint expression
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
void setConstraintExpression( const QString &str );

@@ -57,7 +57,7 @@ class QgsBrowserPropertiesWidget : public QWidget
/** Sets whether the properties widget should display in condensed mode, ie, for display in a dock
* widget rather than it's own separate dialog.
* @param condensedMode set to true to enable condensed mode
* @note added in QGIS 2.10
* \since QGIS 2.10
*/
virtual void setCondensedMode( bool condensedMode ) { Q_UNUSED( condensedMode ); }
};
@@ -92,7 +92,7 @@ class APP_EXPORT QgsIdentifyResultsWebViewItem: public QObject, public QTreeWidg
QgsIdentifyResultsWebViewItem( QTreeWidget *treeWidget = nullptr );
QgsIdentifyResultsWebView *webView() { return mWebView; }
void setHtml( const QString &html );
//! @note added in 2.1
//! \since QGIS 2.1
void setContent( const QByteArray &data, const QString &mimeType = QString(), const QUrl &baseUrl = QUrl() );

public slots:
@@ -39,7 +39,7 @@ class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPro
signals:

/** Emitted when dialog settings are applied
* @note added in QGIS 2.9
* \since QGIS 2.9
*/
void applied();

@@ -36,7 +36,7 @@ class QCheckBox;
/**
* \class QgsMapCanvasDockWidget
* A dock widget with an embedded map canvas, for additional map views.
* \note added in QGIS 3.0
* \since QGIS 3.0
*/
class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsMapCanvasDockWidgetBase
{
@@ -176,7 +176,7 @@ class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsM
/**
* \class QgsMapSettingsAction
* Allows embedding a scale, rotation and other map settings into a menu.
* \note added in QGIS 3.0
* \since QGIS 3.0
*/

class QgsMapSettingsAction: public QWidgetAction
Loading

0 comments on commit c8e4e68

Please sign in to comment.