From 4670348869ad61c33a6d9d9e6eb88587cb8273b3 Mon Sep 17 00:00:00 2001 From: Birte Kristina Friesel Date: Tue, 2 Apr 2024 19:08:58 +0200 Subject: Update get_active_service documentation --- lib/Travel/Status/DE/HAFAS.pm | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/lib/Travel/Status/DE/HAFAS.pm b/lib/Travel/Status/DE/HAFAS.pm index 204c33a..c21169f 100644 --- a/lib/Travel/Status/DE/HAFAS.pm +++ b/lib/Travel/Status/DE/HAFAS.pm @@ -1375,17 +1375,37 @@ arguments. Otherwise, the caller must specify B and B =item $status->get_active_service Returns a hashref describing the active service when a service is active and -nothing otherwise. The hashref contains the keys B (URL to the station -board service), B (URL to the stopfinder service, if supported), -B, and B (arrayref describing the supported modes of -transport, may contain duplicates). +nothing otherwise. The hashref contains the following keys. + +=over + +=item B => I + +service name, e.g. Bay Area Rapid Transit or Deutsche Bahn. + +=item B => I + +HAFAS backend URL + +=item B => I + +Languages supported by the backend; see the constructor's B argument. + +=item B => I + +MOT bits supported by the backend. I contains either strings +(one string per mode of transit) or arrayrefs (one string pair per mode of +transit, with the first entry referring to the MOT identifier and the second +one containing a slightly longer description of it). + +=back =item Travel::Status::DE::HAFAS::get_services() Returns an array containing all supported HAFAS services. Each element is a hashref and contains all keys mentioned in B. It also contains a B key, which is the service name used by -the constructor's B parameter. +the constructor's B parameter, e.g. BART or DB. =item Travel::Status::DE::HAFAS::get_service(I<$service>) -- cgit v1.2.3