POD updates: fleshed out some weak areas, reorganised a little and fixed some typogra...

[maypole.git] / lib / Maypole / View / Base.pm

diff --git a/lib/Maypole/View/Base.pm b/lib/Maypole/View/Base.pm
index c56ee51b1bb320ed2dd16c857506a3b1ff367256..f687309d5057f4e66e8b3e2608c17be904bc3417 100644 (file)
--- a/lib/Maypole/View/Base.pm
+++ b/lib/Maypole/View/Base.pm
@@ -3,6 +3,7 @@ use File::Spec;
 use UNIVERSAL::moniker;
 use strict;
 use Maypole::Constants;
+use Carp;
 
 sub new { bless {}, shift }    # By default, do nothing.
 
@@ -74,7 +75,7 @@ sub process {
 sub error {
     my ( $self, $r, $desc ) = @_;
     $desc = $desc ? "$desc: " : "";
-    warn $desc . $r->{error} ."\n";
+    carp $desc . $r->{error};
     if ( $r->{error} =~ /not found$/ ) {
 
         # This is a rough test to see whether or not we're a template or
@@ -116,27 +117,28 @@ sub template { die shift() . " didn't define a decent template method!" }
 
 =head1 NAME
 
-Maypole::View::Base - Base cl
+Maypole::View::Base - Base class for view classes
 
 =head1 DESCRIPTION
 
 This is the base class for Maypole view classes. This is an abstract class
-meant to define the interface, and can't be used directly.
+that defines the interface, and can't be used directly.
 
 =head2 process
 
-This is the engine of this module. It populates all the relevant variables
-and calls the requested action.
+This is the entry point for the view. It templates the request and returns a
+C<Maypole::Constant> indicate success or failure for the view phase.
 
-Anyone subclassing this for a different database abstraction mechanism
-needs to provide the following methods:
+Anyone subclassing this for a different rendering mechanism needs to provide
+the following methods:
 
-=head2 template 
+=head2 template
 
-In this method you do the actual processing of your template. it should use L<paths> 
-to search for components, and provide the templates with easy access to the contents
-of L<vars>. It should put the result in $r->{output} and return OK if processing was
-sucessfull, or populate $r->{error} and return ERROR if it fails.
+In this method you do the actual processing of your template. it should use
+L<paths> to search for components, and provide the templates with easy access
+to the contents of L<vars>. It should put the result in C<$r-E<gt>output> and
+return C<OK> if processing was sucessfull, or populate C<$r-E<gt>error> and
+return C<ERROR> if it fails.
 
 =head1 Other overrides
 
@@ -149,14 +151,14 @@ during view initialization.
 
 =head2 paths
 
-Returns search paths for templates. the default method returns factory, custom and
-<tablename> under the configured template root.
+Returns search paths for templates. the default method returns factory, custom
+and E<lt>tablenameE<gt> under the configured template root.
 
 =head2 vars
 
-returns a hash of data the template should have access to. The default one populates
-classmetadata if there is a class, as well as setting the data objects by name if 
-there is one or more objects available.
+returns a hash of data the template should have access to. The default one
+populates classmetadata if there is a table class, as well as setting the data
+objects by name if there is one or more objects available.
 
 =head2 error