Update doxygen comments for QgsGeometry, reflecting that QgsGeometry

is a generic geometry container from >= 2.10.
This commit is contained in:
Nyall Dawson 2015-06-22 19:42:18 +10:00
parent b4edf8af88
commit e53debe215
2 changed files with 16 additions and 1 deletions

View File

@ -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

View File

@ -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
{