[geos-commits] [SCM] GEOS branch master updated. 62a53152ea083e3c6e45db5893a950e97fa3dfd5
git at osgeo.org
git at osgeo.org
Thu May 30 02:23:50 PDT 2019
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GEOS".
The branch, master has been updated
via 62a53152ea083e3c6e45db5893a950e97fa3dfd5 (commit)
from bfd873e5b7d20f08eaa8be86497daadf6f355359 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 62a53152ea083e3c6e45db5893a950e97fa3dfd5
Author: nila <n_larsson at yahoo.com>
Date: Wed May 22 14:29:59 2019 +0200
Fix inconsistent doxygen documentation
diff --git a/include/geos/algorithm/Distance.h b/include/geos/algorithm/Distance.h
index c9e54a6..68009a4 100644
--- a/include/geos/algorithm/Distance.h
+++ b/include/geos/algorithm/Distance.h
@@ -60,7 +60,7 @@ public:
*
* @param p
* a point
- * @param line
+ * @param seq
* a sequence of contiguous line segments defined by their vertices
* @return the minimum distance between the point and the line segments
*/
diff --git a/include/geos/algorithm/Length.h b/include/geos/algorithm/Length.h
index 4d1a13f..250b355 100644
--- a/include/geos/algorithm/Length.h
+++ b/include/geos/algorithm/Length.h
@@ -38,7 +38,7 @@ public:
/**
* Computes the length of a linestring specified by a sequence of points.
*
- * @param pts the points specifying the linestring
+ * @param ring the points specifying the linestring
* @return the length of the linestring
*/
static double ofLine(const geom::CoordinateSequence* ring);
diff --git a/include/geos/algorithm/LineIntersector.h b/include/geos/algorithm/LineIntersector.h
index 8702459..fad89ad 100644
--- a/include/geos/algorithm/LineIntersector.h
+++ b/include/geos/algorithm/LineIntersector.h
@@ -109,7 +109,7 @@ public:
//
/// No getter is provided, because the precision model is not required
/// to be specified.
- /// @param precisionModel the PrecisionModel to use for rounding
+ /// @param newPM the PrecisionModel to use for rounding
///
void
setPrecisionModel(const geom::PrecisionModel* newPM)
@@ -251,7 +251,7 @@ public:
* Computes the "edge distance" of an intersection point along the specified
* input line segment.
*
- * @param segmentIndex is 0 or 1
+ * @param geomIndex is 0 or 1
* @param intIndex is 0 or 1
*
* @return the edge distance of the intersection point
diff --git a/include/geos/algorithm/MinimumDiameter.h b/include/geos/algorithm/MinimumDiameter.h
index 31ba1bb..7f6bb14 100644
--- a/include/geos/algorithm/MinimumDiameter.h
+++ b/include/geos/algorithm/MinimumDiameter.h
@@ -112,8 +112,8 @@ public:
* (e.g. a convex Polygon or LinearRing,
* or a two-point LineString, or a Point).
*
- * @param geom a Geometry which is convex
- * @param isConvex <code>true</code> if the input geometry is convex
+ * @param newInputGeom a Geometry which is convex
+ * @param newIsConvex <code>true</code> if the input geometry is convex
*/
MinimumDiameter(const geom::Geometry* newInputGeom,
const bool newIsConvex);
diff --git a/include/geos/geom/CoordinateList.h b/include/geos/geom/CoordinateList.h
index bb2efc7..a6ee5bf 100644
--- a/include/geos/geom/CoordinateList.h
+++ b/include/geos/geom/CoordinateList.h
@@ -123,7 +123,7 @@ public:
* Inserts the specified coordinate at the specified position in this list.
*
* @param pos the position at which to insert
- * @param coord the coordinate to insert
+ * @param c the coordinate to insert
* @param allowRepeated if set to false, repeated coordinates are collapsed
*
* @return an iterator to the newly installed coordinate
diff --git a/include/geos/geom/CoordinateSequence.h b/include/geos/geom/CoordinateSequence.h
index 230492a..711f06a 100644
--- a/include/geos/geom/CoordinateSequence.h
+++ b/include/geos/geom/CoordinateSequence.h
@@ -124,38 +124,32 @@ public:
///
/// This method is a port of the toCoordinateArray() method of JTS.
///
- virtual void toVector(std::vector<Coordinate>& coords) const = 0;
+ virtual void toVector(std::vector<Coordinate>& coords) const = 0;
/**
* \brief Add an array of coordinates
- * @param vc The coordinates
+ * @param vc the coordinates
* @param allowRepeated if set to false, repeated coordinates
- * are collapsed
- * @return true (as by general collection contract)
+ * are collapsed
*/
void add(const std::vector<Coordinate>* vc, bool allowRepeated);
/** \brief
* Add an array of coordinates
*
- * @param cl The coordinates
- *
+ * @param cl the coordinates
* @param allowRepeated
- * if set to false, repeated coordinates are collapsed
- *
+ * if set to false, repeated coordinates are collapsed
* @param direction if false, the array is added in reverse order
- *
- * @return true (as by general collection contract)
*/
void add(const CoordinateSequence* cl, bool allowRepeated,
bool direction);
/**
* \brief Add a coordinate
- * @param c The coordinate to add
+ * @param c the coordinate to add
* @param allowRepeated if set to false, repeated coordinates
- * are collapsed
- * @return true (as by general collection contract)
+ * are collapsed
*/
virtual void add(const Coordinate& c, bool allowRepeated);
@@ -173,19 +167,19 @@ public:
virtual void add(std::size_t i, const Coordinate& coord, bool allowRepeated) = 0;
/// Returns <code>true</code> it list contains no coordinates.
- virtual bool isEmpty() const = 0;
+ virtual bool isEmpty() const = 0;
/// Add a Coordinate to the list
- virtual void add(const Coordinate& c) = 0;
+ virtual void add(const Coordinate& c) = 0;
/// Copy Coordinate c to position pos
- virtual void setAt(const Coordinate& c, std::size_t pos) = 0;
+ virtual void setAt(const Coordinate& c, std::size_t pos) = 0;
/// Get a string representation of CoordinateSequence
virtual std::string toString() const = 0;
/// Substitute Coordinate list with a copy of the given vector
- virtual void setPoints(const std::vector<Coordinate>& v) = 0;
+ virtual void setPoints(const std::vector<Coordinate>& v) = 0;
/// Returns true if contains any two consecutive points
bool hasRepeatedPoints() const;
@@ -266,7 +260,7 @@ public:
*
* @param index the coordinate index in the sequence
* @param ordinateIndex the ordinate index in the coordinate
- * (in range [0, dimension-1])
+ * (in range [0, dimension-1])
*/
virtual double getOrdinate(std::size_t index, std::size_t ordinateIndex) const = 0;
@@ -300,7 +294,7 @@ public:
*
* @param index the coordinate index in the sequence
* @param ordinateIndex the ordinate index in the coordinate
- * (in range [0, dimension-1])
+ * (in range [0, dimension-1])
* @param value the new ordinate value
*/
virtual void setOrdinate(std::size_t index, std::size_t ordinateIndex, double value) = 0;
diff --git a/include/geos/geom/Envelope.h b/include/geos/geom/Envelope.h
index d7de720..27c4d1b 100644
--- a/include/geos/geom/Envelope.h
+++ b/include/geos/geom/Envelope.h
@@ -292,8 +292,7 @@ public:
* Expands this envelope by a given distance in all directions.
* Both positive and negative distances are supported.
*
- * @param distance the distance to expand the envelope
- * @return this envelope
+ * @param p_distance the distance to expand the envelope
*/
void
expandBy(double p_distance)
@@ -395,7 +394,7 @@ public:
* Check if the point p
* intersects (lies inside) the region of this Envelope.
*
- * @param p the Coordinate to be tested
+ * @param p the Coordinate to be tested
* @return true if the point intersects this Envelope
*/
bool intersects(const Coordinate& p) const;
diff --git a/include/geos/geom/Geometry.h b/include/geos/geom/Geometry.h
index f6fa6e3..b7aef91 100644
--- a/include/geos/geom/Geometry.h
+++ b/include/geos/geom/Geometry.h
@@ -396,7 +396,7 @@ public:
* - <code>! g.intersects(this)</code>
* (<code>disjoint</code> is the inverse of <code>intersects</code>)
*
- * @param g the Geometry with which to compare this Geometry
+ * @param other the Geometry with which to compare this Geometry
* @return true if the two <code>Geometry</code>s are disjoint
*
* @see Geometry::intersects
diff --git a/include/geos/geom/GeometryFactory.h b/include/geos/geom/GeometryFactory.h
index 8af6aaf..e90cef9 100644
--- a/include/geos/geom/GeometryFactory.h
+++ b/include/geos/geom/GeometryFactory.h
@@ -293,14 +293,13 @@ public:
* and hence if any MultiGeometries are contained in the input a
* GeometryCollection containing them will be returned.
*
- * @param newGeoms the <code>Geometry</code>s to combine
+ * @param geoms the <code>Geometry</code>s to combine
*
- * @return
- * A <code>Geometry</code> of the "smallest", "most type-specific"
- * class that can contain the elements of <code>geomList</code>.
+ * @return A <code>Geometry</code> of the "smallest", "most type-specific"
+ * class that can contain the elements of <code>geomList</code>.
*
* NOTE: the returned Geometry will take ownership of the
- * given vector AND its elements
+ * given vector AND its elements
*/
Geometry* buildGeometry(std::vector<Geometry*>* geoms) const;
diff --git a/include/geos/geom/LineSegment.h b/include/geos/geom/LineSegment.h
index 008d48a..3ef5d9c 100644
--- a/include/geos/geom/LineSegment.h
+++ b/include/geos/geom/LineSegment.h
@@ -104,7 +104,7 @@ public:
* Determines the orientation of a LineSegment relative to this segment.
* The concept of orientation is specified as follows:
* Given two line segments A and L,
- * <ul
+ * <ul>
* <li>A is to the left of a segment L if A lies wholly in the
* closed half-plane lying to the left of L
* <li>A is to the right of a segment L if A lies wholly in the
@@ -119,7 +119,7 @@ public:
* @return 1 if seg is to the left of this segment
* @return -1 if seg is to the right of this segment
* @return 0 if seg has indeterminate orientation relative
- * to this segment
+ * to this segment
*/
int orientationIndex(const LineSegment& seg) const;
@@ -133,7 +133,7 @@ public:
* The orientation index is as defined in
* Orientation::index.
*
- * @param seg the LineSegment to compare
+ * @param p the Coordinate to compare
*
* @return 1 if <code>p</code> is to the left of this segment
* @return -1 if <code>p</code> is to the right of this segment
@@ -295,7 +295,7 @@ public:
*
* Uses the standard lexicographic ordering for the points in the LineSegment.
*
- * @param o the LineSegment with which this LineSegment
+ * @param other the LineSegment with which this LineSegment
* is being compared
* @return a negative integer, zero, or a positive integer as this
* LineSegment is less than, equal to, or greater than the
@@ -316,7 +316,7 @@ public:
/**
* Computes the closest points on two line segments.
- * @param p the point to find the closest point to
+ * @param line the line segment to find the closest points to
* @return a pair of Coordinates which are the closest points on
* the line segments.
* The returned CoordinateSequence must be deleted by caller
diff --git a/include/geos/geom/Location.h b/include/geos/geom/Location.h
index 24f9a71..359bb9b 100644
--- a/include/geos/geom/Location.h
+++ b/include/geos/geom/Location.h
@@ -24,7 +24,6 @@ namespace geos {
namespace geom { // geos::geom
/** \brief
- *
* Constants representing the location of a point relative to a geometry.
*
* They can also be thought of as the row or column index of a DE-9IM matrix.
diff --git a/include/geos/geom/PrecisionModel.h b/include/geos/geom/PrecisionModel.h
index d1c39a5..e2ee2fd 100644
--- a/include/geos/geom/PrecisionModel.h
+++ b/include/geos/geom/PrecisionModel.h
@@ -134,11 +134,10 @@ public:
* coordinates, which are rounded to the grid defined by the
* scale factor.
*
- * @param scale
- * amount by which to multiply a coordinate after subtracting
- * the offset, to obtain a precise coordinate
- * @param offsetX not used.
- * @param offsetY not used.
+ * @param newScale amount by which to multiply a coordinate after
+ * subtracting the offset, to obtain a precise coordinate
+ * @param newOffsetX not used.
+ * @param newOffsetY not used.
*
* @deprecated offsets are no longer supported, since internal
* representation is rounded floating point
diff --git a/include/geos/geom/prep/BasicPreparedGeometry.h b/include/geos/geom/prep/BasicPreparedGeometry.h
index 7157906..1fcdfdb 100644
--- a/include/geos/geom/prep/BasicPreparedGeometry.h
+++ b/include/geos/geom/prep/BasicPreparedGeometry.h
@@ -115,8 +115,7 @@ public:
* intersects the test geometry.
* This is useful in A/A, A/L, A/P, L/P, and P/P cases.
*
- * @param geom the test geometry
- * @param repPts the representative points of the target geometry
+ * @param testGeom the test geometry
* @return true if any component intersects the areal test geometry
*/
bool isAnyTargetComponentInTest(const geom::Geometry* testGeom) const;
@@ -129,7 +128,7 @@ public:
/**
* Default implementation.
*/
- bool containsProperly(const geom::Geometry* g) const override;
+ bool containsProperly(const geom::Geometry* g) const override;
/**
* Default implementation.
@@ -150,7 +149,7 @@ public:
* Standard implementation for all geometries.
* Supports {@link GeometryCollection}s as input.
*/
- bool disjoint(const geom::Geometry* g) const override;
+ bool disjoint(const geom::Geometry* g) const override;
/**
* Default implementation.
@@ -160,7 +159,7 @@ public:
/**
* Default implementation.
*/
- bool overlaps(const geom::Geometry* g) const override;
+ bool overlaps(const geom::Geometry* g) const override;
/**
* Default implementation.
diff --git a/include/geos/geom/prep/PreparedLineStringIntersects.h b/include/geos/geom/prep/PreparedLineStringIntersects.h
index 2196257..bda4fc2 100644
--- a/include/geos/geom/prep/PreparedLineStringIntersects.h
+++ b/include/geos/geom/prep/PreparedLineStringIntersects.h
@@ -69,7 +69,7 @@ public:
/**
* Tests whether this geometry intersects a given geometry.
*
- * @param geom the test geometry
+ * @param g the test geometry
* @return true if the test geometry intersects
*/
bool intersects(const geom::Geometry* g) const;
@@ -82,7 +82,7 @@ protected:
* the target geometry.
* Only handles test geometries which are Puntal (dimension 0)
*
- * @param geom a Puntal geometry to test
+ * @param testGeom a Puntal geometry to test
* @return true if any point of the argument intersects the prepared geometry
*/
bool isAnyTestPointInTarget(const geom::Geometry* testGeom) const;
diff --git a/include/geos/geom/prep/PreparedPolygonContains.h b/include/geos/geom/prep/PreparedPolygonContains.h
index c8fe743..6b1be77 100644
--- a/include/geos/geom/prep/PreparedPolygonContains.h
+++ b/include/geos/geom/prep/PreparedPolygonContains.h
@@ -74,7 +74,7 @@ public:
}
/**
- * Computes the </tt>contains</tt> predicate between a {@link PreparedPolygon}
+ * Computes the <tt>contains</tt> predicate between a {@link PreparedPolygon}
* and a {@link Geometry}.
*
* @param prep the prepared polygon
diff --git a/include/geos/geom/prep/PreparedPolygonContainsProperly.h b/include/geos/geom/prep/PreparedPolygonContainsProperly.h
index 09a71e1..168e5d0 100644
--- a/include/geos/geom/prep/PreparedPolygonContainsProperly.h
+++ b/include/geos/geom/prep/PreparedPolygonContainsProperly.h
@@ -61,7 +61,7 @@ private:
protected:
public:
/**
- * Computes the </tt>containsProperly</tt> predicate between a {@link PreparedPolygon}
+ * Computes the <tt>containsProperly</tt> predicate between a {@link PreparedPolygon}
* and a {@link Geometry}.
*
* @param prep the prepared polygon
@@ -79,7 +79,7 @@ public:
/**
* Creates an instance of this operation.
*
- * @param prepPoly the PreparedPolygon to evaluate
+ * @param prep the PreparedPolygon to evaluate
*/
PreparedPolygonContainsProperly(const PreparedPolygon* const prep)
: PreparedPolygonPredicate(prep)
diff --git a/include/geos/geom/prep/PreparedPolygonCovers.h b/include/geos/geom/prep/PreparedPolygonCovers.h
index 494e47b..b6613d0 100644
--- a/include/geos/geom/prep/PreparedPolygonCovers.h
+++ b/include/geos/geom/prep/PreparedPolygonCovers.h
@@ -66,7 +66,7 @@ protected:
public:
/**
- * Computes the </tt>covers</tt> predicate between a {@link PreparedPolygon}
+ * Computes the <tt>covers</tt> predicate between a {@link PreparedPolygon}
* and a {@link Geometry}.
*
* @param prep the prepared polygon
@@ -83,7 +83,7 @@ public:
/**
* Creates an instance of this operation.
*
- * @param prepPoly the PreparedPolygon to evaluate
+ * @param prep the PreparedPolygon to evaluate
*/
PreparedPolygonCovers(const PreparedPolygon* const prep)
: AbstractPreparedPolygonContains(prep, false)
diff --git a/include/geos/geom/prep/PreparedPolygonIntersects.h b/include/geos/geom/prep/PreparedPolygonIntersects.h
index c73f4cd..8c67672 100644
--- a/include/geos/geom/prep/PreparedPolygonIntersects.h
+++ b/include/geos/geom/prep/PreparedPolygonIntersects.h
@@ -69,7 +69,7 @@ public:
/**
* Creates an instance of this operation.
*
- * @param prepPoly the PreparedPolygon to evaluate
+ * @param prep the PreparedPolygon to evaluate
*/
PreparedPolygonIntersects(const PreparedPolygon* const prep)
: PreparedPolygonPredicate(prep)
diff --git a/include/geos/geom/prep/PreparedPolygonPredicate.h b/include/geos/geom/prep/PreparedPolygonPredicate.h
index bcc1812..d100ebe 100644
--- a/include/geos/geom/prep/PreparedPolygonPredicate.h
+++ b/include/geos/geom/prep/PreparedPolygonPredicate.h
@@ -69,7 +69,7 @@ protected:
*
* Handles both linear and point components.
*
- * @param geom a geometry to test
+ * @param testGeom a geometry to test
* @return true if all components of the argument are contained
* in the target geometry
*/
@@ -81,7 +81,7 @@ protected:
*
* Handles both linear and point components.
*
- * @param geom a geometry to test
+ * @param testGeom a geometry to test
* @return true if all componenta of the argument are contained in
* the target geometry interior
*/
@@ -93,7 +93,7 @@ protected:
*
* Handles test geometries with both linear and point components.
*
- * @param geom a geometry to test
+ * @param testGeom a geometry to test
* @return true if any component of the argument intersects the
* prepared geometry
*/
@@ -105,7 +105,7 @@ protected:
*
* Handles test geometries with both linear and point components.
*
- * @param geom a geometry to test
+ * @param testGeom a geometry to test
* @return true if any component of the argument intersects the
* prepared area geometry interior
*/
@@ -115,8 +115,8 @@ protected:
* Tests whether any component of the target geometry
* intersects the test geometry (which must be an areal geometry)
*
- * @param geom the test geometry
- * @param repPts the representative points of the target geometry
+ * @param testGeom the test geometry
+ * @param targetRepPts the representative points of the target geometry
* @return true if any component intersects the areal test geometry
*/
bool isAnyTargetComponentInAreaTest(const geom::Geometry* testGeom,
@@ -126,7 +126,7 @@ public:
/**
* Creates an instance of this operation.
*
- * @param prepPoly the PreparedPolygon to evaluate
+ * @param p_prepPoly the PreparedPolygon to evaluate
*/
PreparedPolygonPredicate(const PreparedPolygon* const p_prepPoly)
: prepPoly(p_prepPoly)
diff --git a/include/geos/geomgraph/DirectedEdgeStar.h b/include/geos/geomgraph/DirectedEdgeStar.h
index fe1acec..c258ff8 100644
--- a/include/geos/geomgraph/DirectedEdgeStar.h
+++ b/include/geos/geomgraph/DirectedEdgeStar.h
@@ -132,8 +132,6 @@ public:
/** \brief
* Compute the DirectedEdge depths for a subsequence of the edge array.
- *
- * @return the last depth assigned (from the R side of the last edge visited)
*/
void computeDepths(DirectedEdge* de);
diff --git a/include/geos/geomgraph/EdgeEndStar.h b/include/geos/geomgraph/EdgeEndStar.h
index e376fe6..28dd076 100644
--- a/include/geos/geomgraph/EdgeEndStar.h
+++ b/include/geos/geomgraph/EdgeEndStar.h
@@ -79,7 +79,7 @@ public:
*/
virtual void insert(EdgeEnd* e) = 0;
- /** \brief
+ /**
* @return the coordinate for the node this star is based at
* or NULL if this is still an unbound star.
* Be aware that the returned pointer will point to
diff --git a/include/geos/geomgraph/PlanarGraph.h b/include/geos/geomgraph/PlanarGraph.h
index b94d9ae..f22555b 100644
--- a/include/geos/geomgraph/PlanarGraph.h
+++ b/include/geos/geomgraph/PlanarGraph.h
@@ -124,7 +124,7 @@ public:
virtual Node* addNode(const geom::Coordinate& coord);
- /** \brief
+ /**
* @return the node if found; null otherwise
*/
virtual Node* find(geom::Coordinate& coord);
diff --git a/include/geos/geomgraph/Quadrant.h b/include/geos/geomgraph/Quadrant.h
index 9992071..8ed8a9c 100644
--- a/include/geos/geomgraph/Quadrant.h
+++ b/include/geos/geomgraph/Quadrant.h
@@ -42,7 +42,7 @@ namespace geomgraph { // geos.geomgraph
* 1 | 0
* --+--
* 2 | 3
- * <pre>
+ * </pre>
*
*/
class GEOS_DLL Quadrant {
diff --git a/include/geos/index/intervalrtree/IntervalRTreeLeafNode.h b/include/geos/index/intervalrtree/IntervalRTreeLeafNode.h
index 3af6411..d475278 100644
--- a/include/geos/index/intervalrtree/IntervalRTreeLeafNode.h
+++ b/include/geos/index/intervalrtree/IntervalRTreeLeafNode.h
@@ -40,7 +40,7 @@ private:
protected:
public:
- /// @param item externally owned
+ /// @param p_item externally owned
IntervalRTreeLeafNode(double p_min, double p_max, void* p_item)
: IntervalRTreeNode(p_min, p_max),
item(p_item)
diff --git a/include/geos/index/quadtree/NodeBase.h b/include/geos/index/quadtree/NodeBase.h
index b306834..aefb4a9 100644
--- a/include/geos/index/quadtree/NodeBase.h
+++ b/include/geos/index/quadtree/NodeBase.h
@@ -93,7 +93,7 @@ public:
/**
* Removes a single item from this subtree.
*
- * @param searchEnv the envelope containing the item
+ * @param itemEnv the envelope containing the item
* @param item the item to remove
* @return <code>true</code> if the item was found and removed
*/
diff --git a/include/geos/linearref/LengthIndexOfPoint.h b/include/geos/linearref/LengthIndexOfPoint.h
index f640394..9e050e5 100644
--- a/include/geos/linearref/LengthIndexOfPoint.h
+++ b/include/geos/linearref/LengthIndexOfPoint.h
@@ -77,7 +77,7 @@ public:
* minLocation = [end of line] ).
*
* @param inputPt the coordinate to locate
- * @param minLocation the minimum location for the point location
+ * @param minIndex the minimum location for the point location
* @return the location of the nearest point
*/
double indexOfAfter(const geom::Coordinate& inputPt, double minIndex) const;
diff --git a/include/geos/linearref/LengthIndexedLine.h b/include/geos/linearref/LengthIndexedLine.h
index 09ed091..ee0de1a 100644
--- a/include/geos/linearref/LengthIndexedLine.h
+++ b/include/geos/linearref/LengthIndexedLine.h
@@ -186,7 +186,7 @@ public:
/**
* Tests whether an index is in the valid index range for the line.
*
- * @param length the index to test
+ * @param index the index to test
* @return <code>true</code> if the index is in the valid range
*/
bool isValidIndex(double index) const;
diff --git a/include/geos/linearref/LinearGeometryBuilder.h b/include/geos/linearref/LinearGeometryBuilder.h
index ebc0bd8..0a7c0b4 100644
--- a/include/geos/linearref/LinearGeometryBuilder.h
+++ b/include/geos/linearref/LinearGeometryBuilder.h
@@ -61,8 +61,8 @@ public:
* Allows invalid lines to be ignored rather than causing Exceptions.
* An invalid line is one which has only one unique point.
*
- * @param ignoreShortLines <code>true</code> if short lines are
- * to be ignored
+ * @param ignoreInvalidLines <code>true</code> if short lines are
+ * to be ignored
*/
void setIgnoreInvalidLines(bool ignoreInvalidLines);
@@ -70,8 +70,8 @@ public:
* Allows invalid lines to be ignored rather than causing Exceptions.
* An invalid line is one which has only one unique point.
*
- * @param ignoreShortLines <code>true</code> if short lines are
- * to be ignored
+ * @param fixInvalidLines <code>true</code> if short lines are
+ * to be ignored
*/
void setFixInvalidLines(bool fixInvalidLines);
diff --git a/include/geos/linearref/LinearLocation.h b/include/geos/linearref/LinearLocation.h
index 2b9da08..3f8f77b 100644
--- a/include/geos/linearref/LinearLocation.h
+++ b/include/geos/linearref/LinearLocation.h
@@ -182,7 +182,7 @@ public:
/**
* Compares this object with the specified object for order.
*
- *@param o the <code>LineStringLocation</code> with which this <code>Coordinate</code>
+ *@param other the <code>LineStringLocation</code> with which this <code>Coordinate</code>
* is being compared
*@return a negative integer, zero, or a positive integer as this <code>LineStringLocation</code>
* is less than, equal to, or greater than the specified <code>LineStringLocation</code>
diff --git a/include/geos/linearref/LocationIndexedLine.h b/include/geos/linearref/LocationIndexedLine.h
index 5b857f4..1dd90d6 100644
--- a/include/geos/linearref/LocationIndexedLine.h
+++ b/include/geos/linearref/LocationIndexedLine.h
@@ -248,7 +248,7 @@ public:
* \brief
* Tests whether an index is in the valid index range for the line.
*
- * @param length the index to test
+ * @param index the index to test
* @return <code>true</code> if the index is in the valid range
*/
bool
diff --git a/include/geos/noding/IntersectionFinderAdder.h b/include/geos/noding/IntersectionFinderAdder.h
index a828fd9..f18dec2 100644
--- a/include/geos/noding/IntersectionFinderAdder.h
+++ b/include/geos/noding/IntersectionFinderAdder.h
@@ -58,7 +58,7 @@ public:
* Creates an intersection finder which finds all proper intersections
* and stores them in the provided Coordinate array
*
- * @param li the LineIntersector to use
+ * @param newLi the LineIntersector to use
* @param v the Vector to push interior intersections to
*/
IntersectionFinderAdder(algorithm::LineIntersector& newLi,
diff --git a/include/geos/noding/NodedSegmentString.h b/include/geos/noding/NodedSegmentString.h
index 46099b8..55eadc5 100644
--- a/include/geos/noding/NodedSegmentString.h
+++ b/include/geos/noding/NodedSegmentString.h
@@ -92,7 +92,7 @@ public:
* @param newPts CoordinateSequence representing the string,
* ownership transferred.
*
- * @param data the user-defined data of this segment string
+ * @param newContext the user-defined data of this segment string
* (may be null)
*/
NodedSegmentString(geom::CoordinateSequence* newPts, const void* newContext)
diff --git a/include/geos/noding/NodingIntersectionFinder.h b/include/geos/noding/NodingIntersectionFinder.h
index 61ebc8c..dbf9471 100644
--- a/include/geos/noding/NodingIntersectionFinder.h
+++ b/include/geos/noding/NodingIntersectionFinder.h
@@ -52,7 +52,7 @@ public:
* Creates an intersection finder which finds an interior intersection
* if one exists
*
- * @param li the LineIntersector to use
+ * @param newLi the LineIntersector to use
*/
NodingIntersectionFinder(algorithm::LineIntersector& newLi)
:
@@ -106,7 +106,7 @@ public:
* It may be known that any potential noding failures will occur only in
* end segments.
*
- * @param isCheckEndSegmentsOnly whether to test only end segments
+ * @param isCESO whether to test only end segments
*/
void
setCheckEndSegmentsOnly(bool isCESO)
diff --git a/include/geos/noding/SegmentNode.h b/include/geos/noding/SegmentNode.h
index 5b2bc47..ef2712e 100644
--- a/include/geos/noding/SegmentNode.h
+++ b/include/geos/noding/SegmentNode.h
@@ -38,10 +38,12 @@ class NodedSegmentString;
namespace geos {
namespace noding { // geos.noding
-/// Represents an intersection point between two NodedSegmentString.
-//
-/// Final class.
-///
+/**
+ * \brief
+ * Represents an intersection point between two NodedSegmentString.
+ *
+ * Final class.
+ */
class GEOS_DLL SegmentNode {
private:
const NodedSegmentString& segString;
@@ -67,7 +69,7 @@ public:
//
/// @param ss the parent NodedSegmentString
///
- /// @param coord the coordinate of the intersection, will be copied
+ /// @param nCoord the coordinate of the intersection, will be copied
///
/// @param nSegmentIndex the index of the segment on parent
/// NodedSegmentString
diff --git a/include/geos/noding/SegmentSetMutualIntersector.h b/include/geos/noding/SegmentSetMutualIntersector.h
index 3ef94f8..0da42e0 100644
--- a/include/geos/noding/SegmentSetMutualIntersector.h
+++ b/include/geos/noding/SegmentSetMutualIntersector.h
@@ -59,7 +59,7 @@ public:
/**
*
- * @param segStrings0 a collection of {@link SegmentString}s to node
+ * @param segStrings a collection of {@link SegmentString}s to node
*/
virtual void setBaseSegments(SegmentString::ConstVect* segStrings) = 0;
diff --git a/include/geos/noding/snapround/SimpleSnapRounder.h b/include/geos/noding/snapround/SimpleSnapRounder.h
index 121082b..f88fff8 100644
--- a/include/geos/noding/snapround/SimpleSnapRounder.h
+++ b/include/geos/noding/snapround/SimpleSnapRounder.h
@@ -120,7 +120,8 @@ private:
/** \brief
* Computes nodes introduced as a result of snapping segments to
* snap points (hot pixels)
- * @param li
+ * @param segStrings
+ * @param snapPts
*/
void computeSnaps(const std::vector<SegmentString*>& segStrings,
std::vector<geom::Coordinate>& snapPts);
diff --git a/include/geos/operation/buffer/BufferOp.h b/include/geos/operation/buffer/BufferOp.h
index f7c0111..04cefca 100644
--- a/include/geos/operation/buffer/BufferOp.h
+++ b/include/geos/operation/buffer/BufferOp.h
@@ -54,7 +54,7 @@ namespace buffer { // geos.operation.buffer
* the Minkowski sum (or difference) of the geometry
* with a circle with radius equal to the absolute value of the buffer
* distance.
- * In the CAD/CAM world buffers are known as </i>offset curves</i>.
+ * In the CAD/CAM world buffers are known as <i>offset curves</i>.
* In morphological analysis the operation of positive and negative buffering
* is referred to as <i>erosion</i> and <i>dilation</i>.
*
@@ -196,16 +196,14 @@ public:
* The styles supported are CAP_ROUND, CAP_BUTT, and CAP_SQUARE.
* The default is CAP_ROUND.
*
- * @param endCapStyle the end cap style to specify
+ * @param nEndCapStyle the end cap style to specify
*/
inline void setEndCapStyle(int nEndCapStyle);
/**
- * Specifies the end cap style of the generated buffer.
- * The styles supported are CAP_ROUND, CAP_BUTT, and CAP_SQUARE.
- * The default is CAP_ROUND.
+ * Sets the number of segments used to approximate a angle fillet
*
- * @param endCapStyle the end cap style to specify
+ * @param nQuadrantSegments the number of segments in a fillet for a quadrant
*/
inline void setQuadrantSegments(int nQuadrantSegments);
@@ -235,8 +233,7 @@ public:
* Returns the buffer computed for a geometry for a given buffer
* distance.
*
- * @param g the geometry to buffer
- * @param distance the buffer distance
+ * @param nDistance the buffer distance
* @return the buffer of the input geometry
*/
geom::Geometry* getResultGeometry(double nDistance);
diff --git a/include/geos/operation/buffer/BufferParameters.h b/include/geos/operation/buffer/BufferParameters.h
index 6592683..9f70690 100644
--- a/include/geos/operation/buffer/BufferParameters.h
+++ b/include/geos/operation/buffer/BufferParameters.h
@@ -166,8 +166,8 @@ public:
/// (in other words, the computed buffer curve is always inside
/// the true curve).
///
- /// @param quadrantSegments the number of segments in a
- /// fillet for a quadrant
+ /// @param quadSegs the number of segments in a
+ /// fillet for a quadrant
////
void setQuadrantSegments(int quadSegs);
@@ -275,7 +275,7 @@ public:
* always ignored,
* and forced to the equivalent of <tt>CAP_FLAT</tt>.
*
- * @param isSingleSided true if a single-sided buffer should be constructed
+ * @param p_isSingleSided true if a single-sided buffer should be constructed
*/
void
setSingleSided(bool p_isSingleSided)
diff --git a/include/geos/operation/buffer/BufferSubgraph.h b/include/geos/operation/buffer/BufferSubgraph.h
index ed4872a..9e4c4e1 100644
--- a/include/geos/operation/buffer/BufferSubgraph.h
+++ b/include/geos/operation/buffer/BufferSubgraph.h
@@ -75,7 +75,7 @@ private:
*
* Uses an explicit stack to avoid a large depth of recursion.
*
- * @param node a node known to be in the subgraph
+ * @param startNode a node known to be in the subgraph
*/
void addReachable(geomgraph::Node* startNode);
diff --git a/include/geos/operation/buffer/OffsetCurveBuilder.h b/include/geos/operation/buffer/OffsetCurveBuilder.h
index 684dcfd..7588e98 100644
--- a/include/geos/operation/buffer/OffsetCurveBuilder.h
+++ b/include/geos/operation/buffer/OffsetCurveBuilder.h
@@ -154,7 +154,7 @@ private:
* Computes the distance tolerance to use during input
* line simplification.
*
- * @param distance the buffer distance
+ * @param bufDistance the buffer distance
* @return the simplification tolerance
*/
double simplifyTolerance(double bufDistance);
diff --git a/include/geos/operation/buffer/OffsetCurveSetBuilder.h b/include/geos/operation/buffer/OffsetCurveSetBuilder.h
index 5eba19c..751f6e4 100644
--- a/include/geos/operation/buffer/OffsetCurveSetBuilder.h
+++ b/include/geos/operation/buffer/OffsetCurveSetBuilder.h
@@ -141,8 +141,8 @@ private:
* It may be degenerate (i.e. contain only 1, 2, or 3 points).
* In this case it has no area, and hence has a minimum diameter of 0.
*
- * @param ring
- * @param offsetDistance
+ * @param ringCoord
+ * @param bufferDistance
* @return
*/
bool isErodedCompletely(const geom::LinearRing* ringCoord,
diff --git a/include/geos/operation/overlay/snap/LineStringSnapper.h b/include/geos/operation/overlay/snap/LineStringSnapper.h
index 58a07b4..7b675f0 100644
--- a/include/geos/operation/overlay/snap/LineStringSnapper.h
+++ b/include/geos/operation/overlay/snap/LineStringSnapper.h
@@ -57,7 +57,7 @@ public:
* as source points to be snapped.
*
* @param nSrcPts the points to snap
- * @param nSnapTolerance the snap tolerance to use
+ * @param nSnapTol the snap tolerance to use
*/
LineStringSnapper(const geom::Coordinate::Vect& nSrcPts,
double nSnapTol)
diff --git a/include/geos/operation/overlay/validate/FuzzyPointLocator.h b/include/geos/operation/overlay/validate/FuzzyPointLocator.h
index 1215054..3d093cc 100644
--- a/include/geos/operation/overlay/validate/FuzzyPointLocator.h
+++ b/include/geos/operation/overlay/validate/FuzzyPointLocator.h
@@ -78,7 +78,7 @@ private:
/// Extracts linework for polygonal components.
//
- /// @param g the geometry from which to extract
+ /// @param geom the geometry from which to extract
/// @return a lineal geometry containing the extracted linework
std::unique_ptr<geom::Geometry> extractLineWork(const geom::Geometry& geom);
diff --git a/include/geos/operation/polygonize/EdgeRing.h b/include/geos/operation/polygonize/EdgeRing.h
index 0ef3b01..494ace1 100644
--- a/include/geos/operation/polygonize/EdgeRing.h
+++ b/include/geos/operation/polygonize/EdgeRing.h
@@ -174,6 +174,8 @@ public:
void build(PolygonizeDirectedEdge* startDE);
+ void computeHole();
+
/** \brief
* Tests whether this ring is a hole.
*
@@ -181,8 +183,6 @@ public:
* a ring is a hole if it is oriented counter-clockwise.
* @return <code>true</code> if this ring is a hole
*/
- void computeHole();
-
bool isHole() const {
return is_hole;
}
@@ -217,7 +217,7 @@ public:
/** \brief
* Sets the containing shell ring of a ring that has been determined to be a hole.
*
- * @param shell the shell ring
+ * @param shellRing the shell ring
*/
void setShell(EdgeRing* shellRing) {
shell = shellRing;
diff --git a/include/geos/operation/sharedpaths/SharedPathsOp.h b/include/geos/operation/sharedpaths/SharedPathsOp.h
index 3247352..accd293 100644
--- a/include/geos/operation/sharedpaths/SharedPathsOp.h
+++ b/include/geos/operation/sharedpaths/SharedPathsOp.h
@@ -75,12 +75,12 @@ public:
/// @param g2
/// Second geometry. Must be linear.
///
- /// @param sameDir
+ /// @param sameDirection
/// Shared edges having the same direction are pushed
/// onto this vector. They'll be of type LineString.
/// Ownership of the edges is tranferred.
///
- /// @param oppositeDir
+ /// @param oppositeDirection
/// Shared edges having the opposite direction are pushed
/// onto this vector. They'll be of type geom::LineString.
/// Ownership of the edges is tranferred.
@@ -102,12 +102,12 @@ public:
/// Get shared paths
//
- /// @param sameDir
+ /// @param sameDirection
/// Shared edges having the same direction are pushed
/// onto this vector. They'll be of type geom::LineString.
/// Ownership of the edges is tranferred.
///
- /// @param oppositeDir
+ /// @param oppositeDirection
/// Shared edges having the opposite direction are pushed
/// onto this vector. They'll be of type geom::LineString.
/// Ownership of the edges is tranferred.
diff --git a/include/geos/operation/valid/ConsistentAreaTester.h b/include/geos/operation/valid/ConsistentAreaTester.h
index ac31408..e596e2e 100644
--- a/include/geos/operation/valid/ConsistentAreaTester.h
+++ b/include/geos/operation/valid/ConsistentAreaTester.h
@@ -46,20 +46,6 @@ namespace operation { // geos::operation
namespace valid { // geos::operation::valid
/** \brief
- * Checks that a {@link geomgraph::GeometryGraph} representing an area
- * (a {@link Polygon} or {@link MultiPolygon} )
- * is consistent with the OGC-SFS semantics for area geometries.
- *
- * Checks include:
- *
- * - testing for rings which self-intersect (both properly
- * and at nodes)
- * - testing for duplicate rings
- *
- * If an inconsistency if found the location of the problem
- * is recorded.
- */
-/** \brief
* Checks that a geomgraph::GeometryGraph representing an area
* (a geom::Polygon or geom::MultiPolygon)
* has consistent semantics for area geometries.
diff --git a/include/geos/operation/valid/IsValidOp.h b/include/geos/operation/valid/IsValidOp.h
index a4e3762..95795ab 100644
--- a/include/geos/operation/valid/IsValidOp.h
+++ b/include/geos/operation/valid/IsValidOp.h
@@ -264,7 +264,7 @@ public:
* and "C-shaped" holes which self-touch at a single point causing
* an island to be formed.
*
- * @param isValid states whether geometry with this condition is valid
+ * @param p_isValid states whether geometry with this condition is valid
*/
void
setSelfTouchingRingFormingHoleValid(bool p_isValid)
diff --git a/include/geos/planargraph/DirectedEdge.h b/include/geos/planargraph/DirectedEdge.h
index cb08f3b..98db535 100644
--- a/include/geos/planargraph/DirectedEdge.h
+++ b/include/geos/planargraph/DirectedEdge.h
@@ -96,11 +96,11 @@ public:
*
* @param directionPt specifies this DirectedEdge's direction
* (given by an imaginary line from the
- * <code>from</code> node to
- * <code>directionPt</code>)
- * @param edgeDirection whether this DirectedEdge's direction
- * is the same as or opposite to that of the
- * parent Edge (if any)
+ * <code>from</code> node to
+ * <code>directionPt</code>)
+ * @param newEdgeDirection whether this DirectedEdge's direction
+ * is the same as or opposite to that of the
+ * parent Edge (if any)
*/
DirectedEdge(Node* newFrom, Node* newTo,
const geom::Coordinate& directionPt,
diff --git a/include/geos/planargraph/GraphComponent.h b/include/geos/planargraph/GraphComponent.h
index 675ef5d..9583187 100644
--- a/include/geos/planargraph/GraphComponent.h
+++ b/include/geos/planargraph/GraphComponent.h
@@ -78,7 +78,7 @@ public:
/** \brief
* Sets the visited flag for this component.
- * @param isVisited the desired value of the visited flag
+ * @param p_isVisited the desired value of the visited flag
*/
virtual void
setVisited(bool p_isVisited)
@@ -168,7 +168,7 @@ public:
/** \brief
* Sets the marked flag for this component.
- * @param isMarked the desired value of the marked flag
+ * @param p_isMarked the desired value of the marked flag
*/
virtual void
setMarked(bool p_isMarked)
diff --git a/include/geos/planargraph/PlanarGraph.h b/include/geos/planargraph/PlanarGraph.h
index 2172c11..2001948 100644
--- a/include/geos/planargraph/PlanarGraph.h
+++ b/include/geos/planargraph/PlanarGraph.h
@@ -72,7 +72,6 @@ protected:
*
* Only subclasses can add Nodes, to ensure Nodes are
* of the right type.
- * @return the added node
*/
void
add(Node* node)
diff --git a/include/geos/precision/CommonBits.h b/include/geos/precision/CommonBits.h
index 4ffe9c9..60954a0 100644
--- a/include/geos/precision/CommonBits.h
+++ b/include/geos/precision/CommonBits.h
@@ -61,7 +61,8 @@ public:
* It does not determine whether the numbers have the same
* exponent - if they do not, the value computed by this
* function is meaningless.
- * @param db
+ * @param num1
+ * @param num2
* @return the number of common most-significant mantissa bits
*/
static int numCommonMostSigMantissaBits(int64 num1, int64 num2);
@@ -70,7 +71,7 @@ public:
* Zeroes the lower n bits of a bitstring.
*
* @param bits the bitstring to alter
- * @param i the number of bits to zero
+ * @param nBits the number of bits to zero
* @return the zeroed bitstring
*/
static int64 zeroLowerBits(int64 bits, int nBits);
diff --git a/include/geos/precision/EnhancedPrecisionOp.h b/include/geos/precision/EnhancedPrecisionOp.h
index 6860be8..806535d 100644
--- a/include/geos/precision/EnhancedPrecisionOp.h
+++ b/include/geos/precision/EnhancedPrecisionOp.h
@@ -91,7 +91,7 @@ public:
* This method should no longer be necessary, since the buffer
* algorithm now is highly robust.
*
- * @param geom0 the first Geometry
+ * @param geom the first Geometry
* @param distance the buffer distance
* @return the Geometry representing the buffer of the input Geometry.
*/
diff --git a/include/geos/precision/SimpleGeometryPrecisionReducer.h b/include/geos/precision/SimpleGeometryPrecisionReducer.h
index 83e1367..982d38a 100644
--- a/include/geos/precision/SimpleGeometryPrecisionReducer.h
+++ b/include/geos/precision/SimpleGeometryPrecisionReducer.h
@@ -60,7 +60,7 @@ public:
* being removed completely, or simply being collapsed to an (invalid)
* Geometry of the same type.
*
- * @param removeCollapsed if <code>true</code> collapsed
+ * @param nRemoveCollapsed if <code>true</code> collapsed
* components will be removed
*/
void setRemoveCollapsedComponents(bool nRemoveCollapsed);
diff --git a/include/geos/simplify/DouglasPeuckerSimplifier.h b/include/geos/simplify/DouglasPeuckerSimplifier.h
index 0190072..669f8a6 100644
--- a/include/geos/simplify/DouglasPeuckerSimplifier.h
+++ b/include/geos/simplify/DouglasPeuckerSimplifier.h
@@ -65,7 +65,7 @@ public:
* The tolerance value must be non-negative. A tolerance value
* of zero is effectively a no-op.
*
- * @param distanceTolerance the approximation tolerance to use
+ * @param tolerance the approximation tolerance to use
*/
void setDistanceTolerance(double tolerance);
diff --git a/include/geos/simplify/TaggedLineStringSimplifier.h b/include/geos/simplify/TaggedLineStringSimplifier.h
index b1166f5..32188d0 100644
--- a/include/geos/simplify/TaggedLineStringSimplifier.h
+++ b/include/geos/simplify/TaggedLineStringSimplifier.h
@@ -130,7 +130,7 @@ private:
/** \brief
* Tests whether a segment is in a section of a TaggedLineString
*
- * @param line
+ * @param parentLine
* @param sectionIndex
* @param seg
* @return
@@ -144,9 +144,8 @@ private:
* Remove the segs in the section of the line
*
* @param line
- * @param pts
- * @param sectionStartIndex
- * @param sectionEndIndex
+ * @param start
+ * @param end
*/
void remove(const TaggedLineString* line,
std::size_t start,
diff --git a/include/geos/simplify/TopologyPreservingSimplifier.h b/include/geos/simplify/TopologyPreservingSimplifier.h
index afba135..3cc8308 100644
--- a/include/geos/simplify/TopologyPreservingSimplifier.h
+++ b/include/geos/simplify/TopologyPreservingSimplifier.h
@@ -38,7 +38,6 @@ namespace geos {
namespace simplify { // geos::simplify
/** \brief
- *
* Simplifies a geometry, ensuring that
* the result is a valid geometry having the
* same dimension and number of components as the input.
@@ -73,7 +72,7 @@ public:
* The tolerance value must be non-negative. A tolerance value
* of zero is effectively a no-op.
*
- * @param distanceTolerance the approximation tolerance to use
+ * @param tolerance the approximation tolerance to use
*/
void setDistanceTolerance(double tolerance);
diff --git a/include/geos/triangulate/DelaunayTriangulationBuilder.h b/include/geos/triangulate/DelaunayTriangulationBuilder.h
index aaedfc1..e39e9bf 100644
--- a/include/geos/triangulate/DelaunayTriangulationBuilder.h
+++ b/include/geos/triangulate/DelaunayTriangulationBuilder.h
@@ -110,7 +110,7 @@ public:
* to improved the robustness of the triangulation computation.
* A tolerance of 0.0 specifies that no snapping will take place.
*
- * @param tolerance the tolerance distance to use
+ * @param p_tolerance the tolerance distance to use
*/
inline void
setTolerance(double p_tolerance)
diff --git a/include/geos/triangulate/quadedge/QuadEdge.h b/include/geos/triangulate/quadedge/QuadEdge.h
index 0dd0de1..0ed90b9 100644
--- a/include/geos/triangulate/quadedge/QuadEdge.h
+++ b/include/geos/triangulate/quadedge/QuadEdge.h
@@ -53,12 +53,10 @@ public:
/**
* Creates a new QuadEdge quartet from {@link Vertex} o to {@link Vertex} d.
*
- * @param o
- * the origin Vertex
- * @param d
- * the destination Vertex
+ * @param o the origin Vertex
+ * @param d the destination Vertex
* @return the new QuadEdge* The caller is reponsible for
- * freeing the returned pointer
+ * freeing the returned pointer
*/
static std::unique_ptr<QuadEdge> makeEdge(const Vertex& o, const Vertex& d);
@@ -171,7 +169,7 @@ public:
/**
* Sets the connected edge
*
- * @param nextEdge edge
+ * @param p_next edge
*/
inline void
setNext(QuadEdge* p_next)
diff --git a/include/geos/triangulate/quadedge/TrianglePredicate.h b/include/geos/triangulate/quadedge/TrianglePredicate.h
index 2218f43..f045be0 100644
--- a/include/geos/triangulate/quadedge/TrianglePredicate.h
+++ b/include/geos/triangulate/quadedge/TrianglePredicate.h
@@ -49,7 +49,7 @@ public:
* @param a a vertex of the triangle
* @param b a vertex of the triangle
* @param c a vertex of the triangle
- * @param P the point to test
+ * @param p the point to test
* @return true if this point is inside the circle defined by the points a, b, c
*/
static bool isInCircleNonRobust(
@@ -70,7 +70,7 @@ public:
* @param a a vertex of the triangle
* @param b a vertex of the triangle
* @param c a vertex of the triangle
- * @param P the point to test
+ * @param p the point to test
* @return true if this point is inside the circle defined by the points a, b, c
*/
static bool isInCircleNormalized(
@@ -98,7 +98,7 @@ public:
* @param a a vertex of the triangle
* @param b a vertex of the triangle
* @param c a vertex of the triangle
- * @param P the point to test
+ * @param p the point to test
* @return true if this point is inside the circle defined by the points a, b, c
*/
static bool isInCircleRobust(
diff --git a/include/geos/triangulate/quadedge/Vertex.h b/include/geos/triangulate/quadedge/Vertex.h
index 9b98c1b..b9137a3 100644
--- a/include/geos/triangulate/quadedge/Vertex.h
+++ b/include/geos/triangulate/quadedge/Vertex.h
@@ -145,7 +145,7 @@ public:
/**
* Computes the inner or dot product
*
- * @param v, a vertex
+ * @param v a vertex
* @return returns the dot product u.v
*/
inline double
@@ -157,7 +157,7 @@ public:
/**
* Computes the scalar product c(v)
*
- * @param v, a vertex
+ * @param c scaling factor
* @return returns the scaled vector
*/
inline std::unique_ptr<Vertex>
diff --git a/include/geos/util/GeometricShapeFactory.h b/include/geos/util/GeometricShapeFactory.h
index b6f0ded..c8631ed 100644
--- a/include/geos/util/GeometricShapeFactory.h
+++ b/include/geos/util/GeometricShapeFactory.h
@@ -95,10 +95,8 @@ public:
* Create a shape factory which will create shapes using the given
* GeometryFactory.
*
- * @param factory the factory to use. You need to keep the
- * factory alive for the whole GeometricShapeFactory
- * life time.
- *
+ * @param factory the factory to use. You need to keep the factory
+ * alive for the whole GeometricShapeFactory life time.
*/
GeometricShapeFactory(const geom::GeometryFactory* factory);
@@ -124,7 +122,7 @@ public:
* the ellipse.
*
* @param startAng start angle in radians
- * @param angExtent size of angle in radians
+ * @param angExt size of angle in radians
* @return an elliptical arc polygon
*/
geom::Polygon* createArcPolygon(double startAng, double angExt);
diff --git a/src/operation/buffer/SubgraphDepthLocater.cpp b/src/operation/buffer/SubgraphDepthLocater.cpp
index 496117a..94d06e4 100644
--- a/src/operation/buffer/SubgraphDepthLocater.cpp
+++ b/src/operation/buffer/SubgraphDepthLocater.cpp
@@ -101,7 +101,7 @@ public:
* DS1 > DS2 if DS1.seg is right of DS2.seg
* </pre>
*
- * @param obj
+ * @param other
* @return
*/
int
diff --git a/src/operation/polygonize/PolygonizeDirectedEdge.cpp b/src/operation/polygonize/PolygonizeDirectedEdge.cpp
index bfc2d78..92e2bc5 100644
--- a/src/operation/polygonize/PolygonizeDirectedEdge.cpp
+++ b/src/operation/polygonize/PolygonizeDirectedEdge.cpp
@@ -30,11 +30,11 @@ namespace polygonize { // geos.operation.polygonize
* Constructs a directed edge connecting the <code>from</code> node to the
* <code>to</code> node.
*
- * @param directionPt
+ * @param newDirectionPt
* specifies this DirectedEdge's direction (given by an imaginary
* line from the <code>from</code> node to <code>directionPt</code>)
*
- * @param edgeDirection
+ * @param nEdgeDirection
* whether this DirectedEdge's direction is the same as or
* opposite to that of the parent Edge (if any)
*/
diff --git a/src/operation/predicate/RectangleIntersects.cpp b/src/operation/predicate/RectangleIntersects.cpp
index e4dd758..7736f1e 100644
--- a/src/operation/predicate/RectangleIntersects.cpp
+++ b/src/operation/predicate/RectangleIntersects.cpp
@@ -56,13 +56,6 @@ private:
protected:
- /**
- * Reports whether it can be concluded that an intersection occurs,
- * or whether further testing is required.
- *
- * @return <code>true</code> if an intersection must occur
- * <code>false</code> if no conclusion can be made
- */
void
visit(const geom::Geometry& element) override
{
diff --git a/src/simplify/TopologyPreservingSimplifier.cpp b/src/simplify/TopologyPreservingSimplifier.cpp
index 4e9b8bc..61885aa 100644
--- a/src/simplify/TopologyPreservingSimplifier.cpp
+++ b/src/simplify/TopologyPreservingSimplifier.cpp
@@ -52,7 +52,7 @@ public:
/**
* User's constructor.
- * @param nMap - reference to LinesMap instance.
+ * @param simp - reference to LinesMap instance.
*/
LineStringTransformer(LinesMap& simp);
-----------------------------------------------------------------------
Summary of changes:
include/geos/algorithm/Distance.h | 2 +-
include/geos/algorithm/Length.h | 2 +-
include/geos/algorithm/LineIntersector.h | 4 +--
include/geos/algorithm/MinimumDiameter.h | 4 +--
include/geos/geom/CoordinateList.h | 2 +-
include/geos/geom/CoordinateSequence.h | 32 +++++++++-------------
include/geos/geom/Envelope.h | 5 ++--
include/geos/geom/Geometry.h | 2 +-
include/geos/geom/GeometryFactory.h | 9 +++---
include/geos/geom/LineSegment.h | 10 +++----
include/geos/geom/Location.h | 1 -
include/geos/geom/PrecisionModel.h | 9 +++---
include/geos/geom/prep/BasicPreparedGeometry.h | 9 +++---
.../geos/geom/prep/PreparedLineStringIntersects.h | 4 +--
include/geos/geom/prep/PreparedPolygonContains.h | 2 +-
.../geom/prep/PreparedPolygonContainsProperly.h | 4 +--
include/geos/geom/prep/PreparedPolygonCovers.h | 4 +--
include/geos/geom/prep/PreparedPolygonIntersects.h | 2 +-
include/geos/geom/prep/PreparedPolygonPredicate.h | 14 +++++-----
include/geos/geomgraph/DirectedEdgeStar.h | 2 --
include/geos/geomgraph/EdgeEndStar.h | 2 +-
include/geos/geomgraph/PlanarGraph.h | 2 +-
include/geos/geomgraph/Quadrant.h | 2 +-
.../index/intervalrtree/IntervalRTreeLeafNode.h | 2 +-
include/geos/index/quadtree/NodeBase.h | 2 +-
include/geos/linearref/LengthIndexOfPoint.h | 2 +-
include/geos/linearref/LengthIndexedLine.h | 2 +-
include/geos/linearref/LinearGeometryBuilder.h | 8 +++---
include/geos/linearref/LinearLocation.h | 2 +-
include/geos/linearref/LocationIndexedLine.h | 2 +-
include/geos/noding/IntersectionFinderAdder.h | 2 +-
include/geos/noding/NodedSegmentString.h | 2 +-
include/geos/noding/NodingIntersectionFinder.h | 4 +--
include/geos/noding/SegmentNode.h | 12 ++++----
include/geos/noding/SegmentSetMutualIntersector.h | 2 +-
include/geos/noding/snapround/SimpleSnapRounder.h | 3 +-
include/geos/operation/buffer/BufferOp.h | 13 ++++-----
include/geos/operation/buffer/BufferParameters.h | 6 ++--
include/geos/operation/buffer/BufferSubgraph.h | 2 +-
include/geos/operation/buffer/OffsetCurveBuilder.h | 2 +-
.../geos/operation/buffer/OffsetCurveSetBuilder.h | 4 +--
.../operation/overlay/snap/LineStringSnapper.h | 2 +-
.../operation/overlay/validate/FuzzyPointLocator.h | 2 +-
include/geos/operation/polygonize/EdgeRing.h | 6 ++--
include/geos/operation/sharedpaths/SharedPathsOp.h | 8 +++---
.../geos/operation/valid/ConsistentAreaTester.h | 14 ----------
include/geos/operation/valid/IsValidOp.h | 2 +-
include/geos/planargraph/DirectedEdge.h | 10 +++----
include/geos/planargraph/GraphComponent.h | 4 +--
include/geos/planargraph/PlanarGraph.h | 1 -
include/geos/precision/CommonBits.h | 5 ++--
include/geos/precision/EnhancedPrecisionOp.h | 2 +-
.../precision/SimpleGeometryPrecisionReducer.h | 2 +-
include/geos/simplify/DouglasPeuckerSimplifier.h | 2 +-
include/geos/simplify/TaggedLineStringSimplifier.h | 7 ++---
.../geos/simplify/TopologyPreservingSimplifier.h | 3 +-
.../triangulate/DelaunayTriangulationBuilder.h | 2 +-
include/geos/triangulate/quadedge/QuadEdge.h | 10 +++----
.../geos/triangulate/quadedge/TrianglePredicate.h | 6 ++--
include/geos/triangulate/quadedge/Vertex.h | 4 +--
include/geos/util/GeometricShapeFactory.h | 8 ++----
src/operation/buffer/SubgraphDepthLocater.cpp | 2 +-
.../polygonize/PolygonizeDirectedEdge.cpp | 4 +--
src/operation/predicate/RectangleIntersects.cpp | 7 -----
src/simplify/TopologyPreservingSimplifier.cpp | 2 +-
65 files changed, 138 insertions(+), 178 deletions(-)
hooks/post-receive
--
GEOS
More information about the geos-commits
mailing list