[Jifty-commit] r6920 - jifty/trunk/lib/Jifty/Script

[Jifty commits]

Author: sartak
Date: Wed Apr 29 19:46:56 2009
New Revision: 6920

Modified:
   jifty/trunk/lib/Jifty/Script/Action.pm
   jifty/trunk/lib/Jifty/Script/Adopt.pm
   jifty/trunk/lib/Jifty/Script/App.pm
   jifty/trunk/lib/Jifty/Script/Env.pm
   jifty/trunk/lib/Jifty/Script/FastCGI.pm
   jifty/trunk/lib/Jifty/Script/Model.pm
   jifty/trunk/lib/Jifty/Script/Plugin.pm
   jifty/trunk/lib/Jifty/Script/Schema.pm
   jifty/trunk/lib/Jifty/Script/Script.pm
   jifty/trunk/lib/Jifty/Script/Server.pm

Log:
Pod coverage for script classes

Modified: jifty/trunk/lib/Jifty/Script/Action.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/Action.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/Action.pm	Wed Apr 29 19:46:56 2009
@@ -14,7 +14,11 @@
     jifty action --help
     jifty action --man
 
-=head1 OPTIONS
+=head1 DESCRIPTION
+
+Creates a skeleton action file.
+
+=head2 options
 
 There are only two possible options to this script:
 

Modified: jifty/trunk/lib/Jifty/Script/Adopt.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/Adopt.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/Adopt.pm	Wed Apr 29 19:46:56 2009
@@ -27,7 +27,14 @@
    --help             brief help message
    --man              full documentation
 
-=head1 OPTIONS
+=head1 DESCRIPTION
+
+This script will let you create an application-specific replacement for stock
+Jifty components. For various reasons, Jifty does not actually create these
+skeleton files in your application's directory tree. While this makes upgrading
+easier, it can make finding which files to create a little difficult.
+
+=head2 options
 
 =over 8
 

Modified: jifty/trunk/lib/Jifty/Script/App.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/App.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/App.pm	Wed Apr 29 19:46:56 2009
@@ -21,12 +21,17 @@
   jifty --name MyApp  Creates an application
 
  Options:
-   --name             applicaation name
+   --name             application name
 
    --help             brief help message
    --man              full documentation
 
-=head1 OPTIONS
+=head1 DESCRIPTION
+
+This script creates the skeleton of your application. See
+L<Jifty::Manual::Tutorial> for more information.
+
+=head2 options
 
 =over 8
 

Modified: jifty/trunk/lib/Jifty/Script/Env.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/Env.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/Env.pm	Wed Apr 29 19:46:56 2009
@@ -22,23 +22,6 @@
     jifty env 'Util->share_root'
     jifty env  Util.share_root
 
-=head1 OPTIONS
-
-This script has no specific options now. Maybe it will have
-some command lines options in the future.
-
-=over 8
-
-=item B<--help>
-
-Print a brief help message and exits.
-
-=item B<--man>
-
-Prints the manual page and exits.
-
-=back
-
 =head1 DESCRIPTION
 
 Loads Jifty and your configuration, allowing you to verify and examine
@@ -63,6 +46,29 @@
 
 With no arguments, acts as 'C<jifty env Jifty.config.stash>'.
 
+=head2 options
+
+This script has no specific options now. Maybe it will have
+some command lines options in the future.
+
+=over 8
+
+=item B<--help>
+
+Print a brief help message and exits.
+
+=item B<--man>
+
+Prints the manual page and exits.
+
+=back
+
+=head1 METHODS
+
+=head2 run
+
+Prints whatever the user asked for.
+
 =cut
 
 sub run {

Modified: jifty/trunk/lib/Jifty/Script/FastCGI.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/FastCGI.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/FastCGI.pm	Wed Apr 29 19:46:56 2009
@@ -23,7 +23,11 @@
     --help             brief help message
     --man              full documentation
 
-=head1 OPTIONS
+=head1 DESCRIPTION
+
+FastCGI entry point for your Jifty application
+
+=head2 options
 
 =over 8
 

Modified: jifty/trunk/lib/Jifty/Script/Model.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/Model.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/Model.pm	Wed Apr 29 19:46:56 2009
@@ -20,7 +20,11 @@
     --help             brief help message
     --man              full documentation
 
-=head1 OPTIONS
+=head1 DESCRIPTION
+
+Creates a skeleton model file.
+
+=head2 options
 
 =over 8
 

Modified: jifty/trunk/lib/Jifty/Script/Plugin.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/Plugin.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/Plugin.pm	Wed Apr 29 19:46:56 2009
@@ -26,7 +26,7 @@
 
 Creates a skeleton of a new L<Jifty::Plugin>.
 
-=head1 OPTIONS
+=head2 options
 
 =over 8
 

Modified: jifty/trunk/lib/Jifty/Script/Schema.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/Schema.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/Schema.pm	Wed Apr 29 19:46:56 2009
@@ -29,7 +29,11 @@
    --help             brief help message
    --man              full documentation
 
-=head1 OPTIONS
+=head1 DESCRIPTION
+
+Manages your database.
+
+=head2 options
 
 =over 8
 

Modified: jifty/trunk/lib/Jifty/Script/Script.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/Script.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/Script.pm	Wed Apr 29 19:46:56 2009
@@ -15,7 +15,11 @@
     jifty script --help
     jifty script --man
 
-=head1 OPTIONS
+=head1 DESCRIPTION
+
+Add a skeleton command-line script file.
+
+=head2 options
 
 =over 8
 

Modified: jifty/trunk/lib/Jifty/Script/Server.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Script/Server.pm	(original)
+++ jifty/trunk/lib/Jifty/Script/Server.pm	Wed Apr 29 19:46:56 2009
@@ -32,7 +32,11 @@
     jifty server --port 6666
     jifty server --stop
 
-=head1 OPTIONS
+=head1 DESCRIPTION
+
+Starts and stops Jifty's standalone web server.
+
+=head2 options
 
 =over 8