[Jifty-commit] r6959 - in jifty/trunk/lib/Jifty/Plugin: Config Config/Action

[Jifty commits]

Author: alexmv
Date: Fri May  8 14:10:18 2009
New Revision: 6959

Modified:
   jifty/trunk/lib/Jifty/Plugin/Authentication/Password/View.pm
   jifty/trunk/lib/Jifty/Plugin/Config/Action/Config.pm
   jifty/trunk/lib/Jifty/Plugin/Config/View.pm

Log:
Better POD coverage

Modified: jifty/trunk/lib/Jifty/Plugin/Authentication/Password/View.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/Authentication/Password/View.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/Authentication/Password/View.pm	Fri May  8 14:10:18 2009
@@ -8,15 +8,8 @@
 
 =head1 DESCRIPTION
 
-This code is only useful on the new Jifty "Declarative templates" branch. It shouldn't get in the way if you're running a traditional (0.610 or before) Jifty.
-
-=begin comment
-
-Is the above really true or need to said anymore? -- Sterling
-
-=end comment
-
-This provides the templates for the pages and forms used by the password authentication plugin.
+This provides the templates for the pages and forms used by the
+password authentication plugin.
 
 =cut
 

Modified: jifty/trunk/lib/Jifty/Plugin/Config/Action/Config.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/Config/Action/Config.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/Config/Action/Config.pm	Fri May  8 14:10:18 2009
@@ -6,14 +6,21 @@
 use UNIVERSAL::require;
 use Jifty::YAML;
 use File::Spec;
+use Scalar::Defer;
 
 =head2 NAME
 
 Jifty::Plugin::Config::Action::Config - Register config
 
+=head2 METHODS
+
+=head1 arguments
+
+Provides a single argument, C<config>, which is a textarea with
+Jifty's L<YAML> configuration in it.
+
 =cut
 
-use Scalar::Defer; 
 sub arguments {
     my $self = shift;
     return $self->{__cached_arguments} if ( $self->{__cached_arguments} );
@@ -35,6 +42,9 @@
 
 =head2 take_action
 
+Attempts to update the application's F<etc/config.yml> file with the
+new configuration.
+
 =cut
 
 sub take_action {
@@ -72,6 +82,8 @@
 
 =head2 report_success
 
+Reports that the action succeeded.
+
 =cut
 
 sub report_success {

Modified: jifty/trunk/lib/Jifty/Plugin/Config/View.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/Config/View.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/Config/View.pm	Fri May  8 14:10:18 2009
@@ -1,7 +1,22 @@
-package Jifty::Plugin::Config::View;
 use strict;
 use warnings;
 
+=head1 NAME
+
+Jifty::Plugin::Config::View - Templates for Config plugin
+
+=head1 DESCRIPTION
+
+This provides two views for the configuration plugin.
+
+=head2 /__jifty/config
+
+This path (configurable by the C<config_url> setting of the plugin)
+shows the L<Jifty::Plugin::Config::Action::Config> action.
+
+=cut
+
+package Jifty::Plugin::Config::View;
 use Jifty::View::Declare -base;
 
 __PACKAGE__->use_mason_wrapper;
@@ -24,6 +39,14 @@
     }
 };
 
+=head2 /__jifty/config/restart.html
+
+This path (configurable by the C<restart_url> setting of the plugin)
+waits five seconds, then redirects to the configured
+C<after_restart_url>.
+
+=cut
+
 template $restart_url => sub {
     my $seconds = get('seconds') || Jifty::Plugin::Config->wait_seconds || 5;
     my $url = get('url') || Jifty::Plugin::Config->after_restart_url;
@@ -48,3 +71,5 @@
     Jifty->handler->buffer->flush_output();
     $Jifty::SERVER->restart;
 };
+
+1;