From ee919bea86e26d3ba8050cf2daf935b3e4ae9e50 Mon Sep 17 00:00:00 2001
From: Thomas Gran <t2gran@gmail.com>
Date: Thu, 25 Aug 2022 14:16:48 +0200
Subject: [PATCH] doc: Document why unused parameters in Raptor API should NOT
 be deleted.

---
 .../transit/raptor/api/response/StopArrivals.java           | 6 ++++++
 .../transit/raptor/rangeraptor/internalapi/Heuristics.java  | 3 +++
 2 files changed, 9 insertions(+)

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
index f167d0ccad4..1c89945bf23 100644
--- 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
index 27c6e3e9138..b8447814c79 100644
--- 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();
 
   /**