Pass Pod coverage
Tomas Doran [Fri, 20 Nov 2009 00:45:13 +0000 (00:45 +0000)]
lib/Catalyst/ScriptRole.pm
lib/Catalyst/ScriptRunner.pm

index dd0a7d5..bea26de 100644 (file)
@@ -75,11 +75,35 @@ Catalyst::ScriptRole - Common functionality for Catalyst scripts.
 
 =head1 SYNOPSIS
 
-    FIXME
+    package MyApp::Script::Foo;
+    use Moose;
+    use namespace::autoclean;
+    
+    with 'Catalyst::Script::Role';
+    
+     sub _application_args { ... }
     
 =head1 DESCRIPTION
 
-    FIXME    
+Role with the common functionality of Catalyst scripts.
+
+=head1 METHODS
+
+=head2 run
+
+The method invoked to run the application.
+
+=head1 ATTRIBUTES
+
+=head2 application_name
+
+The name of the application class, e.g. MyApp
+
+=head1 SEE ALSO
+
+L<Catalyst>
+
+L<MooseX::Getopt>
 
 =head1 AUTHORS
 
index 08fd66e..63d153d 100644 (file)
@@ -38,6 +38,13 @@ Catalyst::ScriptRunner - The Catalyst Framework script runner
 This class is responsible for running scripts, either in the application specific namespace
 (e.g. C<MyApp::Script::Server>), or the Catalyst namespace (e.g. C<Catalyst::Script::Server>)
 
+=head1 METHODS
+
+=head2 run ($application_class, $scriptclass)
+
+Called with two parameters, the application classs (e.g. MyApp)
+and the script class, (i.e. one of Server/FastCGI/CGI/Create/Test)
+
 =head1 AUTHORS
 
 Catalyst Contributors, see Catalyst.pm