[tracing curves] experimental notice

qgis · May 14, 2020 · 68582a6 · 68582a6
1 parent 784ddd9
commit 68582a6
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 1 deletion.
diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -1243,6 +1243,10 @@ This method only consider a segments as suitable for replacing with an arc if th
 regularly spaced on the candidate arc. The ``pointSpacingAngleTolerance`` parameter specifies the maximum
 angular deviation (in radians) allowed when testing for regular point spacing.
 
+.. note::
+
+   The API is considered EXPERIMENTAL and can be changed without a notice
+
 .. versionadded:: 3.14
 %End
 

diff --git a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in
@@ -367,6 +367,10 @@ This method only consider a segments as continuing an arc if the points are all
 on the candidate arc. The ``pointSpacingAngleTolerance`` parameter specifies the maximum
 angular deviation (in radians) allowed when testing for regular point spacing.
 
+.. note::
+
+   The API is considered EXPERIMENTAL and can be changed without a notice
+
 .. versionadded:: 3.14
 %End
 

diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -1254,6 +1254,8 @@ class CORE_EXPORT QgsGeometry
      * regularly spaced on the candidate arc. The \a pointSpacingAngleTolerance parameter specifies the maximum
      * angular deviation (in radians) allowed when testing for regular point spacing.
      *
+     * \note The API is considered EXPERIMENTAL and can be changed without a notice
+     *
      * \since QGIS 3.14
      */
     QgsGeometry convertToCurves( double distanceTolerance = 1e-8, double angleTolerance = 1e-8 ) const;

diff --git a/src/core/geometry/qgsgeometryutils.h b/src/core/geometry/qgsgeometryutils.h
@@ -383,6 +383,8 @@ class CORE_EXPORT QgsGeometryUtils
      * on the candidate arc. The \a pointSpacingAngleTolerance parameter specifies the maximum
      * angular deviation (in radians) allowed when testing for regular point spacing.
      *
+     * \note The API is considered EXPERIMENTAL and can be changed without a notice
+     *
      * \since QGIS 3.14
      */
     static bool pointContinuesArc( const QgsPoint &a1, const QgsPoint &a2, const QgsPoint &a3, const QgsPoint &b, double distanceTolerance,

diff --git a/src/core/geometry/qgsinternalgeometryengine.h b/src/core/geometry/qgsinternalgeometryengine.h
@@ -177,6 +177,8 @@ class QgsInternalGeometryEngine
      * regularly spaced on the candidate arc. The \a pointSpacingAngleTolerance parameter specifies the maximum
      * angular deviation (in radians) allowed when testing for regular point spacing.
      *
+     * \note The API is considered EXPERIMENTAL and can be changed without a notice
+     *
      * \since QGIS 3.14
      */
     QgsGeometry convertToCurves( double distanceTolerance, double angleTolerance ) const;

diff --git a/src/ui/qgsoptionsbase.ui b/src/ui/qgsoptionsbase.ui
@@ -4515,7 +4515,7 @@ The bigger the number, the faster zooming with the mouse wheel will be.</string>
                   <item row="0" column="0" colspan="3">
                    <widget class="QCheckBox" name="mTracingConvertToCurveCheckBox">
                     <property name="text">
-                     <string>Convert tracing to curve</string>
+                     <string>Convert tracing to curve (this feature is experimental)</string>
                     </property>
                    </widget>
                   </item>