Skip to content

Commit a60b31d

Browse files
3nids3nids
committedApr 25, 2017
fix doxymentation
·
ltr-3_40final-3_0_0
1 parent 1577091 commit a60b31d

File tree

3 files changed

+68
-7
lines changed

3 files changed

+68
-7
lines changed
 

‎python/core/layertree/qgslayertreemodellegendnode.sip

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111

1212

13+
14+
1315
class QgsLayerTreeModelLegendNode : QObject
1416
{
1517
%Docstring
@@ -166,7 +168,14 @@ class QgsSymbolLegendNode : QgsLayerTreeModelLegendNode
166168
#include "qgslayertreemodellegendnode.h"
167169
%End
168170
public:
171+
169172
QgsSymbolLegendNode( QgsLayerTreeLayer *nodeLayer, const QgsLegendSymbolItem &item, QObject *parent /TransferThis/ = 0 );
173+
%Docstring
174+
Constructor for QgsSymbolLegendNode.
175+
\param nodeLayer layer node
176+
\param item the legend symbol item
177+
\param parent attach a parent QObject to the legend node.
178+
%End
170179

171180
virtual Qt::ItemFlags flags() const;
172181
virtual QVariant data( int role ) const;
@@ -260,7 +269,16 @@ class QgsSimpleLegendNode : QgsLayerTreeModelLegendNode
260269
#include "qgslayertreemodellegendnode.h"
261270
%End
262271
public:
272+
263273
QgsSimpleLegendNode( QgsLayerTreeLayer *nodeLayer, const QString &label, const QIcon &icon = QIcon(), QObject *parent /TransferThis/ = 0, const QString &key = QString() );
274+
%Docstring
275+
Constructor for QgsSimpleLegendNode.
276+
\param nodeLayer layer node
277+
\param label label
278+
\param icon icon
279+
\param parent attach a parent QObject to the legend node.
280+
\param key the rule key
281+
%End
264282

265283
virtual QVariant data( int role ) const;
266284

@@ -279,7 +297,14 @@ class QgsImageLegendNode : QgsLayerTreeModelLegendNode
279297
#include "qgslayertreemodellegendnode.h"
280298
%End
281299
public:
300+
282301
QgsImageLegendNode( QgsLayerTreeLayer *nodeLayer, const QImage &img, QObject *parent /TransferThis/ = 0 );
302+
%Docstring
303+
Constructor for QgsImageLegendNode.
304+
\param nodeLayer layer node
305+
\param img the image
306+
\param parent attach a parent QObject to the legend node.
307+
%End
283308

284309
virtual QVariant data( int role ) const;
285310

@@ -300,7 +325,15 @@ class QgsRasterSymbolLegendNode : QgsLayerTreeModelLegendNode
300325
#include "qgslayertreemodellegendnode.h"
301326
%End
302327
public:
328+
303329
QgsRasterSymbolLegendNode( QgsLayerTreeLayer *nodeLayer, const QColor &color, const QString &label, QObject *parent /TransferThis/ = 0 );
330+
%Docstring
331+
Constructor for QgsRasterSymbolLegendNode.
332+
\param nodeLayer layer node
333+
\param color color
334+
\param label label
335+
\param parent attach a parent QObject to the legend node.
336+
%End
304337

305338
virtual QVariant data( int role ) const;
306339

@@ -327,7 +360,7 @@ class QgsWmsLegendNode : QgsLayerTreeModelLegendNode
327360
%Docstring
328361
Constructor for QgsWmsLegendNode.
329362
\param nodeLayer layer node
330-
\param parent parent object
363+
\param parent attach a parent QObject to the legend node.
331364
%End
332365

333366
virtual QVariant data( int role ) const;

‎src/core/layertree/qgslayertreemodellegendnode.h

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,13 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode
150150
Q_OBJECT
151151

152152
public:
153+
154+
/**
155+
* Constructor for QgsSymbolLegendNode.
156+
* \param nodeLayer layer node
157+
* \param item the legend symbol item
158+
* \param parent attach a parent QObject to the legend node.
159+
*/
153160
QgsSymbolLegendNode( QgsLayerTreeLayer *nodeLayer, const QgsLegendSymbolItem &item, QObject *parent SIP_TRANSFERTHIS = nullptr );
154161

155162
virtual Qt::ItemFlags flags() const override;
@@ -250,6 +257,15 @@ class CORE_EXPORT QgsSimpleLegendNode : public QgsLayerTreeModelLegendNode
250257
Q_OBJECT
251258

252259
public:
260+
261+
/**
262+
* Constructor for QgsSimpleLegendNode.
263+
* \param nodeLayer layer node
264+
* \param label label
265+
* \param icon icon
266+
* \param parent attach a parent QObject to the legend node.
267+
* \param key the rule key
268+
*/
253269
QgsSimpleLegendNode( QgsLayerTreeLayer *nodeLayer, const QString &label, const QIcon &icon = QIcon(), QObject *parent SIP_TRANSFERTHIS = nullptr, const QString &key = QString() );
254270

255271
virtual QVariant data( int role ) const override;
@@ -272,6 +288,13 @@ class CORE_EXPORT QgsImageLegendNode : public QgsLayerTreeModelLegendNode
272288
Q_OBJECT
273289

274290
public:
291+
292+
/**
293+
* Constructor for QgsImageLegendNode.
294+
* \param nodeLayer layer node
295+
* \param img the image
296+
* \param parent attach a parent QObject to the legend node.
297+
*/
275298
QgsImageLegendNode( QgsLayerTreeLayer *nodeLayer, const QImage &img, QObject *parent SIP_TRANSFERTHIS = nullptr );
276299

277300
virtual QVariant data( int role ) const override;
@@ -292,6 +315,14 @@ class CORE_EXPORT QgsRasterSymbolLegendNode : public QgsLayerTreeModelLegendNode
292315
Q_OBJECT
293316

294317
public:
318+
319+
/**
320+
* Constructor for QgsRasterSymbolLegendNode.
321+
* \param nodeLayer layer node
322+
* \param color color
323+
* \param label label
324+
* \param parent attach a parent QObject to the legend node.
325+
*/
295326
QgsRasterSymbolLegendNode( QgsLayerTreeLayer *nodeLayer, const QColor &color, const QString &label, QObject *parent SIP_TRANSFERTHIS = nullptr );
296327

297328
virtual QVariant data( int role ) const override;
@@ -316,9 +347,10 @@ class CORE_EXPORT QgsWmsLegendNode : public QgsLayerTreeModelLegendNode
316347

317348
public:
318349

319-
/** Constructor for QgsWmsLegendNode.
350+
/**
351+
* Constructor for QgsWmsLegendNode.
320352
* \param nodeLayer layer node
321-
* \param parent parent object
353+
* \param parent attach a parent QObject to the legend node.
322354
*/
323355
QgsWmsLegendNode( QgsLayerTreeLayer *nodeLayer, QObject *parent SIP_TRANSFERTHIS = nullptr );
324356

‎tests/src/python/acceptable_missing_doc.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@
6767
"QgsFieldValidator": ["QgsFieldValidator(QObject *parent, const QgsField &field, const QString &defaultValue, const QString &dateFormat=\"yyyy-MM-dd\")", "dateFormat() const "],
6868
"QgsProviderCountCalcEvent": ["QgsProviderCountCalcEvent(long featuresCounted)", "featuresCounted() const "],
6969
"QgsFeatureListViewDelegate": ["editButtonClicked(QModelIndex &index)", "positionToElement(QPoint pos)", "QgsFeatureListViewDelegate(QgsFeatureListModel *listModel, QObject *parent=nullptr)", "setCurrentFeatureEdited(bool state)", "setFeatureSelectionModel(QgsFeatureSelectionModel *featureSelectionModel)", "Element", "setEditSelectionModel(QItemSelectionModel *editSelectionModel)"],
70-
"QgsImageLegendNode": ["QgsImageLegendNode(QgsLayerTreeLayer *nodeLayer, const QImage &img, QObject *parent=nullptr)"],
7170
"QgsVectorLayerRenderer": ["QgsVectorLayerRenderer(QgsVectorLayer *layer, QgsRenderContext &context)"],
7271
"QgsQueryBuilder": ["sql()", "clear()", "setSql(const QString &sqlStatement)", "setDatasourceDescription(const QString &uri)"],
7372
"QgsPalLabeling": ["dataDefinedTextStyle(QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)", "setShowingPartialsLabels(bool showing)", "setDrawingOutlineLabels(bool outline)", "setNumCandidatePositions(int candPoint, int candLine, int candPolygon)", "isShowingAllLabels() const ", "isShowingShadowRectangles() const ", "numCandidatePositions(int &candPoint, int &candLine, int &candPolygon)", "drawLabelShadow(QgsRenderContext &context, const QgsLabelComponent &component, const QgsPalLayerSettings &tmpLyr)", "setShowingCandidates(bool showing)", "drawLabelBuffer(QgsRenderContext &context, const QgsLabelComponent &component, const QgsPalLayerSettings &tmpLyr)", "isShowingCandidates() const ", "dataDefinedTextBuffer(QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)", "setShowingShadowRectangles(bool showing)", "Search", "dataDefinedTextFormatting(QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)", "setSearchMethod(Search s)", "DrawLabelType", "isShowingPartialsLabels() const ", "drawLabelBackground(QgsRenderContext &context, QgsLabelComponent component, const QgsPalLayerSettings &tmpLyr)", "dataDefinedDropShadow(QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)", "dataDefinedShapeBackground(QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)", "clearEngineSettings()", "searchMethod() const ", "deleteTemporaryData()", "setShowingAllLabels(bool showing)", "staticWillUseLayer(const QString &layerID)", "saveEngineSettings()"],
@@ -91,7 +90,6 @@
9190
"QgsProviderMetadata": ["QgsProviderMetadata(const QString &_key, const QString &_description, const QString &_library)"],
9291
"QgsAbstractFeatureIteratorFromSource": ["QgsAbstractFeatureIteratorFromSource(T *source, bool ownSource, const QgsFeatureRequest &request)"],
9392
"pal::PolygonCostCalculator": ["PolygonCostCalculator(LabelPosition *lp)", "update(pal::PointSet *pset)", "getCost()", "getLabel()"],
94-
"QgsSimpleLegendNode": ["QgsSimpleLegendNode(QgsLayerTreeLayer *nodeLayer, const QString &label, const QIcon &icon=QIcon(), QObject *parent=nullptr, const QString &key=QString())"],
9593
"QgsDataSourceUri": ["SSLmode"],
9694
"HalfEdge": ["HalfEdge(int dual, int next, int point, bool mbreak, bool forced)"],
9795
"QgsTransactionGroup": ["QgsTransactionGroup(QObject *parent=0)"],
@@ -243,7 +241,6 @@
243241
"QgsExpression::NodeCondition": ["NodeCondition(const WhenThenList &conditions, Node *elseExp=nullptr)", "NodeCondition(WhenThenList *conditions, Node *elseExp=nullptr)"],
244242
"QgsComposerEffect": ["setCompositionMode(QPainter::CompositionMode compositionMode)"],
245243
"QgsHighlight": ["QgsHighlight(QgsMapCanvas *mapCanvas, const QgsGeometry *geom, QgsMapLayer *layer)", "layer() const ", "QgsHighlight(QgsMapCanvas *mapCanvas, const QgsGeometry *geom, QgsVectorLayer *layer)"],
246-
"QgsRasterSymbolLegendNode": ["QgsRasterSymbolLegendNode(QgsLayerTreeLayer *nodeLayer, const QColor &color, const QString &label, QObject *parent=nullptr)"],
247244
"QgsExternalResourceWidgetFactory": ["QgsExternalResourceWidgetFactory(const QString &name)"],
248245
"QgsComposerTableV2": ["QgsComposerTableV2(QgsComposition *composition, bool createUndoCommands)"],
249246
"QgsVectorDataProvider": ["convertValue(QVariant::Type type, const QString &value)", "clearMinMaxCache()", "pushError(const QString &msg)", "fillMinMaxCache()"],
@@ -656,7 +653,6 @@
656653
"QgsDataDefinedWidthDialog": ["QgsDataDefinedWidthDialog(const QList< QgsSymbol * > &symbolList, QgsVectorLayer *layer)"],
657654
"QgsDoubleBoxScaleBarStyle": ["QgsDoubleBoxScaleBarStyle(const QgsComposerScaleBar *bar)"],
658655
"QgsAddRemoveItemCommand": ["QgsAddRemoveItemCommand(State s, QgsComposerItem *item, QgsComposition *c, const QString &text, QUndoCommand *parent=nullptr)", "State", "itemRemoved(QgsComposerItem *item)", "itemAdded(QgsComposerItem *item)"],
659-
"QgsSymbolLegendNode": ["QgsSymbolLegendNode(QgsLayerTreeLayer *nodeLayer, const QgsLegendSymbolItem &item, QObject *parent=nullptr)"],
660656
"QgsFeatureIteratorDataStream": ["readNextEntry()"],
661657
"QgsWkbTypes": ["GeometryType", "Type"],
662658
"QgsExpression::NodeBinaryOperator": ["computeDouble(double x, double y)", "computeInt(int x, int y)", "op() const ", "opLeft() const ", "compare(double diff)", "NodeBinaryOperator(BinaryOperator op, Node *opLeft, Node *opRight)", "opRight() const ", "precedence() const ", "computeDateTimeFromInterval(const QDateTime &d, QgsExpression::Interval *i)", "leftAssociative() const "],

0 commit comments

Comments
 (0)
Please sign in to comment.