From 5dc6d0789474de48cf38650cae648c2367477cf7 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Mon, 31 Jan 2011 18:07:21 +0100
Subject: WWW::Efa documentation updates

---
 lib/WWW/Efa.pm | 42 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 40 insertions(+), 2 deletions(-)

(limited to 'lib')

diff --git a/lib/WWW/Efa.pm b/lib/WWW/Efa.pm
index b52121a..39e8d7c 100644
--- a/lib/WWW/Efa.pm
+++ b/lib/WWW/Efa.pm
@@ -29,7 +29,12 @@ WWW::Efa - inofficial interface to the efa.vrr.de German itinerary service
 
 =head1 DESCRIPTION
 
-Foo bar
+B<WWW::Efa> is a client for the efa.vrr.de web interface.
+You pass it the start/stop of your journey, maybe a time and a date and more
+details, and it returns the up-to-date scheduled connections between those two
+stops.
+
+It uses B<LWP::USerAgent> and B<XML::LibXML> for this.
 
 =cut
 
@@ -537,7 +542,8 @@ sub submit {
 
 =head2 $efa->parse()
 
-Parse the B<efa.vrr.de> reply
+Parse the B<efa.vrr.de> reply.
+Returns undef on success and a WWW::Efa::Error object upon failure.
 
 =cut
 
@@ -614,6 +620,38 @@ sub check_no_connections {
 	}
 }
 
+=head2 $efa->connections()
+
+Returns an array of connection elements. Each connection element is an
+arrayref of connection part, and each connecton part is a hash containing the
+following elements:
+
+=over
+
+=item * dep_time
+
+Departure time as a string in HH:MM format
+
+=item * dep_stop
+
+Departure stop, e.g. "Essen HBf"
+
+=item * train_line
+
+Name of the train line, e.g. "S-Bahn S6"
+
+=item * arr_time
+
+Arrival time as a string in HH:MM format
+
+=item * arr_stop
+
+Arrival stop, e.g. "Berlin HBf"
+
+=back
+
+=cut
+
 sub connections {
 	my ($self) = @_;
 
-- 
cgit v1.2.3