authors cleanup

[catagits/Catalyst-Runtime.git] / lib / Catalyst / View.pm

diff --git a/lib/Catalyst/View.pm b/lib/Catalyst/View.pm
index 77597a6..6c41dd6 100644 (file)
--- a/lib/Catalyst/View.pm
+++ b/lib/Catalyst/View.pm
@@ -9,15 +9,52 @@ Catalyst::View - Catalyst View base class
 
 =head1 SYNOPSIS
 
-See L<Catalyst>.
+    package Catalyst::View::Homebrew;
+
+    use base qw/Catalyst::View/;
+
+    sub process {
+    # template processing goes here.
+    }
 
 =head1 DESCRIPTION
 
-Catalyst View base class.
+This is the Catalyst View base class. It's meant to be used as 
+a base class by Catalyst views.
+
+As a convention, views are expected to read template names from 
+$c->stash->{template}, and put the output into $c->res->body.
+Some views default to render a template named after the dispatched
+action's private name. (See L<Catalyst::Action>.)
+
+=head1 METHODS 
+
+Implements the same methods as other Catalyst components, see
+L<Catalyst::Component>
+
+=head2 process
+
+gives an error message about direct use.
+
+=cut
+
+sub process {
+
+    Catalyst::Exception->throw( message => ( ref $_[0] || $_[0] ).
+            " directly inherits from Catalyst::View. You need to\n".
+            " inherit from a subclass like Catalyst::View::TT instead.\n" );
+
+}
+
+=head2 $c->merge_hash_config( $hashref, $hashref )
+
+Merges two hashes together recursively, giving right-hand precedence.
+
+=cut
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Sebastian Riedel, C<sri@oook.de>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT