From 8edfa3d6e81e68af6f61bcab313e31928baa1c8c Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Thu, 17 Sep 2015 15:41:19 +0200
Subject: documentation updates

---
 lib/Travel/Status/DE/HAFAS/Result.pm     | 54 ++++++++------------------------
 lib/Travel/Status/DE/HAFAS/StopFinder.pm |  4 +--
 2 files changed, 15 insertions(+), 43 deletions(-)

diff --git a/lib/Travel/Status/DE/HAFAS/Result.pm b/lib/Travel/Status/DE/HAFAS/Result.pm
index 5f766c2..fa1acb7 100644
--- a/lib/Travel/Status/DE/HAFAS/Result.pm
+++ b/lib/Travel/Status/DE/HAFAS/Result.pm
@@ -163,8 +163,8 @@ Arrival/Departure date in "dd.mm.yyyy" format.
 
 =item $result->delay
 
-Returns the train's delay in minutes, or undef if it is unknown.
-Also returns undef if the train has been cancelled.
+Returns the delay in minutes, or undef if it is unknown.
+Also returns undef if the arrival/departure has been cancelled.
 
 =item $result->info
 
@@ -173,7 +173,7 @@ Returns an empty string if no (useful) information is available.
 
 =item $result->is_cancelled
 
-True if the train was cancelled, false otherwise.
+True if the arrival/departure was cancelled, false otherwise.
 
 =item $result->is_changed_platform
 
@@ -182,7 +182,7 @@ scheduled one. Note that the scheduled platform is unknown in this case.
 
 =item $result->messages
 
-Returns a list of message strings related to this train. Messages usually are
+Returns a list of message strings related to this result. Messages usually are
 service notices (e.g. "missing carriage") or detailed delay reasons
 (e.g. "switch damage between X and Y, expect delays").
 
@@ -190,25 +190,24 @@ service notices (e.g. "missing carriage") or detailed delay reasons
 
 =item $result->train
 
-Returns the line name, either in a format like "S 1" (S-Bahn line 1)
+Returns the line name, either in a format like "Bus SB16" (Bus line SB16)
 or "RE 10111" (RegionalExpress train 10111, no line information).
+May contain extraneous whitespace characters.
 
 =item $result->platform
 
-Returns the platform from which the train will depart / at which it will
-arrive. Realtime data if available, schedule data otherwise.
+Returns the arrival/departure platform.
+Realtime data if available, schedule data otherwise.
 
 =item $result->route_end
 
-Returns the last element of the route.  Depending on how you set up
-Travel::Status::DE::HAFAS (arrival or departure listing), this is
-either the train's destination or its origin station.
-
 =item $result->destination
 
 =item $result->origin
 
-Convenience aliases for C<< $result->route_end >>.
+Returns the last element of the route.  Depending on how you set up
+Travel::Status::DE::HAFAS (arrival or departure listing), this is
+either the result's destination or its origin station.
 
 =item $result->time
 
@@ -216,35 +215,8 @@ Returns the arrival/departure time as string in "hh:mm" format.
 
 =item $result->type
 
-Returns the type of this train, e.g. "S" for S-Bahn, "RE" for Regional Express
-or "ICE" for InterCity-Express.
-
-=back
-
-=head2 INTERNAL
-
-=over
-
-=item $result = Travel::Status::DE::HAFAS::Result->new(I<%data>)
-
-Returns a new Travel::Status::DE::HAFAS::Result object.
-You usually do not need to call this.
-
-Required I<data>:
-
-=over
-
-=item B<time> => I<hh:mm>
-
-=item B<train> => I<string>
-
-=item B<route_end> => I<string>
-
-=item B<platform> => I<string>
-
-=item B<info_raw> => I<string>
-
-=back
+Returns the type of this result, e.g. "S" for S-Bahn, "RE" for Regional Express
+or "STR" for tram / StraE<szlig>enbahn.
 
 =back
 
diff --git a/lib/Travel/Status/DE/HAFAS/StopFinder.pm b/lib/Travel/Status/DE/HAFAS/StopFinder.pm
index 6984098..c81c33a 100644
--- a/lib/Travel/Status/DE/HAFAS/StopFinder.pm
+++ b/lib/Travel/Status/DE/HAFAS/StopFinder.pm
@@ -166,8 +166,8 @@ no error occurred, returns undef.
 =item $status->results
 
 Returns a list of stop candidates. Each list element is a hash reference. The
-hash keys are B<id> (IBNR) and B<name> (stop name). Both can be used as input
-for the Travel::Status::DE::HAFAS(3pm) constructor.
+hash keys are B<id> (IBNR / UIC station code) and B<name> (stop name). Both can
+be used as input for the Travel::Status::DE::HAFAS(3pm) constructor.
 
 If no matching results were found or the parser / http request failed, returns
 the empty list.
-- 
cgit v1.2.3