release preparations (full-route/route in efa-m will be left out for now)

5 files changed, 30 insertions, 13 deletions

diff --git a/Changelog b/Changelog
index a25bb8f..3469ba3 100644
--- a/Changelog
+++ b/Changelog
@@ -6,8 +6,8 @@ git HEAD
     * EFA->new: Add full_routes config option
     * EFA: Add identified_data accessor
     * Result: Add route_pre, route_post and route_interesting accessors
-    * efa-m: Add -v / --via option
     * Add Travel::Routing::DE::EFA::Stop module
+    * efa-m: Add -v / --via option
 
 Travel::Status::DE::VRR 1.09 - Thu Apr 30 2015
 
diff --git a/bin/efa-m b/bin/efa-m
index 5bea941..8774a41 100755
--- a/bin/efa-m
+++ b/bin/efa-m
@@ -288,11 +288,6 @@ I<type>.  Supported types are B<address> and B<poi> (point of interest).
 Show departures for I<date> instead of today.
 May also be specified as I<dd.mm.>
 
-=item B<-f>, B<--full-route>
-
-Show all stops between I<city> I<name> (the requested stop) and a departure's
-destination. Arrival and departure time at each stop are displayed as well.
-
 =item B<-L>, B<--linelist>
 
 Do not show departures. Instead, list all lines serving the specified place.
@@ -335,7 +330,7 @@ value to disable it.
 
 =item B<-v>, B<--via> I<station>
 
-Only show trains serving I<station> after the requseted I<stop>. I<station>
+Only show trains serving I<station> after the requseted stop. I<station>
 is matched against the "I<city> I<stop>" fields in each line's route.
 Regular expressions are also supported.
 
diff --git a/lib/Travel/Status/DE/EFA.pm b/lib/Travel/Status/DE/EFA.pm
index ecf2b79..12e11dd 100644
--- a/lib/Travel/Status/DE/EFA.pm
+++ b/lib/Travel/Status/DE/EFA.pm
@@ -578,6 +578,12 @@ Default: 10 seconds. Set to 0 or a negative value to disable it.
 In case of an HTTP request or EFA error, returns a string describing it. If
 none occured, returns undef.
 
+=item $status->identified_data
+
+Returns a list of the identified values for I<place> and I<name>.
+For instance, when requesting data for "E", "MartinSTR", B<identified_data>
+will return ("Essen", "Martinstr.").
+
 =item $status->lines
 
 Returns a list of Travel::Status::DE::EFA::Line(3pm) objects, each one
diff --git a/lib/Travel/Status/DE/EFA/Result.pm b/lib/Travel/Status/DE/EFA/Result.pm
index da8c5d3..ff953a6 100644
--- a/lib/Travel/Status/DE/EFA/Result.pm
+++ b/lib/Travel/Status/DE/EFA/Result.pm
@@ -200,18 +200,18 @@ which also may have the same numbers.
 =item $departure->route_interesting
 
 List of up to three "interesting" stations served by this departure. Is a
-subset of B<route_post>. Each station is a hash reference, see ROUTE STATIONS
-for details.
+subset of B<route_post>. Each station is a Travel::Status::DE::EFA::Stop(3pm)
+object.
 
 =item $departure->route_pre
 
 List of stations the train passed (or will have passed) befoe this stop.
-Each station is a hash reference, see ROUTE STATIONS for details.
+Each station is a Travel::Status::DE::EFA::Stop(3pm) object.
 
 =item $departure->route_post
 
 List of stations the train will pass after this stop.
-Each station is a hash reference, see ROUTE STATIONS for details.
+Each station is a Travel::Status::DE::EFA::Stop(3pm) object.
 
 =item $departure->sched_date
 
diff --git a/lib/Travel/Status/DE/EFA/Stop.pm b/lib/Travel/Status/DE/EFA/Stop.pm
index a4b3b61..b94b9ea 100644
--- a/lib/Travel/Status/DE/EFA/Stop.pm
+++ b/lib/Travel/Status/DE/EFA/Stop.pm
@@ -52,30 +52,46 @@ version 1.09
 
 =head1 DESCRIPTION
 
-Travel::Status::DE::EFA::stop describes a TODO.
+Travel::Status::DE::EFA::Stop describes a single stop of a departure's
+route. It is solely based on the respective departure's schedule.
 
 =head1 METHODS
 
 =head2 ACCESSORS
 
-TODO
+All accessors return schedule data. Realtime data is not available.
 
 =over
 
 =item $stop->arr_date
 
+arrival date (DD.MM.YYYY). undef if this is the first scheduled stop.
+
 =item $stop->arr_time
 
+arrival time (HH:MM). undef if this is the first scheduled stop.
+
 =item $stop->dep_date
 
+departure date (DD.MM.YYYY). undef if this is the final scehduled stop.
+
 =item $stop->dep_time
 
+departure time (HH:MM). undef if this is the final scehduled stop.
+
 =item $stop->name
 
+stop name with city prefix ("I<City> I<Stop>", for instance
+"Essen RE<uuml>ttenscheider Stern").
+
 =item $stop->name_suf
 
+stop name without city prefix, for instance "RE<uuml>ttenscheider Stern".
+
 =item $stop->platform
 
+Platform name/number if available, empty string otherwise.
+
 =back
 
 =head2 INTERNAL