param description fix

qgis · Jun 21, 2017 · a2e010c · a2e010c
1 parent fb6f181
commit a2e010c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/python/core/qgsvectorlayerexporter.sip b/python/core/qgsvectorlayerexporter.sip
@@ -154,8 +154,8 @@ class QgsVectorLayerExporterTask : QgsTask
 %Docstring
  Constructor for QgsVectorLayerExporterTask. Takes a source ``layer``, destination ``uri``
  and ``providerKey``, and various export related parameters such as destination CRS
- and export ``options``.
- \param ownsLayer take ownership of layer and deletes it after export
+ and export ``options``. ``ownsLayer`` has to be set to true if the task should take ownership
+ of the layer and delete it after export.
 %End
 
     static QgsVectorLayerExporterTask *withLayerOwnership( QgsVectorLayer *layer /Transfer/,

diff --git a/src/core/qgsvectorlayerexporter.h b/src/core/qgsvectorlayerexporter.h
@@ -188,8 +188,8 @@ class CORE_EXPORT QgsVectorLayerExporterTask : public QgsTask
     /**
      * Constructor for QgsVectorLayerExporterTask. Takes a source \a layer, destination \a uri
      * and \a providerKey, and various export related parameters such as destination CRS
-     * and export \a options.
-     * \param ownsLayer take ownership of layer and deletes it after export
+     * and export \a options. \a ownsLayer has to be set to true if the task should take ownership
+     * of the layer and delete it after export.
     */
     QgsVectorLayerExporterTask( QgsVectorLayer *layer,
                                 const QString &uri,