javadoc comment for Ratio class

opentripplanner · Jan 9, 2025 · ff8411a · ff8411a
1 parent 4788055
commit ff8411a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/application/src/main/java/org/opentripplanner/transit/model/basic/Ratio.java b/application/src/main/java/org/opentripplanner/transit/model/basic/Ratio.java
@@ -2,6 +2,11 @@
 
 import java.util.Objects;
 
+/**
+ * Represents a ratio within the range [0, 1].
+ * The class ensures that the ratio value, represented as a double,
+ * falls withing the specified range.
+ */
 public class Ratio {
 
   private final Double ratio;