Add some docstrings

qgis · Oct 8, 2015 · c927073 · c927073
1 parent a3159a3
commit c927073
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/python/core/geometry/qgsgeometry.sip b/python/core/geometry/qgsgeometry.sip
@@ -123,10 +123,11 @@ class QgsGeometry
     size_t wkbSize() const;
 
     /** Returns a geos geometry. QgsGeometry retains ownership of the geometry, so the returned object should not be deleted.
+        @param precision The precision of the grid to which to snap the geometry vertices. If 0, no snapping is performed.
         @note this method was added in version 1.1
         @note not available in python bindings
       */
-    // const GEOSGeometry* asGeos() const;
+    // const GEOSGeometry* asGeos( double precision = 0 ) const;
 
     /** Returns type of the geometry as a WKB type (point / linestring / polygon etc.)
      * @see type

diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -158,6 +158,7 @@ class CORE_EXPORT QgsGeometry
     size_t wkbSize() const;
 
     /** Returns a geos geometry. QgsGeometry retains ownership of the geometry, so the returned object should not be deleted.
+        @param precision The precision of the grid to which to snap the geometry vertices. If 0, no snapping is performed.
         @note this method was added in version 1.1
         @note not available in python bindings
       */

diff --git a/src/core/geometry/qgsgeos.h b/src/core/geometry/qgsgeos.h
@@ -29,6 +29,10 @@ class QgsPolygonV2;
 class CORE_EXPORT QgsGeos: public QgsGeometryEngine
 {
   public:
+    /** GEOS geometry engine constructor
+     * @param geometry The geometry
+     * @param precision The precision of the grid to which to snap the geometry vertices. If 0, no snapping is performed.
+     */
     QgsGeos( const QgsAbstractGeometryV2* geometry, double precision = 0 );
     ~QgsGeos();