Skip to content

Commit 80f5d3f

Browse files
committed
javadoc: Un-declare javadoc params/throws without docs
And adjust javadoc lint to not complain about missing javadocs And adjust javadoc lint to not complain about missing javadocs
1 parent c47575b commit 80f5d3f

File tree

10 files changed

+3
-14
lines changed

10 files changed

+3
-14
lines changed

pom.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,14 +379,15 @@
379379
<plugin>
380380
<groupId>org.apache.maven.plugins</groupId>
381381
<artifactId>maven-javadoc-plugin</artifactId>
382-
<version>2.10.3</version>
382+
<version>3.2.0</version>
383383
<configuration>
384384
<header>Spatial4j, ${project.version}</header>
385385
<footer>Spatial4j, ${project.version}</footer>
386386
<doctitle>Spatial4j, ${project.version}</doctitle>
387387
<links>
388388
<link>http://locationtech.github.io/jts/javadoc/</link>
389389
</links>
390+
<doclint>all,-missing</doclint>
390391
</configuration>
391392
<!-- we exclude tests: -->
392393
<reportSets>

src/main/java/org/locationtech/spatial4j/context/SpatialContext.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,9 +263,7 @@ public Shape readShapeFromWkt(String wkt) throws ParseException, InvalidShapeExc
263263
/**
264264
* Try to read a shape from any supported formats
265265
*
266-
* @param value
267266
* @return shape or null if unable to parse any shape
268-
* @throws InvalidShapeException
269267
*/
270268
@Deprecated
271269
public Shape readShape(String value) throws InvalidShapeException {

src/main/java/org/locationtech/spatial4j/distance/DistanceUtils.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,6 @@ public static double[] vectorBoxCorner(double[] center, double[] result, double
163163
* @param startLon The starting point longitude, in radians
164164
* @param distanceRAD The distance to travel along the bearing in radians.
165165
* @param bearingRAD The bearing, in radians. North is a 0, moving clockwise till radians(360).
166-
* @param ctx
167166
* @param reuse A preallocated object to hold the results.
168167
* @return The destination point, IN RADIANS.
169168
*/

src/main/java/org/locationtech/spatial4j/io/ShapeReader.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,6 @@ public interface ShapeReader extends ShapeIO {
4040
*
4141
* @param reader -- the input. Note, it will not be closed by this function
4242
* @return a valid Shape (never null)
43-
* @throws IOException
44-
* @throws ParseException
45-
* @throws InvalidShapeException
4643
*/
4744
public Shape read(Reader reader) throws IOException, ParseException, InvalidShapeException;
4845
}

src/main/java/org/locationtech/spatial4j/io/WKTReader.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,6 @@ protected State newState(String wktString) {
145145
* dimension and EMPTY token via
146146
* {@link org.locationtech.spatial4j.io.WKTReader.State#nextIfEmptyAndSkipZM()}.
147147
*
148-
* @param state
149148
* @param shapeType Non-Null string; could have mixed case. The first character is a letter.
150149
* @return The shape or null if not supported / unknown.
151150
*/

src/main/java/org/locationtech/spatial4j/io/jts/JtsWKTReaderShapeParser.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ private JtsShapeFactory getShapeFactory() {
5353

5454
/**
5555
* Reads WKT from the {@code str} via JTS's {@link org.locationtech.jts.io.WKTReader}.
56-
* @param str
56+
*
5757
* @param reader <pre>new WKTReader(ctx.getGeometryFactory()))</pre>
5858
* @return Non-Null
5959
*/

src/main/java/org/locationtech/spatial4j/shape/Shape.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,6 @@ public interface Shape {
7575
* rounded-corner buffer, although some shapes might buffer differently. This
7676
* is an optional operation.
7777
*
78-
*
79-
* @param distance
8078
* @return Not null, and the returned shape should contain the current shape.
8179
*/
8280
Shape getBuffered(double distance, SpatialContext ctx);

src/main/java/org/locationtech/spatial4j/shape/ShapeCollection.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ public class ShapeCollection<S extends Shape> extends AbstractList<S> implements
4444
/**
4545
* WARNING: {@code shapes} is copied by reference.
4646
* @param shapes Copied by reference! (make a defensive copy if caller modifies)
47-
* @param ctx
4847
*/
4948
public ShapeCollection(List<S> shapes, SpatialContext ctx) {
5049
if (!(shapes instanceof RandomAccess))

src/main/java/org/locationtech/spatial4j/shape/impl/BufferedLine.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ public class BufferedLine extends BaseShape<SpatialContext> {
4949
* @param pA start point
5050
* @param pB end point
5151
* @param buf the buffer distance in degrees
52-
* @param ctx
5352
*/
5453
public BufferedLine(Point pA, Point pB, double buf, SpatialContext ctx) {
5554
super(ctx);

src/main/java/org/locationtech/spatial4j/shape/impl/BufferedLineString.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ public BufferedLineString(List<Point> points, double buf, SpatialContext ctx) {
5050
* org.locationtech.spatial4j.shape.Point, double)}.
5151
* If true then the buffer for each segment
5252
* is computed.
53-
* @param ctx
5453
*/
5554
public BufferedLineString(List<Point> points, double buf, boolean expandBufForLongitudeSkew,
5655
SpatialContext ctx) {

0 commit comments

Comments
 (0)