[Catalyst-commits] r6672 - / trunk/Catalyst-Runtime/lib/Catalyst

[zarquon at dev.catalyst.perl.org]

Author: zarquon
Date: 2007-08-17 14:54:09 +0100 (Fri, 17 Aug 2007)
New Revision: 6672

Modified:
   /
   trunk/Catalyst-Runtime/lib/Catalyst/Controller.pm
Log:
 r11423 at zaphod:  kd | 2007-08-17 22:30:10 +1000
 misc doc fixes thanks to semifor



Property changes on: 
___________________________________________________________________
Name: svk:merge
   - 1b129c88-ebf4-0310-add9-f09427935aba:/local/catalyst:4278
1c72fc7c-9ce4-42af-bf25-3bfe470ff1e8:/local/Catalyst:10671
3b9770f9-e80c-0410-a7de-cd203d167417:/local/catalyst:3514
dd8ad9ea-0304-0410-a433-df5f223e7bc0:/local/Catalyst:6909
   + 1b129c88-ebf4-0310-add9-f09427935aba:/local/catalyst:4278
1c72fc7c-9ce4-42af-bf25-3bfe470ff1e8:/local/Catalyst:11423
3b9770f9-e80c-0410-a7de-cd203d167417:/local/catalyst:3514
dd8ad9ea-0304-0410-a433-df5f223e7bc0:/local/Catalyst:6909

Modified: trunk/Catalyst-Runtime/lib/Catalyst/Controller.pm
===================================================================
--- trunk/Catalyst-Runtime/lib/Catalyst/Controller.pm	2007-08-17 13:08:36 UTC (rev 6671)
+++ trunk/Catalyst-Runtime/lib/Catalyst/Controller.pm	2007-08-17 13:54:09 UTC (rev 6672)
@@ -15,7 +15,7 @@
 =head1 SYNOPSIS
 
   package MyApp::Controller::Search
-  use base qw/Catalyst::Controller;
+  use base qw/Catalyst::Controller/;
 
   sub foo : Local { 
     my ($self,$c, at args) = @_;
@@ -24,10 +24,10 @@
 
 =head1 DESCRIPTION
 
-Controllers are where the actions in the Catalyst framework reside. each
-action is represented by a function with an attribute to identify what kind
-of action it is. See the L<Catalyst::Dispatcher> for more info about how 
-Catalyst dispatches to actions.
+Controllers are where the actions in the Catalyst framework
+reside. Each action is represented by a function with an attribute to
+identify what kind of action it is. See the L<Catalyst::Dispatcher>
+for more info about how Catalyst dispatches to actions.
 
 =cut
 
@@ -298,16 +298,17 @@
 
 =head1 CONFIGURATION
 
-As any other L<Catalyst::Component>, controllers have a config 
-hash, accessable through $self->config from the controller actions.
-Some settings are in use by the Catalyst framework:
+Like any other L<Catalyst::Component>, controllers have a config hash,
+accessible through $self->config from the controller actions.  Some
+settings are in use by the Catalyst framework:
 
 =head2 namespace
 
-This spesifies the internal namespace the controller should be bound to. By default
-the controller is bound to the uri version of the controller name. For instance
-controller 'MyApp::Controller::Foo::Bar' will be bound to 'foo/bar'. The default Root 
-controller is an example of setting namespace to ''. 
+This specifies the internal namespace the controller should be bound
+to. By default the controller is bound to the URI version of the
+controller name. For instance controller 'MyApp::Controller::Foo::Bar'
+will be bound to 'foo/bar'. The default Root controller is an example
+of setting namespace to '' (the null string).
 
 =head2 prefix 
 
@@ -322,36 +323,37 @@
 
 =head2 $self->action_for('name')
 
-Returns the Catalyst::Action object (if any) for a given method name in
-this component.
+Returns the Catalyst::Action object (if any) for a given method name
+in this component.
 
 =head2 $self->register_actions($c)
 
-Finds all applicable actions for this component, creates Catalyst::Action
-objects (using $self->create_action) for them and registers them with
-$c->dispatcher.
+Finds all applicable actions for this component, creates
+Catalyst::Action objects (using $self->create_action) for them and
+registers them with $c->dispatcher.
 
 =head2 $self->action_namespace($c)
 
-Returns the private namespace for actions in this component. Defaults to a value
-from the controller name (for e.g. MyApp::Controller::Foo::Bar becomes
-"foo/bar") or can be overriden from the "namespace" config key.
+Returns the private namespace for actions in this component. Defaults
+to a value from the controller name (for
+e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be
+overridden from the "namespace" config key.
 
 
 =head2 $self->path_prefix($c)
 
-Returns the default path prefix for :Local, :LocalRegex and relative :Path
-actions in this component. Defaults to the action_namespace or can be
-overriden from the "path" config key.
+Returns the default path prefix for :Local, :LocalRegex and relative
+:Path actions in this component. Defaults to the action_namespace or
+can be overridden from the "path" config key.
 
 =head2 $self->create_action(%args)
 
-Called with a hash of data to be use for construction of a new Catalyst::Action
-(or appropriate sub/alternative class) object.
+Called with a hash of data to be use for construction of a new
+Catalyst::Action (or appropriate sub/alternative class) object.
 
 Primarily designed for the use of register_actions.
 
-=head2 $self->_application  
+=head2 $self->_application
 
 =head2 $self->_app
 
@@ -364,7 +366,7 @@
 
 =head1 COPYRIGHT
 
-This program is free software, you can redistribute it and/or modify it under
-the same terms as Perl itself.
+This program is free software, you can redistribute it and/or modify
+it under the same terms as Perl itself.
 
 =cut