Unverified Commit 54b26725 authored by Birte Kristina Friesel's avatar Birte Kristina Friesel
Browse files

Info(3pm): Extend documentation

parent 64c3769d
Loading
Loading
Loading
Loading
+40 −11
Original line number Diff line number Diff line
@@ -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

=head1 METHODS
URL to a site related to this information message.
The site may or may not hold additional data.

=head2 ACCESSORS
=item $info->link_text

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).