Fix documentation

This commit is contained in:
Julien Cabieces 2019-09-06 11:55:06 +02:00
parent c699ab5eb9
commit 57aec1f4af
2 changed files with 18 additions and 0 deletions

View File

@ -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
};

View File

@ -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: