Add some remaining \since tags

qgis · Apr 2, 2017 · 50ca79e · 50ca79e
1 parent fb91ed7
commit 50ca79e
Show file tree

Hide file tree

Showing 19 changed files with 46 additions and 44 deletions.
diff --git a/python/core/qgsvectorlayer.sip b/python/core/qgsvectorlayer.sip
@@ -414,7 +414,7 @@ Setup the coordinate system transformation for the layer
     QgsVectorLayerJoinBuffer *joinBuffer();
 %Docstring
  Accessor to the join buffer object
-.. versionadded:: 2.14.7
+ \since QGIS 2.14.7
 %End
     const QList<QgsVectorLayerJoinInfo> vectorJoins() const;
 

diff --git a/src/app/qgsmaptooladdfeature.h b/src/app/qgsmaptooladdfeature.h
@@ -21,7 +21,7 @@ class APP_EXPORT QgsMapToolAddFeature : public QgsMapToolCapture
 {
     Q_OBJECT
   public:
-    //! @note mode parameter added in QGIS 2.12
+    //! \since QGIS 2.12
     QgsMapToolAddFeature( QgsMapCanvas *canvas, CaptureMode mode = CaptureNone );
     virtual ~QgsMapToolAddFeature();
     void cadCanvasReleaseEvent( QgsMapMouseEvent *e ) override;

diff --git a/src/core/composer/qgscomposeritem.h b/src/core/composer/qgscomposeritem.h
@@ -167,15 +167,15 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
      * @returns page number for item, beginning on page 1
      * @see pagePos
      * @see updatePagePos
-     * @note this method was added in version 2.4
+     * \since QGIS 2.4
      */
     int page() const;
 
     /** Returns the item's position relative to its current page.
      * @returns position relative to the page's top left corner.
      * @see page
      * @see updatePagePos
-     * @note this method was added in version 2.4
+     * \since QGIS 2.4
      */
     QPointF pagePos() const;
 
@@ -185,7 +185,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
      * @param newPageHeight new height of the page in mm
      * @see page
      * @see pagePos
-     * @note this method was added in version 2.4
+     * \since QGIS 2.4
      */
     void updatePagePos( double newPageWidth, double newPageHeight );
 
@@ -427,7 +427,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
      * @param valueType controls whether the returned value is the user specified rotation,
      * or the current evaluated rotation (which may be affected by data driven rotation
      * settings).
-     * @note this method was added in version 2.1
+     * \since QGIS 2.1
      * @see setItemRotation
      */
     double itemRotation( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue ) const;
@@ -510,14 +510,14 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
     /** Get the number of layers that this item requires for exporting as layers
      * @returns 0 if this item is to be placed on the same layer as the previous item,
      * 1 if it should be placed on its own layer, and >1 if it requires multiple export layers
-     * @note this method was added in version 2.4
+     * \since QGIS 2.4
      * @see setCurrentExportLayer
      */
     virtual int numberExportLayers() const { return 0; }
 
     /** Sets the current layer to draw for exporting
      * @param layerIdx can be set to -1 to draw all item layers, and must be less than numberExportLayers()
-     * @note this method was added in version 2.4
+     * \since QGIS 2.4
      * @see numberExportLayers
      */
     virtual void setCurrentExportLayer( const int layerIdx = -1 ) { mCurrentExportLayer = layerIdx; }
@@ -554,7 +554,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
      * @param r item rotation in degrees
      * @param adjustPosition set to true if item should be shifted so that rotation occurs
      * around item center. If false, rotation occurs around item origin
-     * @note this method was added in version 2.1
+     * \since QGIS 2.1
      * @see itemRotation
      */
     virtual void setItemRotation( const double r, const bool adjustPosition = false );
@@ -567,7 +567,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
      * QgsComposerItem::AllProperties then all data defined properties for the item will be
      * refreshed.
      * @param context expression context for evaluating data defined expressions
-     * @note this method was added in version 2.5
+     * \since QGIS 2.5
      */
     virtual void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext *context = nullptr ) override;
 
@@ -639,7 +639,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
 
     /** The layer that needs to be exported
      * @note: if -1, all layers are to be exported
-     * @note: this member was added in version 2.4
+     * \since QGIS 2.4
      */
     int mCurrentExportLayer;
 
@@ -729,15 +729,15 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
       *@param rotateAroundCenter set to true to rotate the item around its center rather
       * than its origin
       * @param context expression context for evaulating data defined rotation
