From 2b997d89906598b0de774cadb40ca42ec66c87d4 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Sun, 21 Jun 2015 21:45:46 +0200
Subject: document route functions

---
 lib/Travel/Status/DE/EFA.pm | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'lib/Travel/Status/DE/EFA.pm')

diff --git a/lib/Travel/Status/DE/EFA.pm b/lib/Travel/Status/DE/EFA.pm
index 00338b7..f261855 100644
--- a/lib/Travel/Status/DE/EFA.pm
+++ b/lib/Travel/Status/DE/EFA.pm
@@ -328,6 +328,10 @@ sub parse_route {
 		my @dates = $e->findnodes($xp_routepoint_date);
 		my @times = $e->findnodes($xp_routepoint_time);
 
+		# note that the first stop has an arrival node with an invalid
+		# timestamp and the terminal stop has a departure node with an
+		# invalid timestamp.  sprintf_{date,time} return undef in these
+		# cases.
 		push(
 			@ret,
 			{
@@ -555,6 +559,12 @@ B<stop> (stop/station name).
 
 address / poi / stop name to list departures for.
 
+=item B<full_routes> => B<0>|B<1>
+
+If true: Request full routes for all departures from the backend. This
+enables the B<route_pre>, B<route_post> and B<route_interesting> accessors in
+Travel::Status::DE::EFA::Result(3pm).
+
 =item B<timeout> => I<seconds>
 
 Request timeout, the argument is passed on to LWP::UserAgent(3pm).
-- 
cgit v1.2.3