From ad58f6b0e50bde2739bee989c0e11aa6b5dceb2b Mon Sep 17 00:00:00 2001 From: Paul Ramsey Date: Mon, 14 Nov 2022 15:56:03 -0800 Subject: [PATCH] Quiet doxygen 1.9.5 errors --- include/geos/algorithm/CGAlgorithmsDD.h | 12 ++++-------- include/geos/geom/Geometry.h | 16 +++++++++------- include/geos/geom/Triangle.h | 15 ++++++++++++--- .../operation/distance/IndexedFacetDistance.h | 2 +- include/geos/operation/overlayng/OverlayNG.h | 4 ++-- include/geos/operation/union/UnaryUnionOp.h | 2 +- 6 files changed, 29 insertions(+), 22 deletions(-) diff --git a/include/geos/algorithm/CGAlgorithmsDD.h b/include/geos/algorithm/CGAlgorithmsDD.h index e9ad4bdff3..cfb62aa801 100644 --- a/include/geos/algorithm/CGAlgorithmsDD.h +++ b/include/geos/algorithm/CGAlgorithmsDD.h @@ -171,15 +171,11 @@ class GEOS_DLL CGAlgorithmsDD { * the circumcentre of an obtuse isosceles triangle lies outside the triangle. * * This method uses @ref geos::math::DD extended-precision arithmetic to provide more accurate - * results than [circumcentre(Coordinate, Coordinate, Coordinate)] - * (@ref geos::geom::Triangle::circumcentre(const CoordinateXY& p0, const CoordinateXY& p1, const CoordinateXY& p2)). + * results than geos::geom::Triangle::circumcentre. * - * @param a - * a vertex of the triangle - * @param b - * a vertex of the triangle - * @param c - * a vertex of the triangle + * @param a a vertex of the triangle + * @param b a vertex of the triangle + * @param c a vertex of the triangle * @return the circumcentre of the triangle */ static geom::CoordinateXY circumcentreDD(const geom::CoordinateXY& a, const geom::CoordinateXY& b, const geom::CoordinateXY& c); diff --git a/include/geos/geom/Geometry.h b/include/geos/geom/Geometry.h index b3549c295c..9331c7fcbf 100644 --- a/include/geos/geom/Geometry.h +++ b/include/geos/geom/Geometry.h @@ -66,7 +66,7 @@ class Unload; } // namespace geos.io } -namespace geos { +namespace geos { // geos namespace geom { // geos::geom /// Geometry types @@ -777,18 +777,20 @@ class GEOS_DLL Geometry { /// Comparator for sorting geometry virtual int compareTo(const Geometry* geom) const; - /** \brief - * Returns the minimum distance between this Geometry - * and the Geometry g - */ - virtual double distance(const Geometry* g) const; - /// Returns the area of this Geometry. virtual double getArea() const; /// Returns the length of this Geometry. virtual double getLength() const; + /** Returns the minimum distance between this Geometry and the Geometry g + * + * @param g the Geometry to calculate distance to + * @return the distance in cartesian units + */ + virtual double distance(const Geometry* g) const; + + /** \brief * Tests whether the distance from this Geometry to another * is less than or equal to a specified value. diff --git a/include/geos/geom/Triangle.h b/include/geos/geom/Triangle.h index ed29315aab..185fc7adb1 100644 --- a/include/geos/geom/Triangle.h +++ b/include/geos/geom/Triangle.h @@ -63,11 +63,20 @@ class GEOS_DLL Triangle { * @param resultPoint the point into which to write the inCentre of the triangle */ void circumcentre(CoordinateXY& resultPoint); + + /** Calculates the circumcentre using double precision math + * @param resultPoint the point into which to write the inCentre of the triangle + */ void circumcentreDD(CoordinateXY& resultPoint); - /** Computes the circumcentre of a triangle. */ - static const CoordinateXY circumcentre( - const CoordinateXY& p0, const CoordinateXY& p1, const CoordinateXY& p2); + /** Computes the circumcentre of a triangle. + * @param p0 corner of the triangle + * @param p1 corner of the triangle + * @param p2 corner of the triangle + * @return the center of the the smallest circle that encloses the triangle + * @overload + */ + static const CoordinateXY circumcentre(const CoordinateXY& p0, const CoordinateXY& p1, const CoordinateXY& p2); bool isIsoceles(); diff --git a/include/geos/operation/distance/IndexedFacetDistance.h b/include/geos/operation/distance/IndexedFacetDistance.h index 40c8482ef9..2a3b984a1f 100644 --- a/include/geos/operation/distance/IndexedFacetDistance.h +++ b/include/geos/operation/distance/IndexedFacetDistance.h @@ -38,7 +38,7 @@ namespace distance { /// an repeated query situation. /// /// Using this technique is usually much more performant than using the -/// brute-force \ref geom::Geometry::distance(const Geometry* g) const when one +/// brute-force geom::Geometry::distance() when one /// or both input geometries are large, or when evaluating many distance /// computations against a single geometry. /// diff --git a/include/geos/operation/overlayng/OverlayNG.h b/include/geos/operation/overlayng/OverlayNG.h index 7fed36bba9..baec92f4c2 100644 --- a/include/geos/operation/overlayng/OverlayNG.h +++ b/include/geos/operation/overlayng/OverlayNG.h @@ -271,7 +271,7 @@ class GEOS_DLL OverlayNG { * the result of overlaying the geometries using * a given overlay operation. * - * The method handles arguments of {@link Location#NONE} correctly + * The method handles arguments of {@link geom::Location::NONE} correctly */ static bool isResultOfOpPoint(const OverlayLabel* label, int opCode); @@ -284,7 +284,7 @@ class GEOS_DLL OverlayNG { * computed during the overlay process should be * included in the result geometry. * - * The method handles arguments of {@link Location#NONE} correctly. + * The method handles arguments of {@link geom::Location::NONE} correctly. */ static bool isResultOfOp(int overlayOpCode, Location loc0, Location loc1); diff --git a/include/geos/operation/union/UnaryUnionOp.h b/include/geos/operation/union/UnaryUnionOp.h index e096b5f333..a5d1574a52 100644 --- a/include/geos/operation/union/UnaryUnionOp.h +++ b/include/geos/operation/union/UnaryUnionOp.h @@ -71,7 +71,7 @@ namespace geounion { // geos::operation::geounion * or portions of line segments will be reduced to a single line segment * in the output. * This is consistent with the semantics of the - * [Geometry::Union(Geometry* )](@ref geom::Geometry::Union(const Geometry* other) const) + * [Geometry::Union(Geometry* )](@ref geom::Geometry::Union()) * operation. If **merged** linework is required, the * [LineMerger](@ref operation::linemerge::LineMerger) class * can be used.