Make sure the POD headings are linkable

[perl/modules/rgit.git] / lib / App / Rgit / Command.pm

diff --git a/lib/App/Rgit/Command.pm b/lib/App/Rgit/Command.pm
index 348b8c40aab70ef4c659ba8167ca287222b95807..b4d78dd4984270f922a9b080b3c6963455651a40 100644 (file)
--- a/lib/App/Rgit/Command.pm
+++ b/lib/App/Rgit/Command.pm
@@ -3,7 +3,7 @@ package App::Rgit::Command;
 use strict;
 use warnings;
 
-use Carp qw/croak/;
+use Carp ();
 
 use App::Rgit::Utils qw/:codes/;
 
@@ -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,7 +27,12 @@ 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>.
 
@@ -50,11 +55,12 @@ sub new {
  if ($class eq __PACKAGE__) {
   $class = $action;
  } else {
-  croak "Command $cmd should be executed as a $action"
-                               unless $class->isa($action);
+  Carp::confess("Command $cmd should be executed as a $action")
+                                                    unless $class->isa($action);
  }
 
- eval "require $action; 1" or croak "Couldn't load $action: $@";
+ eval "require $action; 1" or Carp::confess("Couldn't load $action: $@");
+
  bless {
   cmd    => $cmd,
   args   => $args{args} || [ ],
@@ -62,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>.
@@ -83,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>.
@@ -93,7 +104,7 @@ Returns what policy C<report> method returned, which should be one of the policy
 sub report {
  my ($self) = @_;
 
- my $code = $self->policy->report(@_);
+ my $code = $self->policy->handle(@_);
 
  return defined $code ? $code : NEXT;
 }
@@ -112,7 +123,9 @@ BEGIN {
  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.
@@ -130,7 +143,8 @@ You can contact me by mail or on C<irc.perl.org> (vincent).
 
 =head1 BUGS
 
-Please report any bugs or feature requests to C<bug-rgit at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=rgit>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+Please report any bugs or feature requests to C<bug-rgit at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=rgit>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 
 =head1 SUPPORT
 
@@ -140,7 +154,7 @@ You can find documentation for this module with the perldoc command.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2008-2009 Vincent Pit, all rights reserved.
+Copyright 2008,2009,2010 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.