From: Sebastian Riedel Date: Sat, 19 Nov 2005 00:04:35 +0000 (+0000) Subject: Reformatted documentation X-Git-Tag: 5.7099_04~877 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=b5ecfcf07b8ffe7e9984f0279c8781ce51c6ac6a Reformatted documentation --- diff --git a/Changes b/Changes index 822c863..cca9cb6 100644 --- a/Changes +++ b/Changes @@ -1,6 +1,7 @@ This file documents the revision history for Perl extension Catalyst. 5.57 + - Reformatted documentation - Renamed -nonew to -force - Added PAR support - Added keep-alive support and bug fixes to HTTP engine. diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 8bc6c70..aca4920 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -197,43 +197,37 @@ they are loaded in exactly the order in which they appear. The following flags are supported: -=over 4 - -=item -Debug +=head2 -Debug Enables debug output. -=item -Engine +=head2 -Engine Forces Catalyst to use a specific engine. Omit the C prefix of the engine name, i.e.: use Catalyst qw/-Engine=CGI/; -=item -Home +=head2 -Home Forces Catalyst to use a specific home directory, e.g.: use Catalyst qw[-Home=/usr/sri]; -=item -Log +=head2 -Log Specifies log level. -=back - =head1 METHODS =head2 Information about the current request -=over 4 - -=item $c->action +=head2 $c->action Returns a L object for the current action, which stringifies to the action name. See L. -=item $c->namespace +=head2 $c->namespace Returns the namespace of the current action, i.e., the uri prefix corresponding to the controller of the current action. For example: @@ -241,22 +235,18 @@ corresponding to the controller of the current action. For example: # in Controller::Foo::Bar $c->namespace; # returns 'foo/bar'; -=item $c->request +=head2 $c->request -=item $c->req +=head2 $c->req Returns the current L object. See L. -=back - =head2 Processing and response to the current request -=over 4 +=head2 $c->forward( $action [, \@arguments ] ) -=item $c->forward( $action [, \@arguments ] ) - -=item $c->forward( $class, $method, [, \@arguments ] ) +=head2 $c->forward( $class, $method, [, \@arguments ] ) Forwards processing to a private action. If you give a class name but no method, C is called. You may also optionally pass arguments @@ -273,9 +263,9 @@ C<$c-Ereq-Eargs> will be restored to the previous values. sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } -=item $c->detach( $action [, \@arguments ] ) +=head2 $c->detach( $action [, \@arguments ] ) -=item $c->detach( $class, $method, [, \@arguments ] ) +=head2 $c->detach( $class, $method, [, \@arguments ] ) The same as C, but doesn't return. @@ -283,11 +273,11 @@ The same as C, but doesn't return. sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } -=item $c->error +=head2 $c->error -=item $c->error($error, ...) +=head2 $c->error($error, ...) -=item $c->error($arrayref) +=head2 $c->error($arrayref) Returns an arrayref containing error messages. If Catalyst encounters an error while processing a request, it stores the error in $c->error. This @@ -316,13 +306,13 @@ sub error { return $c->{error} || []; } -=item $c->response +=head2 $c->response -=item $c->res +=head2 $c->res Returns the current L object. -=item $c->stash +=head2 $c->stash Returns a hashref to the stash, which may be used to store data and pass it between components during a request. You can also set hash keys by @@ -350,19 +340,15 @@ sub stash { return $c->{stash}; } -=item $c->state +=head2 $c->state Contains the return value of the last executed action. -=back - =head2 Component Accessors -=over 4 +=head2 $c->comp($name) -=item $c->comp($name) - -=item $c->component($name) +=head2 $c->component($name) Gets a component object by name. This method is no longer recommended, unless you want to get a specific component by full @@ -404,7 +390,7 @@ sub component { return sort keys %{ $c->components }; } -=item $c->controller($name) +=head2 $c->controller($name) Gets a L instance by name. @@ -419,7 +405,7 @@ sub controller { return $c->comp("C::$name"); } -=item $c->model($name) +=head2 $c->model($name) Gets a L instance by name. @@ -434,7 +420,7 @@ sub model { return $c->comp("M::$name"); } -=item $c->view($name) +=head2 $c->view($name) Gets a L instance by name. @@ -449,19 +435,15 @@ sub view { return $c->comp("V::$name"); } -=back - =head2 Class data and helper classes -=over 4 - -=item $c->config +=head2 $c->config Returns or takes a hashref containing the application's configuration. __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' }); -=item $c->debug +=head2 $c->debug Overload to enable debug messages (same as -Debug option). @@ -469,17 +451,17 @@ Overload to enable debug messages (same as -Debug option). sub debug { 0 } -=item $c->dispatcher +=head2 $c->dispatcher Returns the dispatcher instance. Stringifies to class name. See L. -=item $c->engine +=head2 $c->engine Returns the engine instance. Stringifies to the class name. See L. -=item $c->log +=head2 $c->log Returns the logging object instance. Unless it is already set, Catalyst sets this up with a L object. To use your own log class: @@ -492,13 +474,9 @@ L man page. =cut -=back - =head2 Utility methods -=over 4 - -=item $c->path_to(@path) +=head2 $c->path_to(@path) Merges C<@path> with C<$c-Econfig-E{home}> and returns a L object. @@ -516,7 +494,7 @@ sub path_to { else { return file( $c->config->{home}, @path ) } } -=item $c->plugin( $name, $class, @args ) +=head2 $c->plugin( $name, $class, @args ) Helper method for plugins. It creates a classdata accessor/mutator and loads and instantiates the given class. @@ -551,7 +529,7 @@ sub plugin { if $class->debug; } -=item MyApp->setup +=head2 MyApp->setup Initializes the dispatcher and engine, loads any plugins, and loads the model, view, and controller components. You may also specify an array @@ -683,7 +661,7 @@ EOF $class->log->_flush() if $class->log->can('_flush'); } -=item $c->uri_for( $path, [ @args ] ) +=head2 $c->uri_for( $path, [ @args ] ) Merges path with C<$c-Erequest-Ebase> for absolute uri's and with C<$c-Enamespace> for relative uri's, then returns a @@ -713,7 +691,7 @@ sub uri_for { $base )->canonical; } -=item $c->welcome_message +=head2 $c->welcome_message Returns the Catalyst welcome HTML page. @@ -858,32 +836,28 @@ perldoc setup_dispatcher +=head2 $c->setup_dispatcher Sets up dispatcher. @@ -1556,7 +1530,7 @@ sub setup_dispatcher { $class->dispatcher( $dispatcher->new ); } -=item $c->setup_engine +=head2 $c->setup_engine Sets up engine. @@ -1680,7 +1654,7 @@ qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/ $class->engine( $engine->new ); } -=item $c->setup_home +=head2 $c->setup_home Sets up the home directory. @@ -1707,7 +1681,7 @@ sub setup_home { } } -=item $c->setup_log +=head2 $c->setup_log Sets up log. @@ -1734,7 +1708,7 @@ sub setup_log { } } -=item $c->setup_plugins +=head2 $c->setup_plugins Sets up plugins. @@ -1762,11 +1736,11 @@ sub setup_plugins { } } -=item $c->stack +=head2 $c->stack Returns the stack. -=item $c->write( $data ) +=head2 $c->write( $data ) Writes $data to the output stream. When using this method directly, you will need to manually set the C header to the length of @@ -1783,7 +1757,7 @@ sub write { return $c->engine->write( $c, @_ ); } -=item version +=head2 version Returns the Catalyst version number. Mostly useful for "powered by" messages in template systems. @@ -1792,8 +1766,6 @@ messages in template systems. sub version { return $Catalyst::VERSION } -=back - =head1 INTERNAL ACTIONS Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>, @@ -1883,23 +1855,19 @@ Wiki: =head1 SEE ALSO -=over 4 - -=item L - The Catalyst Manual - -=item L, L - Base classes for components +=head2 L - The Catalyst Manual -=item L - Core engine +=head2 L, L - Base classes for components -=item L - Log class. +=head2 L - Core engine -=item L - Request object +=head2 L - Log class. -=item L - Response object +=head2 L - Request object -=item L - The test suite. +=head2 L - Response object -=back +=head2 L - The test suite. =head1 CREDITS diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm index b2a0947..130006a 100644 --- a/lib/Catalyst/Action.pm +++ b/lib/Catalyst/Action.pm @@ -27,15 +27,13 @@ See L. =head1 METHODS -=over 4 +=head2 attributes -=item attributes +=head2 class -=item class +=head2 code -=item code - -=item execute +=head2 execute =cut @@ -45,13 +43,11 @@ sub execute { # Execute ourselves against a context return $c->execute( $self->class, $self ); } -=item namespace - -=item reverse +=head2 namespace -=item name +=head2 reverse -=back +=head2 name =head1 AUTHOR diff --git a/lib/Catalyst/ActionContainer.pm b/lib/Catalyst/ActionContainer.pm index 6e01e23..4dd4500 100644 --- a/lib/Catalyst/ActionContainer.pm +++ b/lib/Catalyst/ActionContainer.pm @@ -24,9 +24,7 @@ See L. =head1 METHODS -=over 4 - -=item get_action +=head2 get_action =cut @@ -36,11 +34,9 @@ sub get_action { return; } -=item actions - -=item part +=head2 actions -=back +=head2 part =head1 AUTHOR diff --git a/lib/Catalyst/AttrContainer.pm b/lib/Catalyst/AttrContainer.pm index 35741e4..fecfdcd 100644 --- a/lib/Catalyst/AttrContainer.pm +++ b/lib/Catalyst/AttrContainer.pm @@ -31,13 +31,9 @@ Catalyst::AttrContainer =head1 METHODS -=over 4 +=head2 FETCH_CODE_ATTRIBUTES -=item FETCH_CODE_ATTRIBUTES - -=item MODIFY_CODE_ATTRIBUTES - -=back +=head2 MODIFY_CODE_ATTRIBUTES =head1 SEE ALSO diff --git a/lib/Catalyst/Base.pm b/lib/Catalyst/Base.pm index 9aa4dbf..b1f105b 100644 --- a/lib/Catalyst/Base.pm +++ b/lib/Catalyst/Base.pm @@ -74,9 +74,7 @@ Catalyst Base Class =head1 METHODS -=over 4 - -=item $self->action_namespace($c) +=head2 $self->action_namespace($c) =cut @@ -87,7 +85,7 @@ sub action_namespace { || ''; } -=item $self->register_actions($c) +=head2 $self->register_actions($c) =cut @@ -155,8 +153,6 @@ sub _parse_attrs { return \%attributes; } -=back - =head1 SEE ALSO L, L. diff --git a/lib/Catalyst/Build.pm b/lib/Catalyst/Build.pm index 47be034..7ecdba7 100644 --- a/lib/Catalyst/Build.pm +++ b/lib/Catalyst/Build.pm @@ -27,9 +27,7 @@ L extension for Catalyst. =head1 METHODS -=over 4 - -=item ACTION_install +=head2 ACTION_install =cut @@ -39,7 +37,7 @@ sub ACTION_install { $self->ACTION_install_extras; } -=item ACTION_fakeinstall +=head2 ACTION_fakeinstall =cut @@ -50,7 +48,7 @@ sub ACTION_fakeinstall { $self->ACTION_install_extras; } -=item ACTION_install_extras +=head2 ACTION_install_extras =cut @@ -89,8 +87,6 @@ sub _find_extras { return @files; } -=back - =head1 AUTHOR Sebastian Riedel, C diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index 339cab8..38e87aa 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -49,9 +49,7 @@ component loader with config() support and a process() method placeholder. =head1 METHODS -=over 4 - -=item new($c) +=head2 new($c) =cut @@ -64,14 +62,14 @@ sub new { return $self->NEXT::new( { %{ $self->config }, %{$arguments} } ); } -# remember to leave blank lines between the consecutive =item's -# otherwise the pod tools don't recognize the subsequent =items +# remember to leave blank lines between the consecutive =head2's +# otherwise the pod tools don't recognize the subsequent =head2s -=item $c->config +=head2 $c->config -=item $c->config($hashref) +=head2 $c->config($hashref) -=item $c->config($key, $value, ...) +=head2 $c->config($key, $value, ...) =cut @@ -87,7 +85,7 @@ sub config { return $self->_config; } -=item $c->process() +=head2 $c->process() =cut @@ -97,8 +95,6 @@ sub process { . " did not override Catalyst::Component::process" ); } -=back - =head1 SEE ALSO L, L, L, L. diff --git a/lib/Catalyst/DispatchType.pm b/lib/Catalyst/DispatchType.pm index dc12b57..98ac0eb 100644 --- a/lib/Catalyst/DispatchType.pm +++ b/lib/Catalyst/DispatchType.pm @@ -15,28 +15,24 @@ See L. =head1 METHODS -=over 4 - -=item $self->list($c) +=head2 $self->list($c) =cut sub list { } -=item $self->match( $c, $path ) +=head2 $self->match( $c, $path ) =cut sub match { die "Abstract method!" } -=item $self->register( $c, $action ) +=head2 $self->register( $c, $action ) =cut sub register { } -=back - =head1 AUTHOR Matt S Trout diff --git a/lib/Catalyst/DispatchType/Default.pm b/lib/Catalyst/DispatchType/Default.pm index 62308c3..f1864b2 100644 --- a/lib/Catalyst/DispatchType/Default.pm +++ b/lib/Catalyst/DispatchType/Default.pm @@ -15,9 +15,7 @@ See L. =head1 METHODS -=over 4 - -=item $self->match( $c, $path ) +=head2 $self->match( $c, $path ) =cut @@ -40,8 +38,6 @@ sub match { return 0; } -=back - =head1 AUTHOR Matt S Trout diff --git a/lib/Catalyst/DispatchType/Index.pm b/lib/Catalyst/DispatchType/Index.pm index 59026cf..dd8b010 100644 --- a/lib/Catalyst/DispatchType/Index.pm +++ b/lib/Catalyst/DispatchType/Index.pm @@ -15,9 +15,7 @@ See L. =head1 METHODS -=over 4 - -=item $self->match( $c, $path ) +=head2 $self->match( $c, $path ) =cut @@ -27,7 +25,7 @@ sub match { my $result = $c->get_action( 'index', $path ); if ($result) { - $c->action( $result ); + $c->action($result); $c->namespace( $result->namespace ); $c->req->action('index'); $c->req->match( $c->req->path ); @@ -36,8 +34,6 @@ sub match { return 0; } -=back - =head1 AUTHOR Sebastian Riedel, C diff --git a/lib/Catalyst/DispatchType/Path.pm b/lib/Catalyst/DispatchType/Path.pm index 2cb950d..1672712 100644 --- a/lib/Catalyst/DispatchType/Path.pm +++ b/lib/Catalyst/DispatchType/Path.pm @@ -16,9 +16,7 @@ See L. =head1 METHODS -=over 4 - -=item $self->list($c) +=head2 $self->list($c) =cut @@ -33,7 +31,7 @@ sub list { if ( keys %{ $self->{paths} } ); } -=item $self->match( $c, $path ) +=head2 $self->match( $c, $path ) =cut @@ -51,7 +49,7 @@ sub match { return 0; } -=item $self->register( $c, $action ) +=head2 $self->register( $c, $action ) =cut @@ -87,7 +85,7 @@ sub register { return 0; } -=item $self->register_path($c, $path, $action) +=head2 $self->register_path($c, $path, $action) =cut @@ -97,8 +95,6 @@ sub register_path { $self->{paths}{$path} = $action; } -=back - =head1 AUTHOR Matt S Trout diff --git a/lib/Catalyst/DispatchType/Regex.pm b/lib/Catalyst/DispatchType/Regex.pm index 38b2513..b8c0d15 100644 --- a/lib/Catalyst/DispatchType/Regex.pm +++ b/lib/Catalyst/DispatchType/Regex.pm @@ -16,9 +16,7 @@ See L. =head1 METHODS -=over 4 - -=item $self->list($c) +=head2 $self->list($c) =cut @@ -33,7 +31,7 @@ sub list { if ( @{ $self->{compiled} } ); } -=item $self->match( $c, $path ) +=head2 $self->match( $c, $path ) =cut @@ -58,7 +56,7 @@ sub match { return 0; } -=item $self->register( $c, $action ) +=head2 $self->register( $c, $action ) =cut @@ -81,7 +79,7 @@ sub register { return 0; } -=item $self->register_regex($c, $re, $action) +=head2 $self->register_regex($c, $re, $action) =cut @@ -97,8 +95,6 @@ sub register_regex { ); } -=back - =head1 AUTHOR Matt S Trout diff --git a/lib/Catalyst/Dispatcher.pm b/lib/Catalyst/Dispatcher.pm index 2d06a5d..ac641a9 100644 --- a/lib/Catalyst/Dispatcher.pm +++ b/lib/Catalyst/Dispatcher.pm @@ -38,9 +38,7 @@ See L. =head1 METHODS -=over 4 - -=item $self->detach( $c, $command [, \@arguments ] ) +=head2 $self->detach( $c, $command [, \@arguments ] ) =cut @@ -50,7 +48,7 @@ sub detach { die $Catalyst::DETACH; } -=item $self->dispatch($c) +=head2 $self->dispatch($c) =cut @@ -70,7 +68,7 @@ sub dispatch { } } -=item $self->forward( $c, $command [, \@arguments ] ) +=head2 $self->forward( $c, $command [, \@arguments ] ) =cut @@ -168,7 +166,7 @@ qq/Couldn't forward to command "$command". Invalid action or component./; return $c->state; } -=item $self->prepare_action($c) +=head2 $self->prepare_action($c) =cut @@ -203,7 +201,7 @@ sub prepare_action { if ( $c->debug && @args ); } -=item $self->get_action( $action, $namespace ) +=head2 $self->get_action( $action, $namespace ) =cut @@ -222,7 +220,7 @@ sub get_action { } } -=item $self->get_actions( $c, $action, $namespace ) +=head2 $self->get_actions( $c, $action, $namespace ) =cut @@ -237,7 +235,7 @@ sub get_actions { return map { $_->get_action($action) } @match; } -=item $self->get_containers( $namespace ) +=head2 $self->get_containers( $namespace ) =cut @@ -279,7 +277,7 @@ sub get_containers { return map { $_->getNodeValue } @match; } -=item $self->register( $c, $action ) +=head2 $self->register( $c, $action ) =cut @@ -339,7 +337,7 @@ sub register { $parent->getNodeValue->actions->{ $action->name } = $action; } -=item $self->setup_actions( $class, $component ) +=head2 $self->setup_actions( $class, $component ) =cut @@ -414,8 +412,6 @@ sub setup_actions { $_->list($c) for @{ $self->dispatch_types }; } -=back - =head1 AUTHOR Sebastian Riedel, C diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index 7f0a11b..9356562 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -30,13 +30,11 @@ See L. =head1 METHODS -=over 4 - -=item $self->finalize_output +=head2 $self->finalize_output , see finalize_body -=item $self->finalize_body($c) +=head2 $self->finalize_body($c) Finalize body. Prints the response output. @@ -56,7 +54,7 @@ sub finalize_body { } } -=item $self->finalize_cookies($c) +=head2 $self->finalize_cookies($c) =cut @@ -83,7 +81,7 @@ sub finalize_cookies { } } -=item $self->finalize_error($c) +=head2 $self->finalize_error($c) =cut @@ -98,9 +96,11 @@ sub finalize_error { # For pretty dumps local $Data::Dumper::Terse = 1; - $error = join '', - map { '

