Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
reformulate doxymentation
  • Loading branch information
3nids committed Jan 24, 2018
1 parent d60f00d commit 0cc2956
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion python/core/geometry/qgsgeometryutils.sip.in
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion src/core/geometry/qgsgeometryutils.h
Expand Up @@ -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
Expand Down

0 comments on commit 0cc2956

Please sign in to comment.