]> git.vpit.fr Git - perl/modules/rgit.git/blobdiff - lib/App/Rgit/Command.pm
Switch qw delimiters to <>
[perl/modules/rgit.git] / lib / App / Rgit / Command.pm
index 7fbba531a4a4e17cdda8bcf08efc806601ed44ef..8761da38dbfb553b7c46bba8ba27256573db2eef 100644 (file)
@@ -5,7 +5,7 @@ use warnings;
 
 use Carp ();
 
-use App::Rgit::Utils qw/:codes/;
+use App::Rgit::Utils qw<:codes>;
 
 =head1 NAME
 
@@ -13,11 +13,11 @@ App::Rgit::Command - Base class for App::Rgit commands.
 
 =head1 VERSION
 
-Version 0.06
+Version 0.08
 
 =cut
 
-our $VERSION = '0.06';
+our $VERSION = '0.08';
 
 =head1 DESCRIPTION
 
@@ -27,14 +27,19 @@ This is an internal class to L<rgit>.
 
 =head1 METHODS
 
-=head2 C<< new cmd => $cmd, args => \@args >>
+=head2 C<new>
+
+    my $arc = App::Rgit::Command->new(
+     cmd  => $cmd,
+     args => \@args,
+    );
 
 Creates a new command object for C<$cmd> that is bound to be called with arguments C<@args>.
 
 =cut
 
 my %commands;
-__PACKAGE__->action($_ => 'Once') for qw/daemon gui help init version/, ' ';
+__PACKAGE__->action($_ => 'Once') for qw<daemon gui help init version>, ' ';
 
 sub new {
  my $class = shift;
@@ -63,7 +68,10 @@ sub new {
  }, $class;
 }
 
-=head2 C<< action $cmd [ => $pkg ] >>
+=head2 C<action>
+
+    my $pkg = $arc->action($cmd);
+    $arc->action($cmd => $pkg);
 
 If C<$pkg> is supplied, handles command C<$cmd> with C<$pkg> objects.
 Otherwise, returns the current class for C<$cmd>.
@@ -84,7 +92,9 @@ sub action {
  $commands{$cmd} = $pkg;
 }
 
-=head2 C<report $conf, $repo, $status>
+=head2 C<report>
+
+    my $code = $arc->report($conf, $repo, $status);
 
 Reports that the execution of the command in C<$repo> exited with C<$status> to the current command's policy.
 Returns what policy C<report> method returned, which should be one of the policy codes listed in C<App::Rgit::Utils>.
@@ -110,10 +120,12 @@ Read-only accessors.
 =cut
 
 BEGIN {
- eval "sub $_ { \$_[0]->{$_} }" for qw/cmd args policy/;
+ eval "sub $_ { \$_[0]->{$_} }" for qw<cmd args policy>;
 }
 
-=head2 C<run $conf>
+=head2 C<run>
+
+    my $code = $arc->run($conf);
 
 Runs the command with a L<App::Rgit::Config> configuration object.
 Handles back the code to return to the system and the last policy.