' . encode_entities($_) . '

' } - @{ $c->error }; + $error = join '', map { + '

' + . encode_entities($_) + . '

' + } @{ $c->error }; $error ||= 'No output'; $title = $name = "$name on Catalyst $Catalyst::VERSION"; $name = "

$name

"; @@ -248,13 +248,13 @@ EOF } -=item $self->finalize_headers($c) +=head2 $self->finalize_headers($c) =cut sub finalize_headers { } -=item $self->finalize_read($c) +=head2 $self->finalize_read($c) =cut @@ -264,7 +264,7 @@ sub finalize_read { undef $self->{_prepared_read}; } -=item $self->finalize_uploads($c) +=head2 $self->finalize_uploads($c) =cut @@ -281,7 +281,7 @@ sub finalize_uploads { } } -=item $self->prepare_body($c) +=head2 $self->prepare_body($c) =cut @@ -302,7 +302,7 @@ sub prepare_body { } } -=item $self->prepare_body_chunk($c) +=head2 $self->prepare_body_chunk($c) =cut @@ -312,7 +312,7 @@ sub prepare_body_chunk { $c->request->{_body}->add($chunk); } -=item $self->prepare_body_parameters($c) +=head2 $self->prepare_body_parameters($c) =cut @@ -321,13 +321,13 @@ sub prepare_body_parameters { $c->request->body_parameters( $c->request->{_body}->param ); } -=item $self->prepare_connection($c) +=head2 $self->prepare_connection($c) =cut sub prepare_connection { } -=item $self->prepare_cookies($c) +=head2 $self->prepare_cookies($c) =cut @@ -339,13 +339,13 @@ sub prepare_cookies { } } -=item $self->prepare_headers($c) +=head2 $self->prepare_headers($c) =cut sub prepare_headers { } -=item $self->prepare_parameters($c) +=head2 $self->prepare_parameters($c) =cut @@ -372,15 +372,15 @@ sub prepare_parameters { } } -=item $self->prepare_path($c) +=head2 $self->prepare_path($c) =cut sub prepare_path { } -=item $self->prepare_request($c) +=head2 $self->prepare_request($c) -=item $self->prepare_query_parameters($c) +=head2 $self->prepare_query_parameters($c) =cut @@ -398,7 +398,7 @@ sub prepare_query_parameters { } } -=item $self->prepare_read($c) +=head2 $self->prepare_read($c) =cut @@ -409,13 +409,13 @@ sub prepare_read { $self->read_position(0); } -=item $self->prepare_request(@arguments) +=head2 $self->prepare_request(@arguments) =cut sub prepare_request { } -=item $self->prepare_uploads($c) +=head2 $self->prepare_uploads($c) =cut @@ -444,13 +444,13 @@ sub prepare_uploads { } } -=item $self->prepare_write($c) +=head2 $self->prepare_write($c) =cut sub prepare_write { } -=item $self->read($c, [$maxlength]) +=head2 $self->read($c, [$maxlength]) =cut @@ -483,7 +483,7 @@ sub read { } } -=item $self->read_chunk($c, $buffer, $length) +=head2 $self->read_chunk($c, $buffer, $length) Each engine inplements read_chunk as its preferred way of reading a chunk of data. @@ -492,22 +492,22 @@ of data. sub read_chunk { } -=item $self->read_length +=head2 $self->read_length The length of input data to be read. This is obtained from the Content-Length header. -=item $self->read_position +=head2 $self->read_position The amount of input data that has already been read. -=item $self->run($c) +=head2 $self->run($c) =cut sub run { } -=item $self->write($c, $buffer) +=head2 $self->write($c, $buffer) =cut @@ -522,8 +522,6 @@ sub write { print STDOUT $buffer; } -=back - =head1 AUTHORS Sebastian Riedel, diff --git a/lib/Catalyst/Engine/CGI.pm b/lib/Catalyst/Engine/CGI.pm index 741816e..d2d041e 100644 --- a/lib/Catalyst/Engine/CGI.pm +++ b/lib/Catalyst/Engine/CGI.pm @@ -5,7 +5,7 @@ use base 'Catalyst::Engine'; use NEXT; use URI; -__PACKAGE__->mk_accessors( 'env' ); +__PACKAGE__->mk_accessors('env'); =head1 NAME @@ -34,9 +34,7 @@ This is the Catalyst engine specialized for the CGI environment. This class overloads some methods from C. -=over 4 - -=item $self->finalize_headers($c) +=head2 $self->finalize_headers($c) =cut @@ -49,13 +47,13 @@ sub finalize_headers { print "\015\012"; } -=item $self->prepare_connection($c) +=head2 $self->prepare_connection($c) =cut sub prepare_connection { my ( $self, $c ) = @_; - local(*ENV) = $self->env || \%ENV; + local (*ENV) = $self->env || \%ENV; $c->request->address( $ENV{REMOTE_ADDR} ); @@ -87,13 +85,13 @@ sub prepare_connection { } } -=item $self->prepare_headers($c) +=head2 $self->prepare_headers($c) =cut sub prepare_headers { my ( $self, $c ) = @_; - local(*ENV) = $self->env || \%ENV; + local (*ENV) = $self->env || \%ENV; # Read headers from %ENV while ( my ( $header, $value ) = each %ENV ) { @@ -103,13 +101,13 @@ sub prepare_headers { } } -=item $self->prepare_path($c) +=head2 $self->prepare_path($c) =cut sub prepare_path { my ( $self, $c ) = @_; - local(*ENV) = $self->env || \%ENV; + local (*ENV) = $self->env || \%ENV; my $scheme = $c->request->secure ? 'https' : 'http'; my $host = $ENV{HTTP_HOST} || $ENV{SERVER_NAME}; @@ -154,20 +152,20 @@ sub prepare_path { $c->request->base($base); } -=item $self->prepare_query_parameters($c) +=head2 $self->prepare_query_parameters($c) =cut sub prepare_query_parameters { my ( $self, $c ) = @_; - local(*ENV) = $self->env || \%ENV; - + local (*ENV) = $self->env || \%ENV; + if ( $ENV{QUERY_STRING} ) { $self->SUPER::prepare_query_parameters( $c, $ENV{QUERY_STRING} ); } } -=item $self->prepare_request($c, (env => \%env)) +=head2 $self->prepare_request($c, (env => \%env)) =cut @@ -175,11 +173,11 @@ sub prepare_request { my ( $self, $c, %args ) = @_; if ( $args{env} ) { - $self->env( $args{env} ); + $self->env( $args{env} ); } } -=item $self->prepare_write($c) +=head2 $self->prepare_write($c) Enable autoflush on the output handle for CGI-based engines. @@ -194,20 +192,18 @@ sub prepare_write { $self->NEXT::prepare_write($c); } -=item $self->read_chunk($c, $buffer, $length) +=head2 $self->read_chunk($c, $buffer, $length) =cut sub read_chunk { shift; shift; *STDIN->sysread(@_); } -=item $self->run +=head2 $self->run =cut sub run { shift; shift->handle_request(@_) } -=back - =head1 SEE ALSO L L. diff --git a/lib/Catalyst/Engine/FastCGI.pm b/lib/Catalyst/Engine/FastCGI.pm index 9ebe51b..f3f250a 100644 --- a/lib/Catalyst/Engine/FastCGI.pm +++ b/lib/Catalyst/Engine/FastCGI.pm @@ -17,9 +17,7 @@ This is the FastCGI engine. This class overloads some methods from C. -=over 4 - -=item $self->run($c, $listen, { option => value, ... }) +=head2 $self->run($c, $listen, { option => value, ... }) Starts the FastCGI server. If C<$listen> is set, then it specifies a location to listen for FastCGI requests; @@ -78,18 +76,19 @@ sub run { if ($listen) { $options->{manager} ||= "FCGI::ProcManager"; $options->{nproc} ||= 1; - + $self->daemon_fork() if $options->{detach}; - + if ( $options->{manager} ) { eval "use $options->{manager}; 1" or die $@; - $proc_manager - = $options->{manager}->new( { + $proc_manager = $options->{manager}->new( + { n_processes => $options->{nproc}, pid_fname => $options->{pidfile}, - } ); - + } + ); + # detach *before* the ProcManager inits $self->daemon_detach() if $options->{detach}; @@ -97,7 +96,7 @@ sub run { } elsif ( $options->{detach} ) { $self->daemon_detach(); - } + } } while ( $request->Accept >= 0 ) { @@ -107,7 +106,7 @@ sub run { } } -=item $self->write($c, $buffer) +=head2 $self->write($c, $buffer) =cut @@ -124,7 +123,7 @@ sub write { *STDOUT->syswrite($buffer); } -=item $self->daemon_fork() +=head2 $self->daemon_fork() Performs the first part of daemon initialisation. Specifically, forking. STDERR, etc are still connected to a terminal. @@ -136,7 +135,7 @@ sub daemon_fork { fork && exit; } -=item $self->daemon_detach( ) +=head2 $self->daemon_detach( ) Performs the second part of daemon initialisation. Specifically, disassociates from the terminal. @@ -151,17 +150,15 @@ F). sub daemon_detach { my $self = shift; print "FastCGI daemon started (pid $$)\n"; - open STDIN, "+&STDIN" or die $!; - open STDERR, ">&STDIN" or die $!; + open STDIN, "+&STDIN" or die $!; + open STDERR, ">&STDIN" or die $!; POSIX::setsid(); } 1; __END__ -=back - =head1 WEB SERVER CONFIGURATIONS =head2 Apache 1.x, 2.x diff --git a/lib/Catalyst/Engine/HTTP.pm b/lib/Catalyst/Engine/HTTP.pm index f685a1e..0024009 100644 --- a/lib/Catalyst/Engine/HTTP.pm +++ b/lib/Catalyst/Engine/HTTP.pm @@ -7,7 +7,7 @@ use HTTP::Status; use NEXT; use Socket; use IO::Socket::INET (); -use IO::Select (); +use IO::Select (); # For PAR require Catalyst::Engine::HTTP::Restarter; @@ -37,9 +37,7 @@ This is the Catalyst engine specialized for development and testing. =head1 METHODS -=over 4 - -=item $self->finalize_headers($c) +=head2 $self->finalize_headers($c) =cut @@ -55,7 +53,7 @@ sub finalize_headers { $self->NEXT::finalize_headers($c); } -=item $self->finalize_read($c) +=head2 $self->finalize_read($c) =cut @@ -69,7 +67,7 @@ sub finalize_read { return $self->NEXT::finalize_read($c); } -=item $self->prepare_read($c) +=head2 $self->prepare_read($c) =cut @@ -82,7 +80,7 @@ sub prepare_read { return $self->NEXT::prepare_read($c); } -=item $self->read_chunk($c, $buffer, $length) +=head2 $self->read_chunk($c, $buffer, $length) =cut @@ -108,7 +106,7 @@ sub read_chunk { } } -=item run +=head2 run =cut @@ -228,8 +226,8 @@ sub _handler { # Initialize CGI environment local %ENV = ( - PATH_INFO => $path || '', - QUERY_STRING => $query_string || '', + PATH_INFO => $path || '', + QUERY_STRING => $query_string || '', REMOTE_ADDR => $sockdata->{peeraddr}, REMOTE_HOST => $sockdata->{peername}, REQUEST_METHOD => $method || '', @@ -336,8 +334,6 @@ sub _get_line { sub _inet_addr { unpack "N*", inet_aton( $_[0] ) } -=back - =head1 SEE ALSO L, L. diff --git a/lib/Catalyst/Engine/HTTP/Restarter.pm b/lib/Catalyst/Engine/HTTP/Restarter.pm index 42f57dd..7c0b90f 100644 --- a/lib/Catalyst/Engine/HTTP/Restarter.pm +++ b/lib/Catalyst/Engine/HTTP/Restarter.pm @@ -84,11 +84,7 @@ and restart the server when any changes are detected. =head1 METHODS -=over 4 - -=item run - -=back +=head2 run =head1 SEE ALSO diff --git a/lib/Catalyst/Engine/HTTP/Restarter/Watcher.pm b/lib/Catalyst/Engine/HTTP/Restarter/Watcher.pm index 7a6bd10..3062dc6 100644 --- a/lib/Catalyst/Engine/HTTP/Restarter/Watcher.pm +++ b/lib/Catalyst/Engine/HTTP/Restarter/Watcher.pm @@ -8,30 +8,32 @@ use File::Modified; use File::Spec; use Time::HiRes qw/sleep/; -__PACKAGE__->mk_accessors( qw/delay - directory - modified - regex - watch_list/ ); +__PACKAGE__->mk_accessors( + qw/delay + directory + modified + regex + watch_list/ +); sub new { my ( $class, %args ) = @_; - - my $self = { %args }; - + + my $self = {%args}; + bless $self, $class; - + $self->_init; - + return $self; } sub _init { my $self = shift; - + my $watch_list = $self->_index_directory; - $self->watch_list( $watch_list ); - + $self->watch_list($watch_list); + $self->modified( File::Modified->new( method => 'mtime', @@ -42,46 +44,48 @@ sub _init { sub watch { my $self = shift; - + my @changes; my @changed_files; - + sleep $self->delay || 1; - + eval { @changes = $self->modified->changed }; - if ( $@ ) { + if ($@) { + # File::Modified will die if a file is deleted. my ($deleted_file) = $@ =~ /stat '(.+)'/; push @changed_files, $deleted_file || 'unknown file'; } - - if ( @changes ) { + + if (@changes) { + # update all mtime information $self->modified->update; - + # check if any files were changed @changed_files = grep { -f $_ } @changes; - + # Check if only directories were changed. This means # a new file was created. - unless ( @changed_files ) { + unless (@changed_files) { + # re-index to find new files my $new_watch = $self->_index_directory; - + # look through the new list for new files my $old_watch = $self->watch_list; - @changed_files = grep { ! defined $old_watch->{$_} } - keys %{ $new_watch }; - + @changed_files = grep { !defined $old_watch->{$_} } + keys %{$new_watch}; + return unless @changed_files; } # Test modified pm's - for my $file ( @changed_files ) { + for my $file (@changed_files) { next unless $file =~ /\.pm$/; if ( my $error = $self->_test($file) ) { - print STDERR - qq/File "$file" modified, not restarting\n\n/; + print STDERR qq/File "$file" modified, not restarting\n\n/; print STDERR '*' x 80, "\n"; print STDERR $error; print STDERR '*' x 80, "\n"; @@ -89,17 +93,17 @@ sub watch { } } } - + return @changed_files; } sub _index_directory { my $self = shift; - - my $dir = $self->directory || die "No directory specified"; - my $regex = $self->regex || '\.pm$'; + + my $dir = $self->directory || die "No directory specified"; + my $regex = $self->regex || '\.pm$'; my %list; - + finddepth( { wanted => sub { @@ -108,10 +112,10 @@ sub _index_directory { return unless -f $file; $file =~ s{/script/..}{}; $list{$file} = 1; - + # also watch the directory for changes my $cur_dir = File::Spec->rel2abs($File::Find::dir); - $cur_dir =~ s{/script/..}{}; + $cur_dir =~ s{/script/..}{}; $list{$cur_dir} = 1; }, no_chdir => 1 @@ -123,17 +127,17 @@ sub _index_directory { sub _test { my ( $self, $file ) = @_; - + delete $INC{$file}; local $SIG{__WARN__} = sub { }; - + open my $olderr, '>&STDERR'; open STDERR, '>', File::Spec->devnull; eval "require '$file'"; open STDERR, '>&', $olderr; - + return ($@) ? $@ : 0; -} +} 1; __END__ diff --git a/lib/Catalyst/Exception.pm b/lib/Catalyst/Exception.pm index ade1a46..fc43cd8 100644 --- a/lib/Catalyst/Exception.pm +++ b/lib/Catalyst/Exception.pm @@ -29,13 +29,11 @@ This is the Catalyst Exception class. =head1 METHODS -=over 4 +=head2 throw( $message ) -=item throw( $message ) +=head2 throw( message => $message ) -=item throw( message => $message ) - -=item throw( error => $error ) +=head2 throw( error => $error ) Throws a fatal exception. @@ -52,8 +50,6 @@ sub throw { Carp::croak($message); } -=back - =head1 AUTHOR Sebastian Riedel, C diff --git a/lib/Catalyst/Helper.pm b/lib/Catalyst/Helper.pm index 0d19516..6a34f7d 100644 --- a/lib/Catalyst/Helper.pm +++ b/lib/Catalyst/Helper.pm @@ -539,9 +539,7 @@ Catalyst based application. =head1 METHODS -=over 4 - -=item default +=head2 default =cut @@ -558,7 +556,7 @@ sub default : Private { # # Uncomment and modify this end action after adding a View component # -#=item end +#=head2 end # #=cut # @@ -569,8 +567,6 @@ sub default : Private { # $c->forward('View::') unless $c->response->body; #} -=back - =head1 AUTHOR [% author %] @@ -1100,12 +1096,10 @@ Catalyst [% long_type %]. [% IF long_type == 'Controller' %] =head1 METHODS -=over 4 - # # Uncomment and modify this or add new actions to fit your needs # -#=item default +#=head2 default # #=cut # @@ -1116,8 +1110,6 @@ Catalyst [% long_type %]. # $c->response->body('[% class %] is on Catalyst!'); #} -=back - [% END %] =head1 AUTHOR diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm index 56f4ff4..4b3c3c3 100644 --- a/lib/Catalyst/Log.pm +++ b/lib/Catalyst/Log.pm @@ -71,16 +71,17 @@ sub _log { my $level = shift; my $time = localtime(time); my $message = join( "\n", @_ ); - $self->{body} .= sprintf( "[%s] [catalyst] [%s] %s\n", - $time, $level, $message ) ; + $self->{body} .= + sprintf( "[%s] [catalyst] [%s] %s\n", $time, $level, $message ); } sub _flush { - my $self = shift; - if ( $self->abort || ! $self->body ) { - $self->abort(undef); - } else { - print( STDERR $self->body); + my $self = shift; + if ( $self->abort || !$self->body ) { + $self->abort(undef); + } + else { + print( STDERR $self->body ); } $self->body(undef); } @@ -122,40 +123,34 @@ Your logging object is expected to provide the interface described here. =head1 LOG LEVELS -=over 4 - -=item debug +=head2 debug $log->is_debug; $log->debug($message); -=item info +=head2 info $log->is_info; $log->info($message); -=item warn +=head2 warn $log->is_warn; $log->warn($message); -=item error +=head2 error $log->is_error; $log->error($message); -=item fatal +=head2 fatal $log->is_fatal; $log->fatal($message); -=back - =head1 METHODS -=over 4 - -=item new +=head2 new Constructor. Defaults to enable all levels unless levels are provided in arguments. @@ -163,37 +158,37 @@ arguments. $log = Catalyst::Log->new; $log = Catalyst::Log->new( 'warn', 'error' ); -=item levels +=head2 levels Set log levels $log->levels( 'warn', 'error', 'fatal' ); -=item enable +=head2 enable Enable log levels $log->enable( 'warn', 'error' ); -=item disable +=head2 disable Disable log levels $log->disable( 'warn', 'error' ); -=item is_debug +=head2 is_debug -=item is_error +=head2 is_error -=item is_fatal +=head2 is_fatal -=item is_info +=head2 is_info -=item is_warn +=head2 is_warn Is the log level active? -=item abort +=head2 abort Should Catalyst emit logs for this request? Will be reset at the end of each request. @@ -203,10 +198,6 @@ to use Log4Perl or another logger, you should call it like this: $c->log->abort(1) if $c->log->can('abort'); -=back - - - =head1 SEE ALSO L. diff --git a/lib/Catalyst/PAR.pm b/lib/Catalyst/PAR.pm index 535174b..6d7164b 100644 --- a/lib/Catalyst/PAR.pm +++ b/lib/Catalyst/PAR.pm @@ -22,9 +22,7 @@ Package Catalyst Applications. =head1 METHODS -=over 4 - -=item $self->package(\%options) +=head2 $self->package(\%options) =cut @@ -106,8 +104,6 @@ EOF unlink $par_test; } -=back - =head1 AUTHOR Sebastian Riedel, C diff --git a/lib/Catalyst/Request.pm b/lib/Catalyst/Request.pm index b8caa11..3dfbee4 100644 --- a/lib/Catalyst/Request.pm +++ b/lib/Catalyst/Request.pm @@ -75,17 +75,15 @@ thus hiding the details of the particular engine implementation. =head1 METHODS -=over 4 - -=item $req->action +=head2 $req->action Returns the requested action as a L object. -=item $req->address +=head2 $req->address Returns the IP address of the client. -=item $req->arguments +=head2 $req->arguments Returns a reference to an array containing the arguments. @@ -102,11 +100,11 @@ For example, if your action was and the URI for the request was C, the string C would be the first and only argument. -=item $req->args +=head2 $req->args Shortcut for arguments. -=item $req->base +=head2 $req->base Contains the URI base. This will always have a trailing slash. @@ -130,7 +128,7 @@ sub base { return $self->{base}; } -=item $req->body +=head2 $req->body Returns the message body of the request, unless Content-Type is C or C. @@ -143,7 +141,7 @@ sub body { return $self->{_body}->body; } -=item $req->body_parameters +=head2 $req->body_parameters Returns a reference to a hash containing body (POST) parameters. Values can be either a scalar or an arrayref containing scalars. @@ -153,7 +151,7 @@ be either a scalar or an arrayref containing scalars. These are the parameters from the POST part of the request, if any. -=item $req->body_params +=head2 $req->body_params Shortcut for body_parameters. @@ -166,19 +164,19 @@ sub body_parameters { return $self->{body_parameters}; } -=item $req->content_encoding +=head2 $req->content_encoding Shortcut for $req->headers->content_encoding. -=item $req->content_length +=head2 $req->content_length Shortcut for $req->headers->content_length. -=item $req->content_type +=head2 $req->content_type Shortcut for $req->headers->content_type. -=item $req->cookie +=head2 $req->cookie A convenient method to access $req->cookies. @@ -206,7 +204,7 @@ sub cookie { } } -=item $req->cookies +=head2 $req->cookies Returns a reference to a hash containing the cookies. @@ -215,17 +213,17 @@ Returns a reference to a hash containing the cookies. The cookies in the hash are indexed by name, and the values are L objects. -=item $req->header +=head2 $req->header Shortcut for $req->headers->header. -=item $req->headers +=head2 $req->headers Returns an L object containing the headers for the current request. print $c->request->headers->header('X-Catalyst'); -=item $req->hostname +=head2 $req->hostname Returns the hostname of the client. @@ -246,20 +244,20 @@ sub hostname { return $self->{hostname}; } -=item $req->input +=head2 $req->input Alias for $req->body. -=item $req->match +=head2 $req->match This contains the matching part of a Regex action. Otherwise it returns the same as 'action'. -=item $req->method +=head2 $req->method Contains the request method (C, C, C, etc). -=item $req->param +=head2 $req->param Returns GET and POST parameters with a CGI.pm-compatible param method. This is an alternative method for accessing parameters in $c->req->parameters. @@ -312,7 +310,7 @@ sub param { } } -=item $req->parameters +=head2 $req->parameters Returns a reference to a hash containing GET and POST parameters. Values can be either a scalar or an arrayref containing scalars. @@ -322,7 +320,7 @@ be either a scalar or an arrayref containing scalars. This is the combination of C and C. -=item $req->params +=head2 $req->params Shortcut for $req->parameters. @@ -335,11 +333,11 @@ sub parameters { return $self->{parameters}; } -=item $req->path +=head2 $req->path Returns the path, i.e. the part of the URI after $req->base, for the current request. -=item $req->path_info +=head2 $req->path_info Alias for path, added for compability with L. @@ -365,11 +363,11 @@ sub path { return $path; } -=item $req->protocol +=head2 $req->protocol Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request. -=item $req->query_parameters +=head2 $req->query_parameters Returns a reference to a hash containing query string (GET) parameters. Values can be either a scalar or an arrayref containing scalars. @@ -377,7 +375,7 @@ be either a scalar or an arrayref containing scalars. print $c->request->query_parameters->{field}; print $c->request->query_parameters->{field}->[0]; -=item $req->read( [$maxlength] ) +=head2 $req->read( [$maxlength] ) Reads a chunk of data from the request body. This method is intended to be used in a while loop, reading $maxlength bytes on every call. $maxlength @@ -389,21 +387,21 @@ You have to set MyApp->config->{parse_on_demand} to use this directly. sub read { shift->{_context}->read(@_); } -=item $req->referer +=head2 $req->referer Shortcut for $req->headers->referer. Returns the referring page. -=item $req->secure +=head2 $req->secure Returns true or false, indicating whether the connection is secure (https). -=item $req->snippets +=head2 $req->snippets Returns a reference to an array containing regex snippets. my @snippets = @{ $c->request->snippets }; -=item $req->upload +=head2 $req->upload A convenient method to access $req->uploads. @@ -461,7 +459,7 @@ sub upload { } } -=item $req->uploads +=head2 $req->uploads Returns a reference to a hash containing uploads. Values can be either a hashref or a arrayref containing L objects. @@ -478,22 +476,20 @@ sub uploads { return $self->{uploads}; } -=item $req->uri +=head2 $req->uri Returns a URI object for the current request. Stringifies to the URI text. -=item $req->user +=head2 $req->user Returns the currently logged in user. Deprecated. The method recommended for newer plugins is $c->user. -=item $req->user_agent +=head2 $req->user_agent Shortcut to $req->headers->user_agent. Returns the user agent (browser) version string. -=back - =head1 AUTHORS Sebastian Riedel, C diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm index f93a838..9a5f1c4 100644 --- a/lib/Catalyst/Request/Upload.pm +++ b/lib/Catalyst/Request/Upload.pm @@ -35,13 +35,11 @@ This class provides accessors and methods to handle client upload requests. =head1 METHODS -=over 4 - -=item $upload->new +=head2 $upload->new Simple constructor. -=item $upload->copy_to +=head2 $upload->copy_to Copies the temporary file using L. Returns true for success, false for failure. @@ -55,7 +53,7 @@ sub copy_to { return File::Copy::copy( $self->tempname, @_ ); } -=item $upload->fh +=head2 $upload->fh Opens a temporary file (see tempname below) and returns an L handle. @@ -77,15 +75,15 @@ sub fh { return $fh; } -=item $upload->filename +=head2 $upload->filename Returns the client-supplied filename. -=item $upload->headers +=head2 $upload->headers Returns an L object for the request. -=item $upload->link_to +=head2 $upload->link_to Creates a hard link to the temporary file. Returns true for success, false for failure. @@ -99,11 +97,11 @@ sub link_to { return CORE::link( $self->tempname, $target ); } -=item $upload->size +=head2 $upload->size Returns the size of the uploaded file in bytes. -=item $upload->slurp +=head2 $upload->slurp Returns a scalar containing the contents of the temporary file. @@ -128,16 +126,14 @@ sub slurp { return $content; } -=item $upload->tempname +=head2 $upload->tempname Returns the path to the temporary file. -=item $upload->type +=head2 $upload->type Returns the client-supplied Content-Type. -=back - =head1 AUTHORS Sebastian Riedel, C diff --git a/lib/Catalyst/Response.pm b/lib/Catalyst/Response.pm index e2862da..ff46398 100644 --- a/lib/Catalyst/Response.pm +++ b/lib/Catalyst/Response.pm @@ -38,27 +38,25 @@ the current client request. =head1 METHODS -=over 4 - -=item $res->body($text) +=head2 $res->body($text) $c->response->body('Catalyst rocks!'); Sets or returns the output (text or binary data). -=item $res->content_encoding +=head2 $res->content_encoding Shortcut for $res->headers->content_encoding. -=item $res->content_length +=head2 $res->content_length Shortcut for $res->headers->content_length. -=item $res->content_type +=head2 $res->content_type Shortcut for $res->headers->content_type. -=item $res->cookies +=head2 $res->cookies Returns a reference to a hash containing cookies to be set. The keys of the hash are the cookies' names, and their corresponding values are hash @@ -70,35 +68,31 @@ The keys of the hash reference on the right correspond to the L parameters of the same name, except they are used without a leading dash. Possible parameters are: -=over 4 - -=item value +=head2 value -=item expires +=head2 expires -=item domain +=head2 domain -=item path +=head2 path -=item secure +=head2 secure -=back - -=item $res->header +=head2 $res->header Shortcut for $res->headers->header. -=item $res->headers +=head2 $res->headers Returns an L object, which can be used to set headers. $c->response->headers->header( 'X-Catalyst' => $Catalyst::VERSION ); -=item $res->output +=head2 $res->output Alias for $res->body. -=item $res->redirect( $url, $status ) +=head2 $res->redirect( $url, $status ) Causes the response to redirect to the specified URL. @@ -121,13 +115,13 @@ sub redirect { return $self->location; } -=item $res->status +=head2 $res->status Sets or returns the HTTP status. $c->response->status(404); -=item $res->write( $data ) +=head2 $res->write( $data ) Writes $data to the output stream. @@ -135,8 +129,6 @@ Writes $data to the output stream. sub write { shift->{_context}->write(@_); } -=back - =head1 AUTHORS Sebastian Riedel, C diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index f4d5f89..e227bad 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -51,15 +51,13 @@ Test Catalyst Applications. =head2 METHODS -=over 4 - -=item get +=head2 get Returns the content. my $content = get('foo/bar?test=1'); -=item request +=head2 request Returns a C object. @@ -93,7 +91,7 @@ sub import { *{"$caller\::get"} = $get; } -=item local_request +=head2 local_request =cut @@ -112,7 +110,7 @@ sub local_request { my $agent; -=item remote_request +=head2 remote_request Do an actual remote request using LWP. @@ -148,8 +146,6 @@ sub remote_request { return $agent->request($request); } -=back - =head1 SEE ALSO L. diff --git a/lib/Catalyst/Utils.pm b/lib/Catalyst/Utils.pm index c3145d3..b3b75bb 100644 --- a/lib/Catalyst/Utils.pm +++ b/lib/Catalyst/Utils.pm @@ -19,9 +19,7 @@ See L. =head1 METHODS -=over 4 - -=item appprefix($class) +=head2 appprefix($class) MyApp::Foo becomes myapp_foo @@ -34,7 +32,7 @@ sub appprefix { return $class; } -=item class2appclass($class); +=head2 class2appclass($class); MyApp::C::Foo::Bar becomes MyApp My::App::C::Foo::Bar becomes My::App @@ -50,7 +48,7 @@ sub class2appclass { return $appname; } -=item class2classprefix($class); +=head2 class2classprefix($class); MyApp::C::Foo::Bar becomes MyApp::C My::App::C::Foo::Bar becomes My::App::C @@ -66,7 +64,7 @@ sub class2classprefix { return $prefix; } -=item class2classsuffix($class); +=head2 class2classsuffix($class); MyApp::C::Foo::Bar becomes C::Foo::Bar @@ -79,7 +77,7 @@ sub class2classsuffix { return $class; } -=item class2env($class); +=head2 class2env($class); Returns the environment name for class. @@ -94,7 +92,7 @@ sub class2env { return uc($class); } -=item class2prefix( $class, $case ); +=head2 class2prefix( $class, $case ); Returns the uri prefix for a class. If case is false the prefix is converted to lowercase. @@ -113,7 +111,7 @@ sub class2prefix { return $prefix; } -=item class2tempdir( $class [, $create ] ); +=head2 class2tempdir( $class [, $create ] ); Returns a tempdir for a class. If create is true it will try to create the path. @@ -142,7 +140,7 @@ sub class2tempdir { return $tmpdir->stringify; } -=item home($class) +=head2 home($class) Returns home directory for given class. @@ -175,7 +173,7 @@ sub home { return $home; } -=item prefix($class, $name); +=head2 prefix($class, $name); Returns a prefixed action. @@ -190,7 +188,7 @@ sub prefix { return $name; } -=item request($uri) +=head2 request($uri) Returns an L object for a uri. @@ -212,8 +210,6 @@ sub request { return $request; } -=back - =head1 AUTHOR Sebastian Riedel, C