Skip to content

Commit

Permalink
Update doxygen comments for QgsGeometry, reflecting that QgsGeometry
Browse files Browse the repository at this point in the history
is a generic geometry container from >= 2.10.
  • Loading branch information
nyalldawson committed Jun 22, 2015
1 parent b4edf8a commit e53debe
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
9 changes: 9 additions & 0 deletions python/core/geometry/qgsgeometry.sip
Expand Up @@ -21,6 +21,15 @@ typedef unsigned long size_t;
typedef unsigned int size_t;
%End

/** \ingroup core
* A geometry is the spatial representation of a feature. Since QGIS 2.10, QgsGeometry acts as a generic container
* for geometry objects. QgsGeometry is implicitly shared, so making copies of geometries is inexpensive. The geometry
* container class can also be stored inside a QVariant object.
*
* The actual geometry representation is stored as a @link QgsAbstractGeometryV2 @endlink within the container, and
* can be accessed via the @link geometry @endlink method or set using the @link setGeometry @endlink method.
*/

class QgsGeometry
{
%TypeHeaderCode
Expand Down
8 changes: 7 additions & 1 deletion src/core/geometry/qgsgeometry.h
Expand Up @@ -64,7 +64,13 @@ class QgsConstWkbPtr;
struct QgsGeometryPrivate;

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

class CORE_EXPORT QgsGeometry
{
Expand Down

0 comments on commit e53debe

Please sign in to comment.