Better doc strings

qgis · Jan 14, 2020 · 8b62eb9 · 8b62eb9
1 parent 952d704
commit 8b62eb9
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 4 deletions.
diff --git a/python/analysis/auto_generated/vector/geometry_checker/qgsgeometrycheck.sip.in b/python/analysis/auto_generated/vector/geometry_checker/qgsgeometrycheck.sip.in
@@ -220,7 +220,7 @@ Returns a list of available resolution methods.
 .. versionadded:: 3.12
 %End
 
- virtual QStringList resolutionMethods() const;
+ virtual QStringList resolutionMethods() const /Deprecated/;
 %Docstring
 Returns a list of descriptions for available resolutions for errors.
 The index will be passed as ``method`` to :py:func:`fixError`.

diff --git a/...n/analysis/auto_generated/vector/geometry_checker/qgsgeometrycheckresolutionmethod.sip.in b/...n/analysis/auto_generated/vector/geometry_checker/qgsgeometrycheckresolutionmethod.sip.in
@@ -11,7 +11,7 @@
 class QgsGeometryCheckResolutionMethod
 {
 %Docstring
-This class implements a fix for problems detected in geometry checks.
+This class implements a resolution for problems detected in geometry checks.
 
 .. versionadded:: 3.12
 %End

diff --git a/src/analysis/vector/geometry_checker/qgsgeometrycheck.h b/src/analysis/vector/geometry_checker/qgsgeometrycheck.h
@@ -308,6 +308,7 @@ class ANALYSIS_EXPORT QgsGeometryCheck
      * Fixes the error \a error with the specified \a method.
      * Is executed on the main thread.
      *
+     * \see availableResolutionMethods()
      * \since QGIS 3.4
      */
     virtual void fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> &mergeAttributeIndices, Changes &changes SIP_INOUT ) const SIP_SKIP;
@@ -326,7 +327,7 @@ class ANALYSIS_EXPORT QgsGeometryCheck
      * \deprecated since QGIS 3.12, use availableResolutionMethods() instead
      * \since QGIS 3.4
      */
-    Q_DECL_DEPRECATED virtual QStringList resolutionMethods() const;
+    Q_DECL_DEPRECATED virtual QStringList resolutionMethods() const SIP_DEPRECATED;
 
     /**
      * Returns a human readable description for this check.

diff --git a/src/analysis/vector/geometry_checker/qgsgeometrycheckresolutionmethod.h b/src/analysis/vector/geometry_checker/qgsgeometrycheckresolutionmethod.h
@@ -20,7 +20,7 @@
 #include "qgis_analysis.h"
 
 /**
- * This class implements a fix for problems detected in geometry checks.
+ * This class implements a resolution for problems detected in geometry checks.
  *
  * \since QGIS 3.12
  */