diff --git a/python/gui/auto_generated/qgsmapcanvassnappingutils.sip.in b/python/gui/auto_generated/qgsmapcanvassnappingutils.sip.in index eb4bf585aa6..1256657b2ce 100644 --- a/python/gui/auto_generated/qgsmapcanvassnappingutils.sip.in +++ b/python/gui/auto_generated/qgsmapcanvassnappingutils.sip.in @@ -23,7 +23,16 @@ Snapping utils instance that is connected to a canvas and updates the configurat #include "qgsmapcanvassnappingutils.h" %End public: + QgsMapCanvasSnappingUtils( QgsMapCanvas *canvas, QObject *parent = 0, bool asynchronous = false ); +%Docstring +Construct map canvas snapping utils object + +:param canvas: map canvas +:param parent: parent object +:param asynchronous: if ``True`` snapping cache index will be non blocking and done in another thread, + if ``False`` it will block until indexing is done +%End }; diff --git a/src/gui/qgsmapcanvassnappingutils.h b/src/gui/qgsmapcanvassnappingutils.h index f451fdc7a8f..def0d18e3eb 100644 --- a/src/gui/qgsmapcanvassnappingutils.h +++ b/src/gui/qgsmapcanvassnappingutils.h @@ -34,6 +34,15 @@ class GUI_EXPORT QgsMapCanvasSnappingUtils : public QgsSnappingUtils { Q_OBJECT public: + + /** + * Construct map canvas snapping utils object + * + * \param canvas map canvas + * \param parent parent object + * \param asynchronous if TRUE snapping cache index will be non blocking and done in another thread, + * if FALSE it will block until indexing is done + */ QgsMapCanvasSnappingUtils( QgsMapCanvas *canvas, QObject *parent = nullptr, bool asynchronous = false ); private slots: