Fix documentation

qgis · Sep 6, 2019 · 57aec1f · 57aec1f
1 parent c699ab5
commit 57aec1f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git 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
@@ -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: