Skip to content

Commit e53debe

Browse files
committed
Update doxygen comments for QgsGeometry, reflecting that QgsGeometry
is a generic geometry container from >= 2.10.
1 parent b4edf8a commit e53debe

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

python/core/geometry/qgsgeometry.sip

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,15 @@ typedef unsigned long size_t;
2121
typedef unsigned int size_t;
2222
%End
2323

24+
/** \ingroup core
25+
* A geometry is the spatial representation of a feature. Since QGIS 2.10, QgsGeometry acts as a generic container
26+
* for geometry objects. QgsGeometry is implicitly shared, so making copies of geometries is inexpensive. The geometry
27+
* container class can also be stored inside a QVariant object.
28+
*
29+
* The actual geometry representation is stored as a @link QgsAbstractGeometryV2 @endlink within the container, and
30+
* can be accessed via the @link geometry @endlink method or set using the @link setGeometry @endlink method.
31+
*/
32+
2433
class QgsGeometry
2534
{
2635
%TypeHeaderCode

src/core/geometry/qgsgeometry.h

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,13 @@ class QgsConstWkbPtr;
6464
struct QgsGeometryPrivate;
6565

6666
/** \ingroup core
67-
- * A geometry is the spatial representation of a feature. This class is deprecated. Please use QgsAbstractGeometryV2 directly for new code*/
67+
* A geometry is the spatial representation of a feature. Since QGIS 2.10, QgsGeometry acts as a generic container
68+
* for geometry objects. QgsGeometry is implicitly shared, so making copies of geometries is inexpensive. The geometry
69+
* container class can also be stored inside a QVariant object.
70+
*
71+
* The actual geometry representation is stored as a @link QgsAbstractGeometryV2 @endlink within the container, and
72+
* can be accessed via the @link geometry @endlink method or set using the @link setGeometry @endlink method.
73+
*/
6874

6975
class CORE_EXPORT QgsGeometry
7076
{

0 commit comments

Comments
 (0)