Added JavaDoc to TripTimes

opentripplanner · Nov 30, 2023 · 7d052cb · 7d052cb
1 parent ebbe2fd
commit 7d052cb
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/main/java/org/opentripplanner/transit/model/timetable/TripTimes.java b/src/main/java/org/opentripplanner/transit/model/timetable/TripTimes.java
@@ -10,6 +10,15 @@
 import org.opentripplanner.model.BookingInfo;
 import org.opentripplanner.transit.model.basic.Accessibility;
 
+/**
+ * A TripTimes represents the arrival and departure times for a single trip in a timetable. It is
+ * one of the core class used for transit routing. This interface allow different kind of trip
+ * to implement their own trip times. Scheduled/planned trips should be immutable, real-time
+ * trip times should allow updates and more info, frequency-based trips can use a more compact
+ * implementation, and Flex may expose part of the trip as a "scheduled/regular" stop-to-stop
+ * trip using this interface. All times are expressed as seconds since midnight (as in
+ * GTFS).
+ */
 public interface TripTimes extends Serializable, Comparable<TripTimes> {
   /**
    * Copy scheduled times, but not the actual times.