-      * @note this method was added in version 2.5
+      * \since QGIS 2.5
      */
     void refreshRotation( const bool updateItem = true, const bool rotateAroundCenter = false, const QgsExpressionContext &context = QgsExpressionContext() );
 
     /** Refresh item's transparency, considering data defined transparency
       * @param updateItem set to false to prevent the item being automatically updated
       * after the transparency is set
       * @param context expression context for evaulating data defined transparency
-      * @note this method was added in version 2.5
+      * \since QGIS 2.5
      */
     void refreshTransparency( const bool updateItem = true, const QgsExpressionContext &context = QgsExpressionContext() );
 
@@ -756,7 +756,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
     void refreshBackgroundColor( const bool updateItem = true, const QgsExpressionContext &context = QgsExpressionContext() );
 
     /** Refresh item's blend mode, considering data defined blend mode
-     * @note this method was added in version 2.5
+     * \since QGIS 2.5
      */
     void refreshBlendMode( const QgsExpressionContext &context );
 

diff --git a/src/core/composer/qgscomposermap.h b/src/core/composer/qgscomposermap.h
@@ -339,7 +339,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
 
     /** Sets rotation for the map - this does not affect the composer item shape, only the
      * way the map is drawn within the item
-     * @note this function was added in version 2.1
+     * \since QGIS 2.1
      */
     void setMapRotation( double r );
 
@@ -428,7 +428,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
     /** Get the number of layers that this item requires for exporting as layers
      * @returns 0 if this item is to be placed on the same layer as the previous item,
      * 1 if it should be placed on its own layer, and >1 if it requires multiple export layers
-     * @note this method was added in version 2.4
+     * \since QGIS 2.4
      */
     int numberExportLayers() const override;
 
@@ -625,7 +625,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
 
     /** Refresh the map's extents, considering data defined extent, scale and rotation
      * @param context expression context for evaluating data defined map parameters
-     * @note this method was added in version 2.5
+     * \since QGIS 2.5
      */
     void refreshMapExtents( const QgsExpressionContext *context = nullptr );
 

diff --git a/src/core/composer/qgscomposerobject.h b/src/core/composer/qgscomposerobject.h
@@ -204,7 +204,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
      * QgsComposerItem::AllProperties then all data defined properties for the item will be
      * refreshed.
      * @param context expression context for evaluating data defined expressions
-     * @note this method was added in version 2.5
+     * \since QGIS 2.5
      */
     virtual void refreshDataDefinedProperty( const DataDefinedProperty property = AllProperties, const QgsExpressionContext *context = nullptr );
 

diff --git a/src/core/composer/qgscomposershape.h b/src/core/composer/qgscomposershape.h
@@ -84,7 +84,7 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem
     void setUseSymbol( bool useSymbol );
 
     /** Depending on the symbol style, the bounding rectangle can be larger than the shape
-    @note this function was added in version 2.3*/
+    \since QGIS 2.3*/
     QRectF boundingRect() const override;
 
     /** Sets new scene rectangle bounds and recalculates hight and extent. Reimplemented from

diff --git a/src/core/composer/qgscomposerutils.h b/src/core/composer/qgscomposerutils.h
@@ -126,15 +126,15 @@ class CORE_EXPORT QgsComposerUtils
     static bool decodePresetPaperSize( const QString &presetString, double &width, double &height );
 
     /** Reads all pre 3.0 data defined properties from an XML element.
-     * @note this method was added in version 3.0
+     * \since QGIS 3.0
      * @see readDataDefinedProperty
      * @see writeDataDefinedPropertyMap
      */
     static void readOldDataDefinedPropertyMap( const QDomElement &itemElem,
         QgsPropertyCollection &dataDefinedProperties );
 
     /** Reads a pre 3.0 data defined property from an XML DOM element.
-     * @note this method was added in version 3.0
+     * \since QGIS 3.0
      * @see readDataDefinedPropertyMap
      */
     static QgsProperty readOldDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property, const QDomElement &ddElem );

diff --git a/src/core/composer/qgscomposition.h b/src/core/composer/qgscomposition.h
@@ -754,7 +754,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
 
     /** Returns the items model attached to the composition
      * @returns QgsComposerModel for composition
-     * @note this method was added in version 2.5
+     * \since QGIS 2.5
      */
     QgsComposerModel *itemsModel() { return mItemsModel; }
 
@@ -841,7 +841,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
      * QgsComposerItem::AllProperties then all data defined properties for the composition will be
      * refreshed.
      * @param context expression context for evaluating data defined expressions
