summaryrefslogtreecommitdiff
path: root/lib/Travel/Status/DE/HAFAS.pm
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2024-08-19 19:35:42 +0200
committerBirte Kristina Friesel <derf@finalrewind.org>2024-08-19 19:35:42 +0200
commite79b3f6852fbb929fbce3635f54eb1a74ee75b2b (patch)
tree0be74883d7bc244f95263d676cef594249a7ed2d /lib/Travel/Status/DE/HAFAS.pm
parent02fa51f0fe82f8490c376e5e279367d57d15e42a (diff)
HAFAS(3pm): get_service: Document coverage and homepage keys
Diffstat (limited to 'lib/Travel/Status/DE/HAFAS.pm')
-rw-r--r--lib/Travel/Status/DE/HAFAS.pm19
1 files changed, 15 insertions, 4 deletions
diff --git a/lib/Travel/Status/DE/HAFAS.pm b/lib/Travel/Status/DE/HAFAS.pm
index 3190bac..0a4d0e4 100644
--- a/lib/Travel/Status/DE/HAFAS.pm
+++ b/lib/Travel/Status/DE/HAFAS.pm
@@ -1124,18 +1124,29 @@ nothing otherwise. The hashref contains the following keys.
=over
-=item B<name> => I<string>
+=item B<coverage> => I<hashref>
-service name, e.g. Bay Area Rapid Transit or Deutsche Bahn.
+Area in which the service provides near-optimal coverage. Typically, this means
+a (nearly) complete list of departures and real-time data. The hashref contains
+two optional keys: B<area> (GeoJSON) and B<regions> (list of strings, e.g. "DE"
+or "CH-BE").
-=item B<mgate> => I<string>
+=item B<homepage> => I<string>
-HAFAS backend URL
+Homepage URL of the service provider.
=item B<languages> => I<arrayref>
Languages supported by the backend; see the constructor's B<language> argument.
+=item B<name> => I<string>
+
+Service name, e.g. Bay Area Rapid Transit or Deutsche Bahn.
+
+=item B<mgate> => I<string>
+
+HAFAS backend URL
+
=item B<productbits> => I<arrayref>
MOT bits supported by the backend. I<arrayref> contains either strings