Add doxymentation

qgis · Sep 7, 2018 · e637fd5 · e637fd5
1 parent 8ba442f
commit e637fd5
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -1482,8 +1482,19 @@ by calling `error()` on the returned geometry.
 
         Error( const QString &m, const QgsPointXY &p );
         QString what() const;
+%Docstring
+A human readable error message containing details about the error.
+%End
+
         QgsPointXY where() const;
+%Docstring
+The coordinates at which the error is located and should be visualized.
+%End
+
         bool hasWhere() const;
+%Docstring
+True if the location available from :py:func:`where` is valid.
+%End
 
     };
 

diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -1432,8 +1432,19 @@ class CORE_EXPORT QgsGeometry
           , mLocation( p )
           , mHasLocation( true ) {}
 
+        /**
+         * A human readable error message containing details about the error.
+         */
         QString what() const;
+
+        /**
+         * The coordinates at which the error is located and should be visualized.
+         */
         QgsPointXY where() const;
+
+        /**
+         * True if the location available from \see where is valid.
+         */
         bool hasWhere() const;
 
       private: