Fix class documentation

qgis · Apr 17, 2019 · 394a189 · 394a189
1 parent 654a78d
commit 394a189
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 15 deletions.
diff --git a/python/core/auto_generated/mesh/qgsmeshlayer.sip.in b/python/core/auto_generated/mesh/qgsmeshlayer.sip.in
@@ -84,13 +84,13 @@ Constructor for LayerOptions with optional ``transformContext``.
 
 .. note::
 
-   transformContext argument was added in QGIS 3.10
+   transformContext argument was added in QGIS 3.8
 %End
 
       QgsCoordinateTransformContext transformContext;
     };
 
-    explicit QgsMeshLayer( const QString &path = QString(), const QString &baseName = QString(), const QString &providerLib = "mesh_memory",
+    explicit QgsMeshLayer( const QString &path = QString(), const QString &baseName = QString(), const QString &providerLib = QStringLiteral( "mesh_memory" ),
                            const QgsMeshLayer::LayerOptions &options = QgsMeshLayer::LayerOptions() );
 %Docstring
 Constructor - creates a mesh layer

diff --git a/python/core/auto_generated/processing/qgsprocessingutils.sip.in b/python/core/auto_generated/processing/qgsprocessingutils.sip.in
@@ -183,15 +183,15 @@ Combines the extent of several map ``layers``. If specified, the target ``crs``
 will be used to transform the layer's extent to the desired output reference system
 using the specified ``context``.
 
-.. versionadded:: 3.10
+.. versionadded:: 3.8
 %End
 
  static QgsRectangle combineLayerExtents( const QList<QgsMapLayer *> &layers, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() ) /Deprecated/;
 %Docstring
 Combines the extent of several map ``layers``. If specified, the target ``crs``
 will be used to transform the layer's extent to the desired output reference system.
 
-.. deprecated:: Use version with transformContext argument instead
+.. deprecated:: Use version with QgsProcessingContext argument instead
 %End
 
     static QVariant generateIteratingDestination( const QVariant &input, const QVariant &id, QgsProcessingContext &context );

diff --git a/python/core/auto_generated/qgsmaplayer.sip.in b/python/core/auto_generated/qgsmaplayer.sip.in
@@ -622,7 +622,7 @@ Sets layer's spatial reference system
 Returns the layer data provider coordinate transform context
 or a default transform context if the layer does not have a valid data provider.
 
-.. versionadded:: 3.10
+.. versionadded:: 3.8
 %End
 
 
@@ -1359,9 +1359,9 @@ if the notification message is equal to:param message:
 
     virtual void setTransformContext( const QgsCoordinateTransformContext &transformContext ) = 0;
 %Docstring
-Triggered when the coordinate transform context has changed ``transformContext``
+Sets the coordinate transform context to ``transformContext``
 
-.. versionadded:: 3.10
+.. versionadded:: 3.8
 %End
 
   signals:

diff --git a/src/core/mesh/qgsmeshlayer.h b/src/core/mesh/qgsmeshlayer.h
@@ -100,7 +100,7 @@ class CORE_EXPORT QgsMeshLayer : public QgsMapLayer
 
       /**
        * Constructor for LayerOptions with optional \a transformContext.
-       * \note transformContext argument was added in QGIS 3.10
+       * \note transformContext argument was added in QGIS 3.8
        */
       explicit LayerOptions( const QgsCoordinateTransformContext &transformContext = QgsCoordinateTransformContext( ) )
         : transformContext( transformContext )
@@ -122,7 +122,7 @@ class CORE_EXPORT QgsMeshLayer : public QgsMapLayer
      * \param providerLib  The name of the data provider, e.g., "mesh_memory", "mdal"
      * \param options general mesh layer options
      */
-    explicit QgsMeshLayer( const QString &path = QString(), const QString &baseName = QString(), const QString &providerLib = "mesh_memory",
+    explicit QgsMeshLayer( const QString &path = QString(), const QString &baseName = QString(), const QString &providerLib = QStringLiteral( "mesh_memory" ),
                            const QgsMeshLayer::LayerOptions &options = QgsMeshLayer::LayerOptions() );
 
     ~QgsMeshLayer() override;

diff --git a/src/core/processing/qgsprocessingutils.h b/src/core/processing/qgsprocessingutils.h
@@ -218,14 +218,14 @@ class CORE_EXPORT QgsProcessingUtils
      * Combines the extent of several map \a layers. If specified, the target \a crs
      * will be used to transform the layer's extent to the desired output reference system
      * using the specified \a context.
-     * \since QGIS 3.10
+     * \since QGIS 3.8
      */
     static QgsRectangle combineLayerExtents( const QList<QgsMapLayer *> &layers, const QgsCoordinateReferenceSystem &crs, QgsProcessingContext &context );
 
     /**
      * Combines the extent of several map \a layers. If specified, the target \a crs
      * will be used to transform the layer's extent to the desired output reference system.
-     * \deprecated Use version with transformContext argument instead
+     * \deprecated Use version with QgsProcessingContext argument instead
      */
     Q_DECL_DEPRECATED static QgsRectangle combineLayerExtents( const QList<QgsMapLayer *> &layers, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() ) SIP_DEPRECATED;
 

diff --git a/src/core/qgsdataprovider.h b/src/core/qgsdataprovider.h
@@ -93,7 +93,7 @@ class CORE_EXPORT QgsDataProvider : public QObject
     /**
      * Setting options for creating vector data providers.
      *
-     * \note coordinateTransformContext was added in QGIS 3.10
+     * \note coordinateTransformContext was added in QGIS 3.8
      *
      * \since QGIS 3.2
      */

diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h
@@ -615,7 +615,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
     /**
      * Returns the layer data provider coordinate transform context
      * or a default transform context if the layer does not have a valid data provider.
-    \since QGIS 3.10
+    \since QGIS 3.8
      */
     QgsCoordinateTransformContext transformContext( ) const;
 
@@ -1209,9 +1209,9 @@ class CORE_EXPORT QgsMapLayer : public QObject
     void setRefreshOnNofifyMessage( const QString &message ) { mRefreshOnNofifyMessage = message; }
 
     /**
-     * Triggered when the coordinate transform context has changed \a transformContext
+     * Sets the coordinate transform context to \a transformContext
      *
-     * \since QGIS 3.10
+     * \since QGIS 3.8
      */
     virtual void setTransformContext( const QgsCoordinateTransformContext &transformContext ) = 0;