From 26deb42e6fca8206c437eb3223429ac0fec84fc2 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Mon, 23 May 2011 15:10:24 +0200
Subject: More descriptive accessor names in Net::Travel::DE::VRR::Route::Part

---
 lib/Net/Travel/DE/VRR/Route.pm | 33 ++++++++++++++++++++++++++++++---
 1 file changed, 30 insertions(+), 3 deletions(-)

(limited to 'lib/Net/Travel/DE/VRR/Route.pm')

diff --git a/lib/Net/Travel/DE/VRR/Route.pm b/lib/Net/Travel/DE/VRR/Route.pm
index 1b71097..7089120 100644
--- a/lib/Net/Travel/DE/VRR/Route.pm
+++ b/lib/Net/Travel/DE/VRR/Route.pm
@@ -39,30 +39,57 @@ Net::Travel::DE::VRR::Route - Single route (connection) between two points
 
 =head1 SYNOPSIS
 
+	for my $route ( $efa->routes() ) {
+		for my $part ( $route->parts() ) {
+			# $part is a Net::Travel::DE::VRR::Route::Part object
+		}
+	}
+
 =head1 VERSION
 
 version 1.3
 
 =head1 DESCRIPTION
 
+Net::Travel::DE::VRR::Route describes a single method of getting from one
+point to another.  It holds a bunch of Net::Travel::DE::VRR::Route::Part(3pm)
+objects describing the parts of the route in detail.  Each part depends on the
+previous one.
+
+You usually want to acces it via C<< $efa->routes() >>.
+
 =head1 METHODS
 
 =over
 
+=item my $route = Net::Travel::DE::VRR::Route->new(I<@parts>)
+
+Creates a new Net::Travel::DE::VRR::Route elements consisting of I<parts>,
+which are Net::Travel::DE::VRR::Route::Part elements.
+
+=item $route->parts()
+
+Returns a list of Net::Travel::DE::VRR::Route::Part(3pm) elements describing
+the actual route.
+
 =back
 
 =head1 DIAGNOSTICS
 
+None.
+
 =head1 DEPENDENCIES
 
-=over
-
-=back
+None.
 
 =head1 BUGS AND LIMITATIONS
 
+None known.
+
 =head1 SEE ALSO
 
+Net::Travel::DE::VRR(3pm), Net::Travel::DE::VRR::Route::Part(3pm).
+
 =head1 AUTHOR
 
 Copyright (C) 2011 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>
-- 
cgit v1.2.3