Skip to content

Commit ebe4f92

Browse files
committed
Add some class/method documentation
1 parent 1498107 commit ebe4f92

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

src/app/nodetool/qgsnodeeditor.h

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ class QgsSelectedFeature;
2727
class QgsVectorLayer;
2828
class QTableWidget;
2929

30+
/** A widget to select and edit the vertex coordinates of a geometry numerically*/
3031
class QgsNodeEditor : public QDockWidget
3132
{
3233
Q_OBJECT

src/gui/qgsgeometryrubberband.h

+10-3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ class QgsAbstractGeometryV2;
2727
class QgsPointV2;
2828
struct QgsVertexId;
2929

30+
/** A rubberband class for QgsAbstractGeometryV2 (considering curved geometries)*/
3031
class GUI_EXPORT QgsGeometryRubberBand: public QgsMapCanvasItem
3132
{
3233
public:
@@ -63,15 +64,21 @@ class GUI_EXPORT QgsGeometryRubberBand: public QgsMapCanvasItem
6364

6465
/** Sets geometry (takes ownership). Geometry is expected to be in map coordinates */
6566
void setGeometry( QgsAbstractGeometryV2* geom );
67+
/** Returns a pointer to the geometry*/
6668
const QgsAbstractGeometryV2* geometry() { return mGeometry; }
67-
69+
/** Moves vertex to new position (in map coordinates)*/
6870
void moveVertex( const QgsVertexId& id, const QgsPointV2& newPos );
69-
71+
/** Sets fill color for vertex markers*/
7072
void setFillColor( const QColor& c );
73+
/** Sets outline color for vertex markes*/
7174
void setOutlineColor( const QColor& c );
75+
/** Sets outline width*/
7276
void setOutlineWidth( int width );
73-
void setLineStyle( Qt::PenStyle penStyle );
77+
/** Sets pen style*/
78+
void setLineStyle( Qt::PenStyle penStyle )
79+
/** Sets brush style*/
7480
void setBrushStyle( Qt::BrushStyle brushStyle );
81+
/** Sets vertex marker icon type*/
7582
void setIconType( IconType iconType ) { mIconType = iconType; }
7683

7784
protected:

0 commit comments

Comments
 (0)