Skip to content
Permalink
Browse files

Doxymentation update

Or how to increase documentation coverage with minimal effort
  • Loading branch information
m-kuhn committed Sep 14, 2015
1 parent 687ad5a commit 0a60bab51288812f148306f3b50294f713b0af33
Showing with 31 additions and 2 deletions.
  1. +31 −2 src/core/geometry/qgscircularstringv2.h
@@ -55,40 +55,69 @@ class CORE_EXPORT QgsCircularStringV2: public QgsCurveV2
/** Returns the point at index i within the circular string.
*/
QgsPointV2 pointN( int i ) const;

/**
* @copydoc QgsCurveV2::points()
*/
void points( QList<QgsPointV2>& pts ) const override;

/** Sets the circular string's points
*/
void setPoints( const QList<QgsPointV2>& points );

//curve interface
/**
* @copydoc QgsAbstractGeometryV2::length()
*/
virtual double length() const override;

/**
* @copydoc QgsCurveV2::startPoint()
*/
virtual QgsPointV2 startPoint() const override;
/**
* @copydoc QgsCurveV2::endPoint()
*/
virtual QgsPointV2 endPoint() const override;
/**
* @copydoc QgsCurveV2::curveToLine()
*/
virtual QgsLineStringV2* curveToLine() const override;

void draw( QPainter& p ) const override;
/** Transforms the geometry using a coordinate transform
* @param ct coordinate transform
@param d transformation direction
* @param d transformation direction
*/
void transform( const QgsCoordinateTransform& ct, QgsCoordinateTransform::TransformDirection d = QgsCoordinateTransform::ForwardTransform ) override;
void transform( const QTransform& t ) override;
#if 0
void clip( const QgsRectangle& rect ) override;
#endif
void addToPainterPath( QPainterPath& path ) const override;

/**
* @copydoc QgsCurveV2::drawAsPolygon()
*/
void drawAsPolygon( QPainter& p ) const override;

virtual bool insertVertex( const QgsVertexId& position, const QgsPointV2& vertex ) override;
virtual bool moveVertex( const QgsVertexId& position, const QgsPointV2& newPos ) override;
virtual bool deleteVertex( const QgsVertexId& position ) override;

double closestSegment( const QgsPointV2& pt, QgsPointV2& segmentPt, QgsVertexId& vertexAfter, bool* leftOf, double epsilon ) const override;
/**
* @copydoc QgsCurveV2::pointAt()
*/
bool pointAt( int i, QgsPointV2& vertex, QgsVertexId::VertexType& type ) const override;

/**
* @copydoc QgsCurveV2::sumUpArea()
*/
void sumUpArea( double& sum ) const override;

/**
* @copydoc QgsAbstractGeometryV2::hasCurvedSegments()
*/
bool hasCurvedSegments() const override { return true; }

/** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments.

4 comments on commit 0a60bab

@nyalldawson

This comment has been minimized.

Copy link
Collaborator

@nyalldawson nyalldawson replied Sep 14, 2015

@m-kuhn just a note, the doc coverage test ignores methods which are overrides ;)

@m-kuhn

This comment has been minimized.

Copy link
Member Author

@m-kuhn m-kuhn replied Sep 14, 2015

@nyalldawson Does doxygen generate these by default?

@nyalldawson

This comment has been minimized.

Copy link
Collaborator

@nyalldawson nyalldawson replied Sep 14, 2015

@m-kuhn looks like it, but slightly broken. Eg:

http://qgis.org/api/classQgsComposerLabel.html

under "public member functions inherited from QgsComposerItem" the briefs are correctly shown, but the "more" links do nothing. Clicking the member name correctly takes you to the corresponding docs in QgsComposerItem

@m-kuhn

This comment has been minimized.

Copy link
Member Author

@m-kuhn m-kuhn replied Sep 14, 2015

The overridden ones are even better... No need for such commits. I'll invest my time better next time ;)

Please sign in to comment.
You can’t perform that action at this time.