Skip to content

Commit

Permalink
Quiet doxygen 1.9.5 errors
Browse files Browse the repository at this point in the history
  • Loading branch information
pramsey committed Nov 14, 2022
1 parent 5d80122 commit ad58f6b
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 22 deletions.
12 changes: 4 additions & 8 deletions include/geos/algorithm/CGAlgorithmsDD.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
16 changes: 9 additions & 7 deletions include/geos/geom/Geometry.h
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class Unload;
} // namespace geos.io
}

namespace geos {
namespace geos { // geos
namespace geom { // geos::geom

/// Geometry types
Expand Down Expand Up @@ -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.
Expand Down
15 changes: 12 additions & 3 deletions include/geos/geom/Triangle.h
Original file line number Diff line number Diff line change
Expand Up @@ -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();

Expand Down
2 changes: 1 addition & 1 deletion include/geos/operation/distance/IndexedFacetDistance.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
///
Expand Down
4 changes: 2 additions & 2 deletions include/geos/operation/overlayng/OverlayNG.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand All @@ -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);

Expand Down
2 changes: 1 addition & 1 deletion include/geos/operation/union/UnaryUnionOp.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit ad58f6b

Please sign in to comment.