reformulate doxymentation

This commit is contained in:
Denis Rouzaud 2018-01-23 21:28:00 -04:00
parent d60f00dc85
commit 0cc29569f5
2 changed files with 6 additions and 2 deletions

View File

@ -142,7 +142,9 @@ Returns the squared distance between a point and a line.
const QgsPointXY &linePoint1, const QgsPointXY &linePoint2,
QgsPointXY &intersection /In,Out/ );
%Docstring
lineCircleIntersection returns the closest intersection of a line and a circle
Compute the intersection of a line and a circle.
If the intersection has two solutions (points),
the closest point to the initial ``intersection`` point is returned.
@param center the center of the circle
@param radius the radius of the circle
@param linePoint1 a first point on the line

View File

@ -137,7 +137,9 @@ class CORE_EXPORT QgsGeometryUtils
static bool segmentIntersection( const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &q1, const QgsPoint &q2, QgsPoint &intersectionPoint SIP_OUT, bool &isIntersection SIP_OUT, const double tolerance = 1e-8, bool acceptImproperIntersection = false );
/**
* @brief lineCircleIntersection returns the closest intersection of a line and a circle
* @brief Compute the intersection of a line and a circle.
* If the intersection has two solutions (points),
* the closest point to the initial \a intersection point is returned.
* @param center the center of the circle
* @param radius the radius of the circle
* @param linePoint1 a first point on the line