Skip to content

Commit c09e10c

Browse files
committed
Update doc and sip binding
1 parent 70cd928 commit c09e10c

File tree

3 files changed

+37
-2
lines changed

3 files changed

+37
-2
lines changed

python/core/auto_generated/layertree/qgslayertreelayer.sip.in

+11
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,19 @@ Sets the layer's name.
7979
%End
8080

8181
void setUseLayerName( bool use = true );
82+
%Docstring
83+
Uses the layer's name if ``use`` is true, or the name manually set if
84+
false.
85+
86+
.. versionadded:: 3.8
87+
%End
8288

8389
bool useLayerName() const;
90+
%Docstring
91+
Returns whether the layer's name is used, or the name manually set.
92+
93+
.. versionadded:: 3.8
94+
%End
8495

8596
static QgsLayerTreeLayer *readXml( QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
8697
%Docstring

src/core/layertree/qgslayertreelayer.h

+9
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,17 @@ class CORE_EXPORT QgsLayerTreeLayer : public QgsLayerTreeNode
9090
*/
9191
void setName( const QString &n ) override;
9292

93+
/**
94+
* Uses the layer's name if \a use is true, or the name manually set if
95+
* false.
96+
* \since QGIS 3.8
97+
*/
9398
void setUseLayerName( bool use = true );
9499

100+
/**
101+
* Returns whether the layer's name is used, or the name manually set.
102+
* \since QGIS 3.8
103+
*/
95104
bool useLayerName() const;
96105

97106
/**

src/server/services/wms/qgswmsrenderer.h

+17-2
Original file line numberDiff line numberDiff line change
@@ -77,15 +77,30 @@ namespace QgsWms
7777
~QgsRenderer();
7878

7979
/**
80-
* Returns the map legend as an image (or NULLPTR in case of error). The caller takes ownership
81-
of the image object*/
80+
* Returns the map legend as an image (or NULLPTR in case of error). The
81+
* caller takes ownership of the image object.
82+
* \param model The layer tree model to use for building the legend
83+
* \returns the legend as an image
84+
* \since QGIS 3.8
85+
*/
8286
QImage *getLegendGraphics( QgsLayerTreeModel &model );
8387

88+
/**
89+
* Returns the map legend as an image (or NULLPTR in case of error). The
90+
* caller takes ownership of the image object.
91+
* \param nodeModel The node model to use for building the legend
92+
* \returns the legend as an image
93+
* \since QGIS 3.8
94+
*/
8495
QImage *getLegendGraphics( QgsLayerTreeModelLegendNode &nodeModel );
8596

8697
typedef QSet<QString> SymbolSet;
8798
typedef QHash<QgsVectorLayer *, SymbolSet> HitTest;
8899

100+
/**
101+
* Returns the hit test according to the current context.
102+
* \since QGIS 3.8
103+
*/
89104
HitTest symbols();
90105

91106
/**

0 commit comments

Comments
 (0)