Extend documentation

qgis · Nov 29, 2018 · 80c12b5 · 80c12b5
1 parent 18854dc
commit 80c12b5
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/python/analysis/auto_generated/raster/qgsrastercalculator.sip.in b/python/analysis/auto_generated/raster/qgsrastercalculator.sip.in
@@ -25,9 +25,15 @@ Represents an individual raster layer/band number entry within a raster calculat
 
     static QList<QgsRasterCalculatorEntry> rasterEntries();
 %Docstring
-Creates a list of raster entries from the current project
+Creates a list of raster entries from the current project.
+
+If there are more than one layers with the same data source
+only one of them is added to the list, duplicate names are
+also handled by appending an _n integer to the base name.
 
 :return: the list of raster entries form the current project
+
+.. versionadded:: 3.6
 %End
 
     QString ref;

diff --git a/src/analysis/raster/qgsrastercalculator.h b/src/analysis/raster/qgsrastercalculator.h
@@ -41,8 +41,14 @@ class ANALYSIS_EXPORT QgsRasterCalculatorEntry
   public:
 
     /**
-     * Creates a list of raster entries from the current project
+     * Creates a list of raster entries from the current project.
+     *
+     * If there are more than one layers with the same data source
+     * only one of them is added to the list, duplicate names are
+     * also handled by appending an _n integer to the base name.
+     *
      * \return the list of raster entries form the current project
+     * \since QGIS 3.6
      */
     static QList<QgsRasterCalculatorEntry> rasterEntries();