X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FException%2FBasic.pm;h=f32a6e639e4da7d7ff6734218a90a4f1dd24292e;hb=b6c6af73c35c442dea0ed179bfc6c73c49f6fc3e;hp=6530a6ff41c1201c37a51cde450107937073fd8d;hpb=bb3504780353c63757b5d30ea81e649f32833e7e;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Exception/Basic.pm b/lib/Catalyst/Exception/Basic.pm
index 6530a6f..f32a6e6 100644
--- a/lib/Catalyst/Exception/Basic.pm
+++ b/lib/Catalyst/Exception/Basic.pm
@@ -43,3 +43,65 @@ sub rethrow {
 }
 
 1;
+
+=head1 NAME
+
+Catalyst::Exception::Basic - Basic Catalyst Exception Role
+
+=head1 SYNOPSIS
+
+   package My::Exception;
+   use Moose;
+   use namespace::clean -except => 'meta';
+   
+   with 'Catalyst::Exception::Basic';
+   
+   # Elsewhere..
+   My::Exception::Basic->throw( qq/Fatal exception/ );
+
+See also L<Catalyst> and L<Catalyst::Exception>.
+
+=head1 DESCRIPTION
+
+This is the basic Catalyst Exception role which implements all of
+L<Catalyst::Exception::Interface>.
+
+=head1 ATTRIBUTES
+
+=head2 message
+
+Holds the exception message.
+
+=head1 METHODS
+
+=head2 as_string
+
+Stringifies the exception's message attribute. 
+Called when the object is stringified by overloading.
+
+=head2 throw( $message )
+
+=head2 throw( message => $message )
+
+=head2 throw( error => $error )
+
+Throws a fatal exception.
+
+=head2 rethrow( $exception )
+
+Rethrows a caught exception.
+
+=head2 meta
+
+Provided by Moose
+
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
+
+=head1 COPYRIGHT
+
+This library is free software. You can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut