Update documentation

ibi-group · Nov 7, 2024 · 642ae33 · 642ae33
1 parent 5cbc9d3
commit 642ae33
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/application/src/main/java/org/opentripplanner/osm/model/OsmWithTags.java b/application/src/main/java/org/opentripplanner/osm/model/OsmWithTags.java
@@ -222,6 +222,12 @@ public OptionalInt getTagAsInt(String tag, Consumer<String> errorHandler) {
 
   /**
    * Some tags are allowed to have values like 55, "true" or "false".
+   * <p>
+   * "true", "yes" is returned as 1.
+   * <p>
+   * "false", "no" is returned as 0
+   * <p>
+   * Everything else is returned as an emtpy optional.
    */
   public OptionalInt parseIntOrBoolean(String tag, Consumer<String> errorHandler) {
     var maybeInt = getTagAsInt(tag, errorHandler);