From f785343519efe582c3ef452f96a8400cfcab33df Mon Sep 17 00:00:00 2001 From: Tilmann Date: Sat, 12 Aug 2023 13:18:34 +0200 Subject: [PATCH] javadoc regressions --- CHANGELOG.md | 1 + src/main/java/org/tinspin/index/BoxMap.java | 1 + src/main/java/org/tinspin/index/BoxMultimap.java | 1 + src/main/java/org/tinspin/index/PointMap.java | 1 + src/main/java/org/tinspin/index/PointMultimap.java | 1 + src/main/java/org/tinspin/index/rtree/RTreeEntry.java | 8 ++++++-- 6 files changed, 11 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 68e2dc0..4539b17 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. [#29](https://github.com/tzaeschke/tinspin-indexes/pull/29) ### Fixed +- Fix javadoc regressions. [#32](https://github.com/tzaeschke/tinspin-indexes/pull/32) - Test candidates should counsistently use integers as values. [#31](https://github.com/tzaeschke/tinspin-indexes/pull/31) - Remove erroneous references to GPL 3.0. This library is APL 2.0 only. diff --git a/src/main/java/org/tinspin/index/BoxMap.java b/src/main/java/org/tinspin/index/BoxMap.java index 2fe5a6d..917d8e9 100644 --- a/src/main/java/org/tinspin/index/BoxMap.java +++ b/src/main/java/org/tinspin/index/BoxMap.java @@ -206,6 +206,7 @@ static BoxMap createRStarTree(int dims) { * @param dims Number of dimensions. * @param entries All entries of the tree. Entries can be created with * {@link RTreeEntry#createBox(double[], double[], Object)} + * @param Value type * @return New STR-loaded R*Tree */ static BoxMap createAndLoadStrRTree(int dims, RTreeEntry[] entries) { diff --git a/src/main/java/org/tinspin/index/BoxMultimap.java b/src/main/java/org/tinspin/index/BoxMultimap.java index 65a037c..b96617a 100644 --- a/src/main/java/org/tinspin/index/BoxMultimap.java +++ b/src/main/java/org/tinspin/index/BoxMultimap.java @@ -227,6 +227,7 @@ static BoxMultimap createRStarTree(int dims) { * @param dims Number of dimensions. * @param entries All entries of the tree. Entries can be created with * {@link RTreeEntry#createBox(double[], double[], Object)} + * @param Value type * @return New STR-loaded R*Tree */ static BoxMultimap createAndLoadStrRTree(int dims, RTreeEntry[] entries) { diff --git a/src/main/java/org/tinspin/index/PointMap.java b/src/main/java/org/tinspin/index/PointMap.java index 783cc6c..05e5a69 100644 --- a/src/main/java/org/tinspin/index/PointMap.java +++ b/src/main/java/org/tinspin/index/PointMap.java @@ -271,6 +271,7 @@ static PointMap createRStarTree(int dims) { * @param dims Number of dimensions. * @param entries All entries of the tree. Entries can be created with * {@link RTreeEntry#createPoint(double[], Object)} + * @param Value type * @return New STR-loaded R*Tree */ static PointMap createAndLoadStrRTree(int dims, RTreeEntry[] entries) { diff --git a/src/main/java/org/tinspin/index/PointMultimap.java b/src/main/java/org/tinspin/index/PointMultimap.java index 41f6f99..c88d78f 100644 --- a/src/main/java/org/tinspin/index/PointMultimap.java +++ b/src/main/java/org/tinspin/index/PointMultimap.java @@ -285,6 +285,7 @@ static PointMultimap createRStarTree(int dims) { * @param dims Number of dimensions. * @param entries All entries of the tree. Entries can be created with * {@link RTreeEntry#createPoint(double[], Object)} + * @param Value type * @return New STR-loaded R*Tree */ static PointMultimap createAndLoadStrRTree(int dims, RTreeEntry[] entries) { diff --git a/src/main/java/org/tinspin/index/rtree/RTreeEntry.java b/src/main/java/org/tinspin/index/rtree/RTreeEntry.java index 747bcda..8f8a94e 100644 --- a/src/main/java/org/tinspin/index/rtree/RTreeEntry.java +++ b/src/main/java/org/tinspin/index/rtree/RTreeEntry.java @@ -24,9 +24,11 @@ public class RTreeEntry extends BoxEntry { /** * Create a new entry based on an axis aligned box. - * @param min Box minimum - * @param max Box maximum + * @param min Box minimum + * @param max Box maximum * @param value The value associated with the box. + * @param Value type + * @return New BoxEntry */ public static RTreeEntry createBox(double[] min, double[] max, T value) { return new RTreeEntry<>(min, max, value); @@ -36,6 +38,8 @@ public static RTreeEntry createBox(double[] min, double[] max, T value) { * Create a new R-Tree entry based on a point coordinate. * @param point The point. * @param value The value associated with the point. + * @param Value type + * @return New PointEntry */ public static RTreeEntry createPoint(double[] point, T value) { return new RTreeEntry<>(point, point, value);