-     * @note this method was added in version 2.5
+     * \since QGIS 2.5
      */
     void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext *context = nullptr );
 
@@ -991,7 +991,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
 
     /** Check whether any data defined page settings are active.
      * @returns true if any data defined page settings are active.
-     * @note this method was added in version 2.5
+     * \since QGIS 2.5
      */
     bool ddPageSizeActive() const;
 

diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -411,7 +411,8 @@ class CORE_EXPORT QgsGeometry
     /** Adds a new island polygon to a multipolygon feature
      @return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
      not disjoint with existing polygons of the feature
-     @note available in Python bindings as addPartGeometry (added in 2.2)
+     \note available in Python bindings as addPartGeometry
+     \since QGIS 2.2
      */
     // TODO QGIS 3.0 returns an enum instead of a magic constant
     int addPart( const QgsGeometry &newPart );
@@ -458,7 +459,7 @@ class CORE_EXPORT QgsGeometry
 
     /** Replaces a part of this geometry with another line
      * @return 0 in case of success
-     * @note: this function was added in version 1.3
+     * \since QGIS 1.3
      */
     int reshapeGeometry( const QList<QgsPoint> &reshapeWithLine );
 
@@ -763,16 +764,16 @@ class CORE_EXPORT QgsGeometry
     QByteArray exportToWkb() const;
 
     /** Exports the geometry to WKT
-     *  @note precision parameter added in 2.4
+     *  \note precision parameter added in QGIS 2.4
      *  @return true in case of success and false else
      */
     QString exportToWkt( int precision = 17 ) const;
 
     /** Exports the geometry to GeoJSON
      *  @return a QString representing the geometry as GeoJSON
      *  \since QGIS 1.8
-     *  @note Python binding added in 1.9
-     *  @note precision parameter added in 2.4
+     *  \note Available in Python bindings since QGIS 1.9
+     *  \note precision parameter added in QGIS 2.4
      */
     QString exportToGeoJSON( int precision = 17 ) const;
 
@@ -907,7 +908,7 @@ class CORE_EXPORT QgsGeometry
 
     /** Validate geometry and produce a list of geometry errors
      * \since QGIS 1.5
-     * @note Python binding added in 1.6
+     * \note Available in Python bindings since QGIS 1.6
      **/
     void validateGeometry( QList<Error> &errors );
 

diff --git a/src/core/layertree/qgslayertreemodel.h b/src/core/layertree/qgslayertreemodel.h
@@ -126,7 +126,7 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel
     //! Return 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 skipNodeEmbeddedInParent added in 2.18
+    //! \note Parameter skipNodeEmbeddedInParent added in QGIS 2.18
     //! @see layerOriginalLegendNodes()
     QList<QgsLayerTreeModelLegendNode *> layerLegendNodes( QgsLayerTreeLayer *nodeLayer, bool skipNodeEmbeddedInParent = false );
 

diff --git a/src/core/qgsapplication.h b/src/core/qgsapplication.h
@@ -128,7 +128,7 @@ class CORE_EXPORT QgsApplication : public QApplication
     /** Returns the path to the developers map file.
      * The developers map was created by using leaflet framework,
      * it shows the doc/contributors.json file.
-     * @note this function was added in version 2.7 */
+     * \since QGIS 2.7 */
     static QString developersMapFilePath();
 
     //! Returns the path to the sponsors file.

diff --git a/src/core/qgspluginlayerregistry.h b/src/core/qgspluginlayerregistry.h
@@ -86,8 +86,8 @@ class CORE_EXPORT QgsPluginLayerRegistry
     //! Return plugin layer type metadata or NULL if doesn't exist
     QgsPluginLayerType *pluginLayerType( const QString &typeName );
 
-    /** Return new layer if corresponding plugin has been found, else return NULL.
-     * @note optional param uri added in 2.10
+    /** Returns new layer if corresponding plugin has been found else returns a nullptr.
+     * \note parameter uri has been added in QGIS 2.10
      */
     QgsPluginLayer *createLayer( const QString &typeName, const QString &uri = QString() );
 

diff --git a/src/core/qgsproject.h b/src/core/qgsproject.h
@@ -334,7 +334,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
                               bool saveFlag = true );
 
     /** Create layer group instance defined in an arbitrary project file.
-     * @note: added in version 2.4
+     * \since QGIS 2.4
      */
     QgsLayerTreeGroup *createEmbeddedGroup( const QString &groupName, const QString &projectFilePath, const QStringList &invisibleLayers );
 

diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h
@@ -462,7 +462,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
 
     /**
      * Accessor to the join buffer object
-     * @note added 2.14.7
+     * \since QGIS 2.14.7
      */
     QgsVectorLayerJoinBuffer *joinBuffer() { return mJoinBuffer; }
     const QList<QgsVectorLayerJoinInfo> vectorJoins() const;

diff --git a/src/core/raster/qgsrasterdataprovider.h b/src/core/raster/qgsrasterdataprovider.h
@@ -228,7 +228,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast
      * \param scale Optional parameter that is the Scale of the layer
      * \param forceRefresh Optional bool parameter to force refresh getLegendGraphic call
      * \param visibleExtent Visible extent for providers supporting contextual legends, in layer CRS
-     * \note visibleExtent parameter added in 2.8 (no available in Python bindings)
+     * \note Parameter visibleExtent added in QGIS 2.8
+     * \note Not available in Python bindings
      */
     virtual QImage getLegendGraphic( double scale = 0, bool forceRefresh = false, const QgsRectangle *visibleExtent = nullptr )
     {

diff --git a/src/core/symbology-ng/qgslegendsymbolitem.h b/src/core/symbology-ng/qgslegendsymbolitem.h
@@ -34,7 +34,7 @@ class CORE_EXPORT QgsLegendSymbolItem
   public:
     QgsLegendSymbolItem();
     //! Construct item. Does not take ownership of symbol (makes internal clone)
-    //! @note parentRuleKey added in 2.8
+    //! \since QGIS 2.8
     QgsLegendSymbolItem( QgsSymbol *symbol, const QString &label, const QString &ruleKey, bool checkable = false, int scaleMinDenom = -1, int scaleMaxDenom = -1, int level = 0, const QString &parentRuleKey = QString() );
     ~QgsLegendSymbolItem();
     QgsLegendSymbolItem( const QgsLegendSymbolItem &other );
@@ -65,7 +65,7 @@ class CORE_EXPORT QgsLegendSymbolItem
     int level() const { return mLevel; }
 
     //! Key of the parent legend node. For legends with tree hierarchy
-    //! \since QGIS 2.8
+    //! \note Parameter parentRuleKey added in QGIS 2.8
     QString parentRuleKey() const { return mParentKey; }
 
     //! Set symbol of the item. Takes ownership of symbol.

diff --git a/src/core/symbology-ng/qgssymbol.h b/src/core/symbology-ng/qgssymbol.h
@@ -178,7 +178,7 @@ class CORE_EXPORT QgsSymbol
 
     //! Draw icon of the symbol that occupyies area given by size using the painter.
     //! Optionally custom context may be given in order to get rendering of symbols that use map units right.
-    //! @note customContext parameter added in 2.6
+    //! \since QGIS 2.6
     void drawPreviewIcon( QPainter *painter, QSize size, QgsRenderContext *customContext = nullptr );
 
     //! export symbol as image format. PNG and SVG supported

diff --git a/src/core/symbology-ng/qgssymbollayerutils.h b/src/core/symbology-ng/qgssymbollayerutils.h
@@ -152,7 +152,7 @@ class CORE_EXPORT QgsSymbolLayerUtils
      * @param size target pixmap size
      * @param padding space between icon edge and symbol
      * @param customContext render context to use when rendering symbol
-     * @note customContext parameter added in 2.6
+     * \note Parameter customContext added in QGIS 2.6
      * @see symbolPreviewIcon()
      */
     static QPixmap symbolPreviewPixmap( QgsSymbol *symbol, QSize size, int padding = 0, QgsRenderContext *customContext = nullptr );

diff --git a/src/gui/qgshighlight.h b/src/gui/qgshighlight.h
@@ -65,18 +65,18 @@ class GUI_EXPORT QgsHighlight: public QgsMapCanvasItem
     void setColor( const QColor &color );
 
     /** Set polygons fill color.
-     * @note: added in version 2.3 */
+     * \since QGIS 2.3 */
     void setFillColor( const QColor &fillColor );
 
     //! Set width. Ignored in feature mode.
     void setWidth( int width );
 
     /** Set line / stroke buffer in millimeters.
-     *  @note: added in version 2.3 */
+     *  \since QGIS 2.3 */
     void setBuffer( double buffer ) { mBuffer = buffer; }
 
     /** Set minimum line / stroke width in millimeters.
-     *  @note: added in version 2.3 */
+     *  \since QGIS 2.3 */
     void setMinWidth( double width ) { mMinWidth = width; }
 
     const QgsMapLayer *layer() const { return mLayer; }