Skip to content

Commit

Permalink
Fix Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
dr-jts committed Dec 4, 2023
1 parent d45d8cc commit a47fbdd
Showing 1 changed file with 3 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@
* Simplifies a geometry and ensures that
* the result is a valid geometry having the
* same dimension and number of components as the input,
* and with the components having the same topological
* relationship.
* and with the components having the same topological relationship.
* <p>
* If the input is a polygonal geometry
* ( {@link Polygon} or {@link MultiPolygon} ):
Expand All @@ -45,8 +44,8 @@
* any intersecting line segments, this property
* will be preserved in the output.
* <p>
* For polygonal geometries and LinearRings the endpoint will participate
* in simplification. For LineStrings the endpoints will not be unchanged.
* For polygonal geometries and LinearRings the ring endpoint will be simplified.
* For LineStrings the endpoints will be unchanged.
* <p>
* For all geometry types, the result will contain
* enough vertices to ensure validity. For polygons
Expand All @@ -60,19 +59,6 @@
* <p>
* The simplification uses a maximum-distance difference algorithm
* similar to the Douglas-Peucker algorithm.
*
* <h3>KNOWN BUGS</h3>
* <ul>
* <li>May create invalid topology if there are components which are
* small relative to the tolerance value.
* In particular, if a small hole is very near an edge, it is possible for the edge to be moved by
* a relatively large tolerance value and end up with the hole outside the result shell
* (or inside another hole).
* Similarly, it is possible for a small polygon component to end up inside
* a nearby larger polygon.
* A workaround is to test for this situation in post-processing and remove
* any invalid holes or polygons.
* </ul>
*
* @author Martin Davis
* @see DouglasPeuckerSimplifier
Expand Down

0 comments on commit a47fbdd

Please sign in to comment.