Commit 48c69450 authored by Daniel Friesel's avatar Daniel Friesel
Browse files

Journey: document station / station_uic / route_interesting

parent c9ea85b0
Loading
Loading
Loading
Loading
+14 −0
Original line number Diff line number Diff line
@@ -530,6 +530,14 @@ service notices (e.g. "missing carriage") or detailed delay reasons
Returns the operator responsible for this journey. Returns undef
if the backend does not provide an operator.

=item $journey->station (station only)

Name of the station at which this journey was requested.

=item $journey->station_uic (station only)

UIC/EVA ID of the station at which this journey was requested.

=item $journey->route

Returns a list of hashes; each hash describes a single journey stop.
@@ -577,6 +585,12 @@ entire route. Each hash contains the following keys:

Individual entries may be undef.

=item $journey->route_interesting([I<count>])

Return up to I<count> (default: B<3>) parts of C<< $journey->route >> that may
be particularly helpful, e.g. main stations or airports.
Returns a list of hashes, see above for the layout.

=item $journey->route_end

Name of the last route station. In arrival mode, this is where the train