Dox++

qgis · Nov 9, 2018 · a947bb3 · a947bb3
1 parent 73d0ced
commit a947bb3
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 2 deletions.
diff --git 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<qreal> &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<qreal> dxfCustomDashPattern( QgsUnitTypes::RenderUnit &unit ) const;
 

diff --git a/src/core/symbology/qgslinesymbollayer.h b/src/core/symbology/qgslinesymbollayer.h
@@ -109,9 +109,26 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer
     QVector<qreal> customDashVector() const { return mCustomDashVector; }
     void setCustomDashVector( const QVector<qreal> &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<qreal> dxfCustomDashPattern( QgsUnitTypes::RenderUnit &unit ) const override;