From 181be92311ff699faa2379050d7713f76983f5ee Mon Sep 17 00:00:00 2001 From: Jesse Luehrs Date: Sat, 18 Aug 2012 17:54:49 -0500 Subject: docs --- lib/Try.pm | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) diff --git a/lib/Try.pm b/lib/Try.pm index 983f196..bb7d563 100644 --- a/lib/Try.pm +++ b/lib/Try.pm @@ -16,6 +16,46 @@ our @EXPORT = our @EXPORT_OK = ('try'); use Try::Tiny (); +=head1 SYNOPSIS + + try { + die "foo"; + } + catch { + when (/foo/) { + warn "Caught foo"; + } + } + +=head1 DESCRIPTION + +This module implements a try/catch/finally statement. It is based heavily on +(and mostly implemented via) L. The differences are: + +=over 4 + +=item * + +It is a statement. C<< my $foo = try { ... } >> doesn't work anymore, but in +return, you don't have to remember the trailing semicolon anymore. C +still works fine if you need an expression (in 5.14+ at least). + +=item * + +The blocks are ordered, and only one catch and finally block are supported. +C<< try { } finally { } catch { } >> and +C<< try { } catch { } finally { } finally { } >> do not work with this module, +mostly because that's just extra complexity for no real purpose. + +=item * + +C and C are no longer exported - they are just part of the +syntax of the C statement. This is almost certainly not an issue. + +=back + +=cut + sub try { my ($try, $catch, $finally) = @_; &Try::Tiny::try( @@ -25,4 +65,46 @@ sub try { ); } +=head1 BUGS + +No known bugs. + +Please report any bugs through RT: email +C, or browse to +L. + +=head1 SEE ALSO + +L, L + +=head1 SUPPORT + +You can find this documentation for this module with the perldoc command. + + perldoc Try + +You can also look for information at: + +=over 4 + +=item * AnnoCPAN: Annotated CPAN documentation + +L + +=item * CPAN Ratings + +L + +=item * RT: CPAN's request tracker + +L + +=item * Search CPAN + +L + +=back + +=cut + 1; -- cgit v1.2.3-54-g00ecf