diff --git a/python/core/auto_generated/symbology/qgslinesymbollayer.sip.in b/python/core/auto_generated/symbology/qgslinesymbollayer.sip.in index 5eaaf45a825..61d9bce9ac6 100644 --- a/python/core/auto_generated/symbology/qgslinesymbollayer.sip.in +++ b/python/core/auto_generated/symbology/qgslinesymbollayer.sip.in @@ -103,7 +103,26 @@ Returns the units for lengths used in the custom dash pattern. void setCustomDashVector( const QVector &vector ); bool drawInsidePolygon() const; +%Docstring +Returns true if the line should only be drawn inside polygons, and any portion +of the line which falls outside the polygon should be clipped away. + +This setting only has an effect when the line symbol is being +used to render polygon rings. + +.. seealso:: :py:func:`setDrawInsidePolygon` +%End + void setDrawInsidePolygon( bool drawInsidePolygon ); +%Docstring +Sets whether the line should only be drawn inside polygons, and any portion +of the line which falls outside the polygon should be clipped away. + +This setting only has an effect when the line symbol is being +used to render polygon rings. + +.. seealso:: :py:func:`drawInsidePolygon` +%End virtual QVector dxfCustomDashPattern( QgsUnitTypes::RenderUnit &unit ) const; diff --git a/src/core/symbology/qgslinesymbollayer.h b/src/core/symbology/qgslinesymbollayer.h index 13af0767559..23432957bd4 100644 --- a/src/core/symbology/qgslinesymbollayer.h +++ b/src/core/symbology/qgslinesymbollayer.h @@ -109,9 +109,26 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer QVector customDashVector() const { return mCustomDashVector; } void setCustomDashVector( const QVector &vector ) { mCustomDashVector = vector; } - //Returns true if the line should only be drawn inside the polygon + /** + * Returns true if the line should only be drawn inside polygons, and any portion + * of the line which falls outside the polygon should be clipped away. + * + * This setting only has an effect when the line symbol is being + * used to render polygon rings. + * + * \see setDrawInsidePolygon() + */ bool drawInsidePolygon() const { return mDrawInsidePolygon; } - //Set to true if the line should only be drawn inside the polygon + + /** + * Sets whether the line should only be drawn inside polygons, and any portion + * of the line which falls outside the polygon should be clipped away. + * + * This setting only has an effect when the line symbol is being + * used to render polygon rings. + * + * \see drawInsidePolygon() + */ void setDrawInsidePolygon( bool drawInsidePolygon ) { mDrawInsidePolygon = drawInsidePolygon; } QVector dxfCustomDashPattern( QgsUnitTypes::RenderUnit &unit ) const override;