Update docs

opentripplanner · Oct 6, 2024 · 700d4ef · 700d4ef
1 parent beb76d5
commit 700d4ef
Showing 1 changed file with 12 additions and 5 deletions.
diff --git a/src/main/java/org/opentripplanner/apis/vectortiles/model/StyleBuilder.java b/src/main/java/org/opentripplanner/apis/vectortiles/model/StyleBuilder.java
@@ -95,11 +95,6 @@ public StyleBuilder typeLine() {
     return this;
   }
 
-  public StyleBuilder group(String group) {
-    metadata.put("group", group);
-    return this;
-  }
-
   public StyleBuilder typeFill() {
     type(LayerType.Fill);
     return this;
@@ -115,6 +110,15 @@ private StyleBuilder type(LayerType type) {
     return this;
   }
 
+  /**
+   * Puts the layer into an arbitrarily defined group in the layer selector. This allows you
+   * to switch the entire group on and off.
+   */
+  public StyleBuilder group(String group) {
+    metadata.put("group", group);
+    return this;
+  }
+
   public StyleBuilder lineText(String name) {
     layout.put("symbol-placement", "line");
     layout.put("symbol-spacing", 500);
@@ -204,6 +208,9 @@ public final StyleBuilder edgeFilter(Class<? extends Edge>... classToFilter) {
     return filterClasses(classToFilter);
   }
 
+  /**
+   * Filter the entities by their "permission" property.
+   */
   public final StyleBuilder permissionsFilter(StreetTraversalPermission p) {
     filter = List.of("==", "permission", p.name());
     return this;