Fix code sample formatting

qgis · Jul 3, 2020 · 0876bae · 0876bae
1 parent f7f9534
commit 0876bae
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 16 deletions.
diff --git a/python/core/auto_generated/qgssnappingutils.sip.in b/python/core/auto_generated/qgssnappingutils.sip.in
@@ -118,14 +118,14 @@ Find out which strategy is used for indexing - by default hybrid indexing is use
 %Docstring
 Create a new configuration for a snapping layer.
 
-```py
-snapper = QgsMapCanvasSnappingUtils(mapCanvas)
+.. code-block:: python
 
-snapping_layer1 = QgsSnappingUtils.LayerConfig(layer1, QgsPointLocator.Vertex, 10, QgsTolerance.Pixels)
-snapping_layer2 = QgsSnappingUtils.LayerConfig(layer2, QgsPointLocator.Vertex and QgsPointLocator.Edge, 10, QgsTolerance.Pixels)
+     snapper = QgsMapCanvasSnappingUtils(mapCanvas)
 
-snapper.setLayers([snapping_layer1, snapping_layer2])
-```
+     snapping_layer1 = QgsSnappingUtils.LayerConfig(layer1, QgsPointLocator.Vertex, 10, QgsTolerance.Pixels)
+     snapping_layer2 = QgsSnappingUtils.LayerConfig(layer2, QgsPointLocator.Vertex and QgsPointLocator.Edge, 10, QgsTolerance.Pixels)
+
+     snapper.setLayers([snapping_layer1, snapping_layer2])
 
 :param l: The vector layer for which this configuration is
 :param t: Which parts of the geometry should be snappable

diff --git a/src/core/qgssnappingutils.h b/src/core/qgssnappingutils.h
@@ -123,16 +123,16 @@ class CORE_EXPORT QgsSnappingUtils : public QObject
 
       /**
        * Create a new configuration for a snapping layer.
-
-        ```py
-        snapper = QgsMapCanvasSnappingUtils(mapCanvas)
-
-        snapping_layer1 = QgsSnappingUtils.LayerConfig(layer1, QgsPointLocator.Vertex, 10, QgsTolerance.Pixels)
-        snapping_layer2 = QgsSnappingUtils.LayerConfig(layer2, QgsPointLocator.Vertex and QgsPointLocator.Edge, 10, QgsTolerance.Pixels)
-
-        snapper.setLayers([snapping_layer1, snapping_layer2])
-        ```
-
+       *
+       * \code{.py}
+       * snapper = QgsMapCanvasSnappingUtils(mapCanvas)
+       *
+       * snapping_layer1 = QgsSnappingUtils.LayerConfig(layer1, QgsPointLocator.Vertex, 10, QgsTolerance.Pixels)
+       * snapping_layer2 = QgsSnappingUtils.LayerConfig(layer2, QgsPointLocator.Vertex and QgsPointLocator.Edge, 10, QgsTolerance.Pixels)
+       *
+       * snapper.setLayers([snapping_layer1, snapping_layer2])
+       * \endcode
+       *
        * \param l   The vector layer for which this configuration is
        * \param t   Which parts of the geometry should be snappable
        * \param tol The tolerance radius in which the snapping will trigger