From 43bbaf0c5d1b5b4edb175262f6896e8ed68e7043 Mon Sep 17 00:00:00 2001
From: Matthias Kuhn <matthias@opengis.ch>
Date: Thu, 8 Aug 2019 08:49:26 +0200
Subject: [PATCH] dox++

---
 .../vector/geometry_checker/qgsgeometrycheck.sip.in        | 2 ++
 src/analysis/vector/geometry_checker/qgsgeometrycheck.h    | 2 ++
 .../vector/geometry_checker/qgsgeometrycheckcontext.h      | 7 +++++--
 3 files changed, 9 insertions(+), 2 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
index 356e962f95c..1a91a62f681 100644
--- a/python/analysis/auto_generated/vector/geometry_checker/qgsgeometrycheck.sip.in
+++ b/python/analysis/auto_generated/vector/geometry_checker/qgsgeometrycheck.sip.in
@@ -177,6 +177,8 @@ Create a new geometry check.
     virtual void prepare( const QgsGeometryCheckContext *context, const QVariantMap &configuration );
 %Docstring
 Will be run in the main thread before collectErrors is called (which may be run from a background thread).
+
+.. versionadded:: 3.10
 %End
 
 
diff --git a/src/analysis/vector/geometry_checker/qgsgeometrycheck.h b/src/analysis/vector/geometry_checker/qgsgeometrycheck.h
index 17c8ab9518e..9ab5cf639dd 100644
--- a/src/analysis/vector/geometry_checker/qgsgeometrycheck.h
+++ b/src/analysis/vector/geometry_checker/qgsgeometrycheck.h
@@ -255,6 +255,8 @@ class ANALYSIS_EXPORT QgsGeometryCheck
 
     /**
      * Will be run in the main thread before collectErrors is called (which may be run from a background thread).
+     *
+     * \since QGIS 3.10
      */
     virtual void prepare( const QgsGeometryCheckContext *context, const QVariantMap &configuration );
 
diff --git a/src/analysis/vector/geometry_checker/qgsgeometrycheckcontext.h b/src/analysis/vector/geometry_checker/qgsgeometrycheckcontext.h
index e044f3a2141..869a89b70ed 100644
--- a/src/analysis/vector/geometry_checker/qgsgeometrycheckcontext.h
+++ b/src/analysis/vector/geometry_checker/qgsgeometrycheckcontext.h
@@ -60,8 +60,11 @@ struct ANALYSIS_EXPORT QgsGeometryCheckContext
     const QgsCoordinateTransformContext transformContext;
 
     /**
-     * The project ... blablabla
-     * Only to be used in the main thread (prepare method)
+     * The project can be used to resolve additional layers.
+     *
+     * This must only be accessed from the main thread (i.e. do not access from the collectError method)
+     *
+     * \since QGIS 3.10
      */
     const QgsProject *project;