add java doc

jessicaKoehnke · jessicaKoehnke · commit 0abc62a67f6e · 2025-12-05T13:59:03.000+01:00
diff --git a/application/src/main/java/org/opentripplanner/transfer/TransferRepository.java b/application/src/main/java/org/opentripplanner/transfer/TransferRepository.java
@@ -8,6 +8,13 @@
 import org.opentripplanner.routing.api.request.StreetMode;
 import org.opentripplanner.transit.model.site.StopLocation;
 
+/**
+ * This repository holds all transfers that are calculated between different stops for different
+ * modes. It is populated during the graph build process and saved into the serialized graph object.
+ * It should only be accessed directly during graph building, not during OTP server runtime. Use the
+ * {@link TransferService} instead, once transfer updates are implemented it will handle mutability
+ * correctly.
+ */
 public interface TransferRepository extends Serializable {
   Collection<PathTransfer> getTransfersByStop(StopLocation stop);
 
diff --git a/application/src/main/java/org/opentripplanner/transfer/TransferService.java b/application/src/main/java/org/opentripplanner/transfer/TransferService.java
@@ -4,6 +4,11 @@
 import org.opentripplanner.model.PathTransfer;
 import org.opentripplanner.transit.model.site.StopLocation;
 
+/**
+ * Access transfers during OTP server runtime. It provides a frozen view of all these elements at a
+ * point in time, which is not affected by ongoing transfer updates, allowing results to remain
+ * stable over the course of a request.
+ */
 public interface TransferService {
 
   Collection<PathTransfer> getTransfersByStop(StopLocation stop);
