summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2023-11-12 17:37:12 +0100
committerBirte Kristina Friesel <derf@finalrewind.org>2023-11-12 17:37:12 +0100
commit239da00af8b6aea0857182bc61b806069fb805d9 (patch)
tree28fa4c0f8af7436aa966b170d8825cc4d3209f08 /lib
parentde213f09e19af303c97bede3362654a8854aa1ed (diff)
Utils: Add documentation
Diffstat (limited to 'lib')
-rw-r--r--lib/Travel/Routing/DE/HAFAS/Utils.pm44
1 files changed, 44 insertions, 0 deletions
diff --git a/lib/Travel/Routing/DE/HAFAS/Utils.pm b/lib/Travel/Routing/DE/HAFAS/Utils.pm
index 4b5bdb7..d86768a 100644
--- a/lib/Travel/Routing/DE/HAFAS/Utils.pm
+++ b/lib/Travel/Routing/DE/HAFAS/Utils.pm
@@ -30,3 +30,47 @@ sub handle_day_change {
}
1;
+
+__END__
+
+=head1 NAME
+
+Travel::Routing::DE::HAFAS::Utils - Internal Travel::Routing::DE::HAFAS utilities
+
+=head1 SYNOPSIS
+
+None.
+
+=head1 VERSION
+
+version 0.01
+
+=head1 METHODS
+
+This methods are not meant to be called externally.
+
+=over
+
+=item handle_day_change(I<%opt>)
+
+Use B<strp_obj> to parse HAFAS-provided B<date> and B<time> and handle a day
+change (encoded by prefixing B<time> with two additional digits) if necessary.
+Returns a DateTime(3pm) object.
+
+=back
+
+=head1 DIAGNOSTICS
+
+None.
+
+=head1 DEPENDENCIES
+
+None.
+
+=head1 AUTHOR
+
+Copyright (C) 2023 by Birte Kristina Friesel E<lt>derf@finalrewind.orgE<gt>
+
+=head1 LICENSE
+
+This program is licensed under the same terms as Perl itself.