Skip to content

Commit 7eeb69c

Browse files
committed
dxf export: complete doxymentation updates (followup 07113b0)
1 parent 07113b0 commit 7eeb69c

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

src/core/dxf/qgsdxfpallabeling.h

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,31 +39,55 @@ class QgsDxfLabelProvider : public QgsVectorLayerLabelProvider
3939
//! construct the provider
4040
explicit QgsDxfLabelProvider( QgsVectorLayer* layer, QgsDxfExport* dxf, const QgsPalLayerSettings *settings );
4141

42-
//! re-implementation that writes to DXF file instead of drawing with QPainter
42+
/** Re-implementation that writes to DXF file instead of drawing with QPainter
43+
* @param context render context
44+
* @param label label
45+
*/
4346
void drawLabel( QgsRenderContext& context, pal::LabelPosition* label ) const override;
4447

45-
//! registration method that keeps track of DXF layer names of individual features
48+
/** Registration method that keeps track of DXF layer names of individual features
49+
* @param feature feature
50+
* @param context render context
51+
* @param dxfLayerName name of dxf layer
52+
*/
4653
void registerDxfFeature( QgsFeature& feature, QgsRenderContext &context, const QString& dxfLayerName );
4754

4855
protected:
4956
//! pointer to parent DXF export where this instance is used
5057
QgsDxfExport* mDxfExport;
5158
};
5259

60+
/** Implements a derived label provider for rule based labels internally used
61+
* for DXF export
62+
*
63+
* Internal class, not in public API. Backported from QGIS 2.15
64+
* @note not available in Python bindings
65+
*/
5366
class QgsDxfRuleBasedLabelProvider : public QgsRuleBasedLabelProvider
5467
{
5568
public:
5669
//! construct the provider
5770
explicit QgsDxfRuleBasedLabelProvider( const QgsRuleBasedLabeling &rules, QgsVectorLayer* layer, QgsDxfExport* dxf );
5871

72+
/** Reinitialize the subproviders with QgsDxfLabelProviders
73+
* @param layer layer
74+
*/
5975
void reinit( QgsVectorLayer* layer );
6076

61-
//! re-implementation that writes to DXF file instead of drawing with QPainter
77+
/** Re-implementation that writes to DXF file instead of drawing with QPainter
78+
* @param context render context
79+
* @param label label
80+
*/
6281
void drawLabel( QgsRenderContext &context, pal::LabelPosition *label ) const override;
6382

64-
//! registration method that keeps track of DXF layer names of individual features
83+
/** Registration method that keeps track of DXF layer names of individual features
84+
* @param feature feature
85+
* @param context render context
86+
* @param dxfLayerName name of dxf layer
87+
*/
6588
void registerDxfFeature( QgsFeature& feature, QgsRenderContext &context, const QString& dxfLayerName );
6689

90+
//! create QgsDxfLabelProvider
6791
virtual QgsVectorLayerLabelProvider *createProvider( QgsVectorLayer *layer, bool withFeatureLoop, const QgsPalLayerSettings *settings ) override;
6892

6993
protected:

0 commit comments

Comments
 (0)