add javadoc fixes

davidmoten · Dec 11, 2017 · da0e381 · da0e381
1 parent 178499b
commit da0e381
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/main/java/com/github/davidmoten/rtree/RTree.java b/src/main/java/com/github/davidmoten/rtree/RTree.java
@@ -109,6 +109,8 @@ public static <T, S extends Geometry> RTree<T, S> create() {
     /**
      * Construct an Rtree through STR bulk loading. Default to
      * maxChildren=128, minChildren=64 and fill nodes by a factor of 0.7
+     * 
+     * @param entries entries to add to the R-tree
      *
      * @param <T>
      *            the value type of the entries in the tree
@@ -230,6 +232,9 @@ private Builder() {
 
         /**
          * The factor is used as the fill ratio during bulk loading.
+         * 
+         * @param factor loading factor
+         * @return this
          */
         public Builder loadingFactor(double factor) {
             this.loadingFactor = factor;
@@ -335,7 +340,9 @@ public <T, S extends Geometry> RTree<T, S> create() {
          * <p>
          * Note: this method mutates the input entries, the internal order of the List may be changed.
          * </p>
-         *
+         * 
+         * @param entries entries to be added to the r-tree
+         * @return a loaded RTree
          */
         @SuppressWarnings("unchecked")
         public <T, S extends Geometry> RTree<T, S> create(List<Entry<T, S>> entries) {

diff --git a/src/main/java/com/github/davidmoten/rtree/internal/Line2D.java b/src/main/java/com/github/davidmoten/rtree/internal/Line2D.java
@@ -45,7 +45,6 @@ public float getY2() {
      *            this line segment
      * @return a double value that is the distance from the specified point to the
      *         current line segment.
-     * @see #ptLineDist(double, double)
      * @since 1.2
      */
     public double ptSegDist(double px, double py) {
@@ -74,7 +73,6 @@ public double ptSegDist(double px, double py) {
      *            specified line segment
      * @return a double value that is the distance from the specified point to the
      *         specified line segment.
-     * @see #ptLineDist(double, double, double, double, double, double)
      * @since 1.2
      */
     public static double ptSegDist(double x1, double y1, double x2, double y2, double px,
@@ -104,7 +102,6 @@ public static double ptSegDist(double x1, double y1, double x2, double y2, doubl
      *            specified line segment
      * @return a double value that is the square of the distance from the specified
      *         point to the specified line segment.
-     * @see #ptLineDistSq(double, double, double, double, double, double)
      * @since 1.2
      */
     public static double ptSegDistSq(double x1, double y1, double x2, double y2, double px,