From 385eab07bef28d42e55bcab757f18864124523ab Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Wed, 11 Dec 2013 20:01:53 +0100 Subject: Update Travel::Status::DE::ASEAG documentation --- lib/Travel/Status/DE/ASEAG.pm | 45 +++++++++++++++++++++++++++++-------------- 1 file changed, 31 insertions(+), 14 deletions(-) diff --git a/lib/Travel/Status/DE/ASEAG.pm b/lib/Travel/Status/DE/ASEAG.pm index ada29e4..3a22652 100644 --- a/lib/Travel/Status/DE/ASEAG.pm +++ b/lib/Travel/Status/DE/ASEAG.pm @@ -250,32 +250,49 @@ Schedule information is not included. =item my $status = Travel::Status::DE::ASEAG->new(I<%opt>) Requests the departures as specified by I and returns a new -Travel::Status::DE::ASEAG object. Dies if the wrong I were passed. +Travel::Status::DE::ASEAG object. -Arguments: +Accepts the same options is C<< $status->results >>. Options specified here +can be overridden later, but may limit the set of available departures. + + +=item $status->errstr + +In case of an HTTP request error, returns a string describing it. If none +occured, returns undef. + +=item $status->results(I<%opt>) + +Returns a list of Travel::Status::DE::ASEAG::Result(3pm) objects, each describing +one departure. + +Accepted parameters (all are optional): =over -=item B => I +=item B => B|B|I (default 0) -Name of the stop to list departures for. +When set to a true value: Compute B fields in all +Travel::Status::DE::ASEAG::Result(3pm) objects, otherwise they will not be +set. -=item B => I +B / B limits the timetable to stops before / after the stop +I (if set). -A true value (default) allows fuzzy matching for the I set above, -a false one requires an exact string match. +=item B => I (default 1) -=back +A true value allows fuzzy matching for the I set above, a false one +requires an exact string match. -=item $status->errstr +=item B => I (default 1) -In case of an HTTP request error, returns a string describing it. If none -occured, returns undef. +Do not include past departures in the result list and the computed timetables. -=item $status->results +=item B => I -Returns a list of Travel::Status::DE::ASEAG::Result(3pm) objects, each describing -one departure. +Only return departures at stop I. + +=back =back -- cgit v1.2.3