Skip to content

Commit 9d9ce20

Browse files
committed
Some doxymentation updates
1 parent 9631688 commit 9d9ce20

File tree

9 files changed

+63
-2
lines changed

9 files changed

+63
-2
lines changed

src/core/composer/qgsscalebarstyle.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,11 @@ class CORE_EXPORT QgsScaleBarStyle
3939
virtual void draw( QPainter* p, double xOffset = 0 ) const = 0; //to do by every subclass
4040
virtual void drawLabels( QPainter* p ) const; //default implementation provided
4141
virtual QRectF calculateBoxSize() const; //default implementation provided
42-
virtual QString name() const = 0; //return name of the style
42+
/**
43+
* Get a name for this style.
44+
* Needs to be remiplmeented by subclasses.
45+
*/
46+
virtual QString name() const = 0;
4347

4448
private:
4549
QgsScaleBarStyle(); //default constructor forbidden

src/core/diagram/qgsdiagram.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ class CORE_EXPORT QgsDiagram
5151

5252
/** Draws the diagram at the given position (in pixel coordinates)*/
5353
virtual void renderDiagram( const QgsFeature& feature, QgsRenderContext& c, const QgsDiagramSettings& s, QPointF position ) = 0;
54+
55+
/**
56+
* Get a descriptive name for this diagram type.
57+
*/
5458
virtual QString diagramName() const = 0;
5559
/** Returns the size in map units the diagram will use to render.*/
5660
virtual QSizeF diagramSize( const QgsAttributes& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s ) = 0;

src/core/geometry/qgsabstractgeometry.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,14 @@ class CORE_EXPORT QgsAbstractGeometry
328328
*/
329329
virtual double vertexAngle( QgsVertexId vertex ) const = 0;
330330

331+
/**
332+
* Returns the number of vertexes of which this geometry is built.
333+
*/
331334
virtual int vertexCount( int part = 0, int ring = 0 ) const = 0;
335+
336+
/**
337+
* Returns the number of rings of which this geometry is built.
338+
*/
332339
virtual int ringCount( int part = 0 ) const = 0;
333340

334341
/** Returns count of parts contained in the geometry.

src/core/geometry/qgssurface.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ class CORE_EXPORT QgsSurface: public QgsAbstractGeometry
3030
{
3131
public:
3232

33+
/**
34+
* Get a polygon representation of this surface.
35+
* Ownership is transferred to the caller.
36+
*/
3337
virtual QgsPolygonV2* surfaceToPolygon() const = 0;
3438

3539
/** Returns the minimal bounding box for the geometry

src/core/raster/qgsrasterresampler.h

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,18 @@ class QgsRasterResampler
3030
public:
3131
virtual ~QgsRasterResampler() {}
3232
virtual void resample( const QImage& srcImage, QImage& dstImage ) = 0;
33+
34+
/**
35+
* Get a descriptive type identifier for this raster resampler.
36+
* Needs to be implemented by subclasses.
37+
*/
3338
virtual QString type() const = 0;
34-
virtual QgsRasterResampler * clone() const = 0;
39+
/**
40+
* Get a deep copy of this object.
41+
* Needs to be reimplemented by subclasses.
42+
* Ownership is transferred to the caller.
43+
*/
44+
virtual QgsRasterResampler* clone() const = 0;
3545
};
3646

3747
#endif // QGSRASTERRESAMPLER_H

src/core/symbology-ng/qgssymbol.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,11 @@ class CORE_EXPORT QgsSymbol
190190

191191
QString dump() const;
192192

193+
/**
194+
* Get a deep copy of this symbol.
195+
* Needs to be reimplemented by subclasses.
196+
* Ownership is transferred to the caller.
197+
*/
193198
virtual QgsSymbol* clone() const = 0;
194199

195200
void toSld( QDomDocument &doc, QDomElement &element, QgsStringMap props ) const;

src/gui/qgsannotationitem.h

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,28 @@ class GUI_EXPORT QgsAnnotationItem: public QgsMapCanvasItem, public QgsAnnotatio
103103
void setFrameBackgroundColor( const QColor& c ) { mFrameBackgroundColor = c; }
104104
QColor frameBackgroundColor() const { return mFrameBackgroundColor; }
105105

106+
/**
107+
* Serialize to XML. The doc is used to generate new nodes.
108+
* Needs to be reimplemented by subclasses.
109+
*/
106110
virtual void writeXml( QDomDocument& doc ) const = 0;
111+
112+
/**
113+
* Deserialize from XML. The itemElem is used as source for the information.
114+
* Needs to be reimplemented by subclasses
115+
*/
107116
virtual void readXml( const QDomDocument& doc, const QDomElement& itemElem ) = 0;
108117

118+
/**
119+
* Serialize to XML. The doc is used to generate new nodes.
120+
* Should be called by subclasses in their writeXml method.
121+
*/
109122
void _writeXml( QDomDocument& doc, QDomElement& itemElem ) const;
123+
124+
/**
125+
* Deserialize from XML. The itemElem is used as source for the information.
126+
* Should be called from subclasses in their readXml method.
127+
*/
110128
void _readXml( const QDomDocument& doc, const QDomElement& annotationElem );
111129

112130
virtual void setItemData( int role, const QVariant& value ) override;

src/gui/qgsdatadefinedbutton.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ class GUI_EXPORT QgsDataDefinedAssistant: public QDialog
4141
public:
4242
QgsDataDefinedAssistant() : mMapCanvas( nullptr ) {}
4343

44+
/**
45+
* Get the data defined which was defined by this assistant.
46+
* Needs to be reimplemented by subclasses.
47+
*/
4448
virtual QgsDataDefined dataDefined() const = 0;
4549

4650
/** Sets the map canvas associated with the widget. This allows the widget to retrieve the current

src/plugins/qgsapplydialog.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ class QgsApplyDialog: public QDialog
3030
public:
3131
QgsApplyDialog(): QDialog() {}
3232
~QgsApplyDialog() {}
33+
34+
/**
35+
* This method is called when changes should be applied.
36+
* It needs to be implemented by subclasses.
37+
*/
3338
virtual void apply() const = 0;
3439
};
3540

0 commit comments

Comments
 (0)