Adding code example to QgsVectorLayer documentation

qgis · Apr 12, 2013 · ec2f5c9211dc71ba6f13fa561e8233058cdc7bfd · ec2f5c9
1 parent 6bc3749
commit ec2f5c9211dc71ba6f13fa561e8233058cdc7bfd
Unified Split

Showing with 6 additions and 0 deletions.

+6 −0 src/core/qgsvectorlayer.h
diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h
@@ -153,6 +153,12 @@ struct CORE_EXPORT QgsVectorJoinInfo
  * The QgsVectorLayer provides a common interface to the different data types.  It also
  * manages editing transactions.
  *
+ *  Sample usage of the QgsVectorLayer class:
+ *
+ * \code
+ *     QString uri = "point?crs=epsg:4326&field=id:integer";
+ *     QgsVectorLayer *scratchLayer = new QgsVectorLayer(uri, "Scratch point layer",  "memory");
+ * \endcode
  *
  * The main data providers supported by QGis are listed below.
  *