Skip to content

Commit

Permalink
Get rid of javadoc errors/warnings after #33
Browse files Browse the repository at this point in the history
  • Loading branch information
halset committed Jul 9, 2020
1 parent 795492f commit 6ddebd9
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 9 deletions.
8 changes: 7 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@
<groupId>no.ecc.vectortile</groupId>
<artifactId>java-vector-tile</artifactId>
<packaging>jar</packaging>
<version>1.3.9</version>
<version>1.3.10-SNAPSHOT</version>
<name>java-vector-tile</name>
<url>http://maven.apache.org</url>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>

<dependencies>

Expand Down Expand Up @@ -70,6 +75,7 @@
<configuration>
<quiet>true</quiet>
<source>8</source>
<excludePackageNames>vector_tile</excludePackageNames>
</configuration>
<executions>
<execution>
Expand Down
21 changes: 13 additions & 8 deletions src/main/java/no/ecc/vectortile/VectorTileEncoder.java
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ public VectorTileEncoder() {
/**
* Create a {@link VectorTileEncoder} with the given extent and a clip
* buffer of 8.
*
* @param extent a int to specify vector tile extent. 4096 is a good value.
*/
public VectorTileEncoder(int extent) {
this(extent, 8, true);
Expand Down Expand Up @@ -106,7 +108,9 @@ public VectorTileEncoder(int extent, int clipBuffer, boolean autoScale, boolean
* will scale them automatically to the 0..extent-1 range before
* encoding. when false, the encoder expects coordinates in the
* 0..extent-1 range.
* @param autoincrementIds
* @param autoincrementIds
* when true the vector tile feature id is auto incremented when using
* {@link #addFeature(String, Map, Geometry)}
* @param simplificationDistanceTolerance
* a positive double representing the distance tolerance to be used
* for non-points before (optional) scaling and encoding. A value
Expand Down Expand Up @@ -148,10 +152,10 @@ public void addFeature(String layerName, Map<String, ?> attributes, Geometry geo
* For optimization, geometries will be clipped and simplified. Features with
* geometries outside of the tile will be skipped.
*
* @param layerName
* @param attributes
* @param geometry
* @param id
* @param layerName a {@link String} with the vector tile layer name.
* @param attributes a {@link Map} with the vector tile feature attributes.
* @param geometry a {@link Geometry} for the vector tile feature.
* @param id a long with the vector tile feature id field.
*/
public void addFeature(String layerName, Map<String, ?> attributes, Geometry geometry, long id) {

Expand Down Expand Up @@ -223,7 +227,8 @@ public void addFeature(String layerName, Map<String, ?> attributes, Geometry geo
* points to improve performance. This method can be overridden to change
* clipping behavior. See also {@link #clipGeometry(Geometry)}.
*
* @see https://github.com/ElectronicChartCentre/java-vector-tile/issues/13
* @param geom a {@link Geometry} to check for "covers"
* @return a boolean true when the current clip geometry covers the given geom.
*/
protected boolean clipCovers(Geometry geom) {
if (geom instanceof Point) {
Expand All @@ -238,8 +243,8 @@ protected boolean clipCovers(Geometry geom) {
* can be overridden to change clipping behavior. See also
* {@link #clipCovers(Geometry)}.
*
* @param geometry
* @return
* @param geometry a {@link Geometry} to check for intersection with the current clip geometry
* @return a boolean true when current clip geometry intersects with the given geometry.
*/
protected Geometry clipGeometry(Geometry geometry) {
try {
Expand Down

0 comments on commit 6ddebd9

Please sign in to comment.