Dox

nyalldawson · nyalldawson · commit a98d12e1e0e9 · 2019-06-04T06:18:17.000+10:00
diff --git a/python/core/auto_generated/qgslabelsearchtree.sip.in b/python/core/auto_generated/qgslabelsearchtree.sip.in
@@ -11,6 +11,7 @@
 
 
 
+
 class QgsLabelSearchTree
 {
 %Docstring
diff --git a/python/core/auto_generated/qgspallabeling.sip.in b/python/core/auto_generated/qgspallabeling.sip.in
@@ -19,8 +19,27 @@ class QgsLabelPosition
 #include "qgspallabeling.h"
 %End
   public:
+
     QgsLabelPosition( QgsFeatureId id, double r, const QVector< QgsPointXY > &corners, const QgsRectangle &rect, double w, double h, const QString &layer, const QString &labeltext, const QFont &labelfont, bool upside_down, bool diagram = false, bool pinned = false, const QString &providerId = QString(),
                       const QgsGeometry &labelGeometry = QgsGeometry() );
+%Docstring
+Constructor for QgsLabelPosition.
+
+:param id: associated feature ID
+:param r: label rotation in degrees clockwise
+:param corners: corner points of label bounding box, in map units
+:param rect: label bounding box, in map units
+:param w: width of label, in map units
+:param h: height of label, in map units
+:param layer: ID of associated map layer
+:param labeltext: text rendered for label
+:param labelfont: font used to render label
+:param upside_down: ``True`` if label is upside down
+:param diagram: ``True`` if label is a diagram
+:param pinned: ``True`` if label has pinned placement
+:param providerId: ID of associated label provider
+:param labelGeometry: polygon geometry of label boundary
+%End
 
     QgsLabelPosition();
 %Docstring
diff --git a/src/core/qgspallabeling.h b/src/core/qgspallabeling.h
@@ -79,6 +79,24 @@ class QgsExpressionContext;
 class CORE_EXPORT QgsLabelPosition
 {
   public:
+
+    /**
+     * Constructor for QgsLabelPosition.
+     * \param id associated feature ID
+     * \param r label rotation in degrees clockwise
+     * \param corners corner points of label bounding box, in map units
+     * \param rect label bounding box, in map units
+     * \param w width of label, in map units
+     * \param h height of label, in map units
+     * \param layer ID of associated map layer
+     * \param labeltext text rendered for label
+     * \param labelfont font used to render label
+     * \param upside_down TRUE if label is upside down
+     * \param diagram TRUE if label is a diagram
+     * \param pinned TRUE if label has pinned placement
+     * \param providerId ID of associated label provider
+     * \param labelGeometry polygon geometry of label boundary
+     */
     QgsLabelPosition( QgsFeatureId id, double r, const QVector< QgsPointXY > &corners, const QgsRectangle &rect, double w, double h, const QString &layer, const QString &labeltext, const QFont &labelfont, bool upside_down, bool diagram = false, bool pinned = false, const QString &providerId = QString(),
                       const QgsGeometry &labelGeometry = QgsGeometry() )
       : featureId( id )

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`
`13`	`13`
	`14`	`+`
`14`	`15`	`class QgsLabelSearchTree`
`15`	`16`	`{`
`16`	`17`	`%Docstring`