Change comment for QgsCurveV2::sumUpArea

mhugent · nyalldawson · commit 17b51ab28f0a · 2017-01-10T09:09:45.000+10:00
(forward-port from 1c02dc7)
diff --git a/python/core/geometry/qgscurve.sip b/python/core/geometry/qgscurve.sip
@@ -54,8 +54,7 @@ class QgsCurve: public QgsAbstractGeometry
      */
     virtual int numPoints() const = 0;
 
-    /** Calculates the area of the curve. Derived classes should override this
-     * to return the correct area of the curve.
+    /** Sums up the area of the curve by iterating over the vertices (shoelace formula).
      */
     virtual void sumUpArea( double& sum ) const = 0;
 
diff --git a/src/core/geometry/qgscurve.h b/src/core/geometry/qgscurve.h
@@ -81,8 +81,7 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry
      */
     virtual int numPoints() const = 0;
 
-    /** Calculates the area of the curve. Derived classes should override this
-     * to return the correct area of the curve.
+    /** Sums up the area of the curve by iterating over the vertices (shoelace formula).
      */
     virtual void sumUpArea( double& sum ) const = 0;
 
