review: Fix JavaDoc refs and language

ibi-group · Jan 18, 2024 · c52680e · c52680e
1 parent 5fa7d61
commit c52680e
Show file tree

Hide file tree

Showing 5 changed files with 122 additions and 124 deletions.
diff --git a/...opentripplanner/routing/algorithm/filterchain/api/TransitGeneralizedCostFilterParams.java b/...opentripplanner/routing/algorithm/filterchain/api/TransitGeneralizedCostFilterParams.java
@@ -1,11 +1,11 @@
 package org.opentripplanner.routing.algorithm.filterchain.api;
 
 import org.opentripplanner.framework.lang.DoubleUtils;
-import org.opentripplanner.routing.algorithm.filterchain.filters.transit.TransitGeneralizedCostFilter;
 import org.opentripplanner.routing.api.request.framework.CostLinearFunction;
 
 /**
- * Input parameters for {@link TransitGeneralizedCostFilter}
+ * Input parameters for
+ * {@link org.opentripplanner.routing.algorithm.filterchain.filters.transit.TransitGeneralizedCostFilter}
  *
  * @param costLimitFunction   Describes the function to calculate the limit for an itinerary based
  *                            on the generalized cost

diff --git a/...lgorithm/filterchain/filters/transit/group/RemoveOtherThanSameLegsMaxGeneralizedCost.java b/...lgorithm/filterchain/filters/transit/group/RemoveOtherThanSameLegsMaxGeneralizedCost.java
@@ -7,16 +7,15 @@
 import java.util.stream.Collectors;
 import org.opentripplanner.model.plan.Itinerary;
 import org.opentripplanner.model.plan.Leg;
-import org.opentripplanner.routing.algorithm.filterchain.filters.transit.TransitGeneralizedCostFilter;
 import org.opentripplanner.routing.algorithm.filterchain.framework.filter.GroupByFilter;
 import org.opentripplanner.routing.algorithm.filterchain.framework.spi.RemoveItineraryFlagger;
 import org.opentripplanner.transit.model.timetable.Trip;
 
 /**
  * This filter remove itineraries, which use the same trips for most of their legs, but where some
  * itineraries have a much higher cost for the other legs. This is similar to {@link
- * TransitGeneralizedCostFilter}, but is used together with {@link GroupByFilter} to filter within
- * the groups.
+ * org.opentripplanner.routing.algorithm.filterchain.filters.transit.TransitGeneralizedCostFilter},
+ * but is used together with {@link GroupByFilter} to filter within the groups.
  */
 public class RemoveOtherThanSameLegsMaxGeneralizedCost implements RemoveItineraryFlagger {
 

diff --git a/.../org/opentripplanner/routing/algorithm/filterchain/framework/spi/ItineraryListFilter.java b/.../org/opentripplanner/routing/algorithm/filterchain/framework/spi/ItineraryListFilter.java
@@ -2,7 +2,6 @@
 
 import java.util.List;
 import org.opentripplanner.model.plan.Itinerary;
-import org.opentripplanner.routing.algorithm.filterchain.framework.filter.MaxLimit;
 
 /**
  * Filter, sort or decorate itineraries. A filter can modify the elements in the list, but not the
@@ -13,9 +12,9 @@
  * in the same filter. Instead, create two filters and insert them after each other in the filter
  * chain.
  * <p>
- * This allows decoration of each filter and makes it easier to reuse logic. Like the {@link
- * MaxLimit} is reused in
- * several places.
+ * This allows decoration of each filter and makes it easier to reuse logic. Like the
+ * {@link org.opentripplanner.routing.algorithm.filterchain.framework.filter.MaxLimit} is reused
+ * in several places.
  */
 public interface ItineraryListFilter {
   /**