Doxymentation for QgsWkbTypes

Author: m-kuhn

src/core/geometry/qgswkbtypes.h

@@ -39,6 +39,29 @@ class CORE_EXPORT QgsWkbTypes
 {
   public:
 
+    /**
+     * The WKB type describes the number of dimensions a geometry has
+     *
+     *  - Point
+     *  - LineString
+     *  - Polygon
+     *
+     * as well as the number of dimensions for each individual vertex
+     *
+     *  - X (always)
+     *  - Y (always)
+     *  - Z (optional)
+     *  - M (measurement value, optional)
+     *
+     * it also has values for multi types, collections, unknown geometry,
+     * null geometry, no geometry and curve support.
+     *
+     * These classes of geometry are often used for data sources to
+     * communicate what kind of geometry should be expected for a given
+     * geometry field. It is also used for tools or algorithms to decide
+     * if they should be available for a given geometry type or act in
+     * a different mode.
+     */
     enum Type
     {
       Unknown = 0,
@@ -99,6 +122,12 @@ class CORE_EXPORT QgsWkbTypes
       MultiPolygon25D
     };
 
+    /**
+     * The geometry types are used to group QgsWkbTypes::Type in a
+     * coarse way.
+     *
+     * @see geometryType( QgsWkbTypes::Type )
+     */
     enum GeometryType
     {
       PointGeometry,
@@ -582,6 +611,7 @@ class CORE_EXPORT QgsWkbTypes
 
     /** Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a
      * PolygonGeometry geometry type.
+     * GeometryCollections are reported as QgsWkbTypes::UnknownGeometry.
      */
     static GeometryType geometryType( Type type )
     {