More documentation

1 files changed, 52 insertions, 0 deletions

diff --git a/lib/Travel/Status/DE/VRR/Result.pm b/lib/Travel/Status/DE/VRR/Result.pm
index a61a9d2..083e225 100644
--- a/lib/Travel/Status/DE/VRR/Result.pm
+++ b/lib/Travel/Status/DE/VRR/Result.pm
@@ -29,24 +29,72 @@ departure received by Travel::Status::DE::VRR
 
 =head1 SYNOPSIS
 
+    for my $departure ($status->results) {
+        printf(
+            "At %s: %s to %s from platform %s\n",
+            $departure->time, $departure->line, $departure->destination,
+            $departure->platform
+        );
+    }
+
 =head1 VERSION
 
 version 0.00
 
 =head1 DESCRIPTION
 
+Travel::Status::DE::VRR::Result describes a single departure as obtained by
+TRavel::Status::DE::VRR.  It contains information about the time, platform,
+line number and destination.
+
 =head1 METHODS
 
 =head2 ACCESSORS
 
 =over
 
+=item $departure->destination
+
+The tram/bus/train destination.
+
+=item $departure->line
+
+The name/number of the line.
+
+=item $departure->platform
+
+The departure platform.  Note that this is prefixed by either "Bstg." (for
+tram/bus departures) or "Gleis" (for trains).
+
+=item $departure->time
+
+The departure time as string in "HH:MM" format.
+
 =back
 
 =head2 INTERNAL
 
 =over
 
+=item $departure = Travel::Status::DE::VRR::Result->new(I<%data>)
+
+Returns a new Travel::Status::DE::VRR::Result object.  You should not need to
+call this.
+
+Required I<data>:
+
+=over
+
+=item B<destination> => I<string>
+
+=item B<line> => I<string>
+
+=item B<platform> => I<string>
+
+=item B<time> => I<string>
+
+=back
+
 =back
 
 =head1 DIAGNOSTICS
@@ -63,8 +111,12 @@ None.
 
 =head1 BUGS AND LIMITATIONS
 
+Unknown.
+
 =head1 SEE ALSO
 
+Travel::Status::DE::VRR(3pm).
+
 =head1 AUTHOR
 
 Copyright (C) 2011 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>