Skip to content

Commit 0cdd80d

Browse files
committed
Update doc
1 parent 89a1b1a commit 0cdd80d

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

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

+7-5
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,11 @@ If ctx is ``None``, this is just first stage when preparing layout - without act
9898

9999
void exportToJson( const QgsLegendSettings &settings, QJsonObject &json );
100100
%Docstring
101-
Entry point called from QgsLegendRenderer to do the rendering in a \a
102-
json object.
101+
Entry point called from QgsLegendRenderer to do the rendering in a
102+
JSON object.
103+
104+
:param settings: Legend layout configuration
105+
:param json: The json object to update
103106

104107
.. versionadded:: 3.8
105108
%End
@@ -117,8 +120,7 @@ Draws symbol on the left side of the item
117120

118121
virtual void exportSymbolToJson( const QgsLegendSettings &settings, QJsonObject &json ) const;
119122
%Docstring
120-
Adds a symbol in base64 string within the ``json`` object with the key
121-
"icon".
123+
Adds a symbol in base64 string within a JSON object with the key "icon".
122124

123125
:param settings: Legend layout configuration
124126
:param json: The json object to update
@@ -139,7 +141,7 @@ Draws label on the right side of the item
139141

140142
void exportSymbolTextToJson( const QgsLegendSettings &settings, QJsonObject &json ) const;
141143
%Docstring
142-
Adds a label in the ``json`` object with the key "title".
144+
Adds a label in a JSON object with the key "title".
143145

144146
:param settings: Legend layout configuration
145147
:param json: The json object to update

src/core/layertree/qgslayertreemodellegendnode.h

+6-8
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,10 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject
111111
virtual ItemMetrics draw( const QgsLegendSettings &settings, ItemContext *ctx );
112112

113113
/**
114-
* Entry point called from QgsLegendRenderer to do the rendering in a \a
115-
* json object.
116-
*
114+
* Entry point called from QgsLegendRenderer to do the rendering in a
115+
* JSON object.
116+
* \param settings Legend layout configuration
117+
* \param json The json object to update
117118
* \since QGIS 3.8
118119
*/
119120
void exportToJson( const QgsLegendSettings &settings, QJsonObject &json );
@@ -128,11 +129,9 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject
128129
virtual QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const;
129130

130131
/**
131-
* Adds a symbol in base64 string within the \a json object with the key
132-
* "icon".
132+
* Adds a symbol in base64 string within a JSON object with the key "icon".
133133
* \param settings Legend layout configuration
134134
* \param json The json object to update
135-
*
136135
* \since QGIS 3.8
137136
*/
138137
virtual void exportSymbolToJson( const QgsLegendSettings &settings, QJsonObject &json ) const;
@@ -147,10 +146,9 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject
147146
virtual QSizeF drawSymbolText( const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize ) const;
148147

149148
/**
150-
* Adds a label in the \a json object with the key "title".
149+
* Adds a label in a JSON object with the key "title".
151150
* \param settings Legend layout configuration
152151
* \param json The json object to update
153-
*
154152
* \since QGIS 3.8
155153
*/
156154
void exportSymbolTextToJson( const QgsLegendSettings &settings, QJsonObject &json ) const;

0 commit comments

Comments
 (0)