summaryrefslogtreecommitdiff
path: root/lib/Travel/Status/DE/EFA/Info.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Travel/Status/DE/EFA/Info.pm')
-rw-r--r--lib/Travel/Status/DE/EFA/Info.pm51
1 files changed, 40 insertions, 11 deletions
diff --git a/lib/Travel/Status/DE/EFA/Info.pm b/lib/Travel/Status/DE/EFA/Info.pm
index 459f2e7..2033e2a 100644
--- a/lib/Travel/Status/DE/EFA/Info.pm
+++ b/lib/Travel/Status/DE/EFA/Info.pm
@@ -45,24 +45,57 @@ __END__
=head1 NAME
-Travel::Status::DE::EFA::Info - Information about a station
+Travel::Status::DE::EFA::Info - Information about a public transit stop
=head1 SYNOPSIS
+ if ( $info->subject and $info->subtitle ne $info->subject ) {
+ printf( "# %s\n%s\n", $info->subtitle, $info->subject );
+ }
+ else {
+ printf( "# %s\n", $info->subtitle );
+ }
+
=head1 VERSION
version 3.01
=head1 DESCRIPTION
-Travel::Status::DE::EFA::Info describes a tram/bus/train line departing at the
-stop requested by Travel::Status::DE::EFA. Note that it only covers one
-direction, so in most cases, you get two Travel::Status::DE::EFA::Info objects
-per actual line.
+Travel::Status::DE::EFA::Info holds a single information message related to
+a specific public transit stop.
+
+=head1 ACCESSORS
+
+All accessors may return undef.
+Individual accessors may return identical strings.
+Strings may contain HTML elements.
+
+=over
+
+=item $info->additional_text
+
+=item $info->content
+
+=item $info->link_url
+
+URL to a site related to this information message.
+The site may or may not hold additional data.
-=head1 METHODS
+=item $info->link_text
-=head2 ACCESSORS
+Text for linking to link_url.
+
+=item $info->param
+
+Hashref of parameters, e.g. C<< incidentDateTime >> (string describing the
+date/time range during which this message is valid).
+
+=item $info->subject
+
+=item $info->subtitle
+
+=back
=head1 DIAGNOSTICS
@@ -76,10 +109,6 @@ None.
=back
-=head1 BUGS AND LIMITATIONS
-
-The B<route> accessor returns a simple string, an array might be better suited.
-
=head1 SEE ALSO
Travel::Status::DE::EFA(3pm).