Rewriting documentation

python/core/auto_generated/qgsvectorlayereditutils.sip.in

@@ -182,25 +182,21 @@ Adds topological points for every vertex of the geometry.
 
     int addTopologicalPoints( const QgsPointXY &p );
 %Docstring
-Adds a vertex to segments which intersect point p but don't
+Adds a vertex to segments which intersect point ``p`` but don't
 already have a vertex there. If a feature already has a vertex at position p,
 no additional vertex is inserted. This method is useful for topological
 editing.
 
-:param p: position of the vertex
-
 :return: 0 in case of success
 %End
 
     int addTopologicalPoints( const QgsPoint &p );
 %Docstring
-Adds a vertex to segments which intersect point p but don't
+Adds a vertex to segments which intersect point ``p`` but don't
 already have a vertex there. If a feature already has a vertex at position p,
 no additional vertex is inserted. This method is useful for topological
 editing.
 
-:param p: position of the vertex
-
 :return: 0 in case of success
 
 .. versionadded:: 3.10

python/gui/auto_generated/qgsmaptooledit.sip.in

@@ -68,18 +68,16 @@ Returns the current vector layer of the map canvas or 0
       InvalidLayer,
     };
 
-    TopologicalResult addTopologicalPoints( const QVector<QgsPointXY> &geom );
+    TopologicalResult addTopologicalPoints( const QVector<QgsPointXY> &vertices );
 %Docstring
-Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
+Adds a list of ``vertices`` to other features to keep topology up to date, e.g. to neighbouring polygons.
-
+The ``vertices`` list specifies a set of topological points to add, in the layer's coordinate reference system.
-:param geom: list of points (in layer coordinate system)
 %End
 
-    TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &geom );
+    TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &vertices );
 %Docstring
-Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
+Adds a list of ``vertices`` to other features to keep topology up to date, e.g. to neighbouring polygons.
-
+The ``vertices`` list specifies a set of topological points to add, in the layer's coordinate reference system.
-:param geom: list of points (in layer coordinate system)
 
 .. versionadded:: 3.10
 %End

src/core/qgsvectorlayereditutils.h

@@ -167,21 +167,19 @@ class CORE_EXPORT QgsVectorLayerEditUtils
     int addTopologicalPoints( const QgsGeometry &geom );
 
     /**
-     * Adds a vertex to segments which intersect point p but don't
+     * Adds a vertex to segments which intersect point \a p but don't
      * already have a vertex there. If a feature already has a vertex at position p,
      * no additional vertex is inserted. This method is useful for topological
      * editing.
-     * \param p position of the vertex
      * \return 0 in case of success
      */
     int addTopologicalPoints( const QgsPointXY &p );
 
     /**
-     * Adds a vertex to segments which intersect point p but don't
+     * Adds a vertex to segments which intersect point \a p but don't
      * already have a vertex there. If a feature already has a vertex at position p,
      * no additional vertex is inserted. This method is useful for topological
      * editing.
-     * \param p position of the vertex
      * \return 0 in case of success
      * \since QGIS 3.10
      */

src/gui/qgsmaptooledit.cpp

@@ -92,7 +92,7 @@ QgsVectorLayer *QgsMapToolEdit::currentVectorLayer()
 }
 
 
-QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QVector<QgsPoint> &geom )
+QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QVector<QgsPoint> &vertices )
 {
   if ( !mCanvas )
   {
@@ -107,15 +107,15 @@ QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QV
     return QgsMapToolEdit::InvalidLayer;
   }
 
-  QVector<QgsPoint>::const_iterator list_it = geom.constBegin();
+  QVector<QgsPoint>::const_iterator list_it = vertices.constBegin();
-  for ( ; list_it != geom.constEnd(); ++list_it )
+  for ( ; list_it != vertices.constEnd(); ++list_it )
   {
     vlayer->addTopologicalPoints( *list_it );
   }
   return QgsMapToolEdit::Success;
 }
 
-QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QVector<QgsPointXY> &geom )
+QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QVector<QgsPointXY> &vertices )
 {
   if ( !mCanvas )
   {
@@ -130,8 +130,8 @@ QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QV
     return QgsMapToolEdit::InvalidLayer;
   }
 
-  QVector<QgsPointXY>::const_iterator list_it = geom.constBegin();
+  QVector<QgsPointXY>::const_iterator list_it = vertices.constBegin();
-  for ( ; list_it != geom.constEnd(); ++list_it )
+  for ( ; list_it != vertices.constEnd(); ++list_it )
   {
     vlayer->addTopologicalPoints( *list_it );
   }

src/gui/qgsmaptooledit.h

@@ -76,17 +76,17 @@ class GUI_EXPORT QgsMapToolEdit: public QgsMapTool
     };
 
     /**
-     * Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
+     * Adds a list of \a vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
-     * \param geom list of points (in layer coordinate system)
+     * The \a vertices list specifies a set of topological points to add, in the layer's coordinate reference system.
      */
-    TopologicalResult addTopologicalPoints( const QVector<QgsPointXY> &geom );
+    TopologicalResult addTopologicalPoints( const QVector<QgsPointXY> &vertices );
 
     /**
-     * Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
+     * Adds a list of \a vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
-     * \param geom list of points (in layer coordinate system)
+     * The \a vertices list specifies a set of topological points to add, in the layer's coordinate reference system.
      * \since QGIS 3.10
      */
-    TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &geom );
+    TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &vertices );
 
     //! Display a timed message bar noting the active layer is not vector.
     void notifyNotVectorLayer();