summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2011-06-28 10:57:36 +0200
committerDaniel Friesel <derf@finalrewind.org>2011-06-28 10:57:36 +0200
commitc1c3afa66bf6e2ad0b1a1731c057f10468605468 (patch)
treeb78ceb94a151a87ba1494f70c6a0ad74a20fae26
parented8f38f2ae20a6f794aa6ce322df47ce92c46555 (diff)
VRR.pm: Document new submit behaviour
-rw-r--r--lib/Travel/Routing/DE/VRR.pm19
1 files changed, 15 insertions, 4 deletions
diff --git a/lib/Travel/Routing/DE/VRR.pm b/lib/Travel/Routing/DE/VRR.pm
index 73de3d1..62d6a3e 100644
--- a/lib/Travel/Routing/DE/VRR.pm
+++ b/lib/Travel/Routing/DE/VRR.pm
@@ -636,9 +636,10 @@ It uses B<LWP::USerAgent> and B<XML::LibXML> for this.
=over
-=item $efa = Travel::Routing::DE::VRR->new(I<%conf>)
+=item $efa = Travel::Routing::DE::VRR->new(I<%opts>)
-Returns a new Travel::Routing::DE::VRR object and sets up its POST data via %conf.
+Returns a new Travel::Routing::DE::VRR object and sets up its POST data via
+%opts.
Valid hash keys and their values are:
@@ -704,12 +705,22 @@ Set walk speed. Default: B<normal>
If true: Prefer connections allowing passengers with bikes
+=item B<lwp_options> => I<\%hashref>
+
+Options to pass to C<< LWP::UserAgent->new >>.
+
+=item B<submit> => B<0>|B<1>
+
+By default, B<new> will create a POST request and submit it to
+L<http://efa.vrr.de>. If you do not want it to be submitted yet, set this to
+B<0>.
+
=back
=item $efa->submit(I<%opts>)
-Submit the query to B<http://efa.vrr.de>.
-I<%opts> is passed on to C<< LWP::UserAgent->new(%opts) >>.
+Submit the query to L<http://efa.vrr.de>.
+I<%opts> is passed on to C<< LWP::UserAgent->new >>.
=item $efa->routes()