doc: Document why unused parameters in Raptor API should NOT be deleted.

opentripplanner · Aug 25, 2022 · ee919be · ee919be
1 parent f791309
commit ee919be
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/src/main/java/org/opentripplanner/transit/raptor/api/response/StopArrivals.java b/src/main/java/org/opentripplanner/transit/raptor/api/response/StopArrivals.java
@@ -13,7 +13,10 @@ public interface StopArrivals {
   /**
    * The earliest arrival time at the given stop. If the stop is not reached, the behavior is
    * undefined; It may return an arbitrary value or throw an exception.
+   * <p>
+   * This is currently unused in OTP, but useful for analyses/comparing the results.
    */
+  @SuppressWarnings("unused")
   int bestArrivalTime(int stopIndex);
 
   /**
@@ -30,6 +33,9 @@ public interface StopArrivals {
   /**
    * The smallest number of transfers needed to reach the given stop. If the stop is not reached,
    * the behavior is undefined; It may return an arbitrary value or throw an exception.
+   * <p>
+   * This is currently unused in OTP, but useful for analyses/comparing the results.
    */
+  @SuppressWarnings("unused")
   int smallestNumberOfTransfers(int stopIndex);
 }
diff --git a/src/main/java/org/opentripplanner/transit/raptor/rangeraptor/internalapi/Heuristics.java b/src/main/java/org/opentripplanner/transit/raptor/rangeraptor/internalapi/Heuristics.java
@@ -47,7 +47,10 @@ public interface Heuristics {
 
   /**
    * Return the best/minimum required number of transfers from origin to destination.
+   * <p>
+   * Currently unused, but useful for debugging.
    */
+  @SuppressWarnings("unused")
   int bestOverallJourneyNumOfTransfers();
 
   /**