Skip to content

Commit 93bfa94

Browse files
committedMay 13, 2017
Add doxygen comments to updated methods
1 parent bbb13f4 commit 93bfa94

File tree

6 files changed

+22
-0
lines changed

6 files changed

+22
-0
lines changed
 

‎src/core/qgsdiagramrenderer.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,9 @@ class CORE_EXPORT QgsDiagramSettings
423423
//! Scale diagrams smaller than mMinimumSize to mMinimumSize
424424
double minimumSize;
425425

426+
//! Reads diagram settings from XML
426427
void readXml( const QDomElement &elem );
428+
//! Writes diagram settings to XML
427429
void writeXml( QDomElement &rendererElem, QDomDocument &doc ) const;
428430

429431
/** Returns list of legend nodes for the diagram

‎src/core/symbology-ng/qgsfillsymbollayer.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -834,12 +834,19 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer
834834
class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer
835835
{
836836
public:
837+
//! Constructs SVG fill symbol layer with picture from given absolute path to a SVG file
837838
QgsSVGFillSymbolLayer( const QString &svgFilePath, double width = 20, double rotation = 0.0 );
838839
QgsSVGFillSymbolLayer( const QByteArray &svgData, double width = 20, double rotation = 0.0 );
839840
~QgsSVGFillSymbolLayer();
840841

841842
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
842843
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;
844+
845+
/**
846+
* Turns relative paths in properties map to absolute when reading and vice versa when writing.
847+
* Used internally when reading/writing symbols.
848+
* \since QGIS 3.0
849+
*/
843850
static void resolvePaths( QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving );
844851

845852
// implemented from base classes

‎src/core/symbology-ng/qgsheatmaprenderer.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer
5252
virtual QgsSymbolList symbols( QgsRenderContext &context ) override;
5353
virtual QString dump() const override;
5454
virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
55+
//! Creates a new heatmap renderer instance from XML
5556
static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
5657
virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
5758
static QgsHeatmapRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;

‎src/core/symbology-ng/qgsmarkersymbollayer.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -444,6 +444,7 @@ class CORE_EXPORT QgsFilledMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer
444444
class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer
445445
{
446446
public:
447+
//! Constructs SVG marker symbol layer with picture from given absolute path to a SVG file
447448
QgsSvgMarkerSymbolLayer( const QString &path,
448449
double size = DEFAULT_SVGMARKER_SIZE,
449450
double angle = DEFAULT_SVGMARKER_ANGLE,
@@ -453,6 +454,12 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer
453454

454455
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
455456
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;
457+
458+
/**
459+
* Turns relative paths in properties map to absolute when reading and vice versa when writing.
460+
* Used internally when reading/writing symbols.
461+
* \since QGIS 3.0
462+
*/
456463
static void resolvePaths( QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving );
457464

458465
// implemented from base classes

‎src/core/symbology-ng/qgsrulebasedrenderer.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,6 +405,7 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer
405405

406406
/////
407407

408+
//! Creates a new rule-based renderer instance from XML
408409
static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
409410

410411
//! Constructs the renderer from given tree of rules (takes ownership)

‎src/core/symbology-ng/qgssymbollayerutils.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,9 @@ class CORE_EXPORT QgsSymbolLayerUtils
233233
}
234234
}
235235

236+
//! Reads and returns symbol layer from XML. Caller is responsible for deleting the returned object
236237
static QgsSymbolLayer *loadSymbolLayer( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
238+
//! Writes a symbol definition to XML
237239
static QDomElement saveSymbol( const QString &symbolName, QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context );
238240

239241
/** Returns a string representing the symbol. Can be used to test for equality
@@ -348,7 +350,9 @@ class CORE_EXPORT QgsSymbolLayerUtils
348350
static QgsStringMap parseProperties( QDomElement &element );
349351
static void saveProperties( QgsStringMap props, QDomDocument &doc, QDomElement &element );
350352

353+
//! Reads a collection of symbols from XML and returns them in a map. Caller is responsible for deleting returned symbols.
351354
static QgsSymbolMap loadSymbols( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
355+
//! Writes a collection of symbols to XML with specified tagName for the top-level element
352356
static QDomElement saveSymbols( QgsSymbolMap &symbols, const QString &tagName, QDomDocument &doc, const QgsReadWriteContext &context );
353357

354358
static void clearSymbolMap( QgsSymbolMap &symbols );

0 commit comments

Comments
 (0)
Please sign in to comment.