Adding code example to QgsVectorLayer documentation

ccrook · ccrook · commit ec2f5c9211dc · 2013-04-12T20:05:08.000+12:00
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.
  *

Original file line number	Diff line number	Diff line change
`@@ -153,6 +153,12 @@ struct CORE_EXPORT QgsVectorJoinInfo`
`153`	`153`	`* The QgsVectorLayer provides a common interface to the different data types. It also`
`154`	`154`	`* manages editing transactions.`
`155`	`155`	`*`
	`156`	`+ * Sample usage of the QgsVectorLayer class:`
	`157`	`+ *`
	`158`	`+ * \code`
	`159`	`+ * QString uri = "point?crs=epsg:4326&field=id:integer";`
	`160`	`+ * QgsVectorLayer *scratchLayer = new QgsVectorLayer(uri, "Scratch point layer", "memory");`
	`161`	`+ * \endcode`
`156`	`162`	`*`
`157`	`163`	`* The main data providers supported by QGis are listed below.`
`158`	`164`	`*`