Add missing dox

qgis · Jul 15, 2017 · 353d4fc · 353d4fc
1 parent 7baa623
commit 353d4fc
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/core/qgsspatialindex.cpp b/src/core/qgsspatialindex.cpp
@@ -163,6 +163,14 @@ class QgsSpatialIndexData : public QSharedData
       initTree();
     }
 
+    /**
+     * Constructor for QgsSpatialIndexData which bulk loads features from the specified feature iterator
+     * \a fi.
+     *
+     * The optional \a feedback object can be used to allow cancelation of bulk feature loading. Ownership
+     * of \a feedback is not transferred, and callers must take care that the lifetime of feedback exceeds
+     * that of the spatial index construction.
+     */
     explicit QgsSpatialIndexData( const QgsFeatureIterator &fi, QgsFeedback *feedback = nullptr )
     {
       QgsFeatureIteratorDataStream fids( fi, feedback );