summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2010-11-21 22:31:04 -0600
committerJesse Luehrs <doy@tozt.net>2010-11-21 22:31:04 -0600
commit631e727960ecf5773c0b2fe60c76f4f54c9145cc (patch)
tree84a493b000d540e24731dca447cc07848a1acc41
parentedbcd55071558952e722fad1551cb4b3ec361c60 (diff)
downloaddist-checkconflicts-631e727960ecf5773c0b2fe60c76f4f54c9145cc.tar.gz
dist-checkconflicts-631e727960ecf5773c0b2fe60c76f4f54c9145cc.zip
doc boilerplate
-rw-r--r--lib/Dist/CheckConflicts.pm69
-rw-r--r--weaver.ini10
2 files changed, 69 insertions, 10 deletions
diff --git a/lib/Dist/CheckConflicts.pm b/lib/Dist/CheckConflicts.pm
index 5ec66b4..d33a4a2 100644
--- a/lib/Dist/CheckConflicts.pm
+++ b/lib/Dist/CheckConflicts.pm
@@ -1,11 +1,18 @@
package Dist::CheckConflicts;
use strict;
use warnings;
+# ABSTRACT: declare version conflicts for your dist
use Carp;
use List::MoreUtils 'first_index';
use Sub::Exporter;
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=cut
+
my $import = Sub::Exporter::build_exporter({
exports => [ qw(conflicts check_conflicts calculate_conflicts dist) ],
groups => {
@@ -54,16 +61,28 @@ sub _strip_opt {
return ( $val, @_ );
}
+=method conflicts
+
+=cut
+
sub conflicts {
my $package = shift;
return %{ $CONFLICTS{ $package } };
}
+=method dist
+
+=cut
+
sub dist {
my $package = shift;
return $DISTS{ $package };
}
+=method check_conflicts
+
+=cut
+
sub check_conflicts {
my $package = shift;
my $dist = $package->dist;
@@ -79,6 +98,10 @@ sub check_conflicts {
die $err;
}
+=method calculate_conflicts
+
+=cut
+
sub calculate_conflicts {
my $package = shift;
my %conflicts = $package->conflicts;
@@ -102,4 +125,50 @@ sub calculate_conflicts {
return sort { $a->{package} cmp $b->{package} } @ret;
}
+=head1 BUGS
+
+No known bugs.
+
+Please report any bugs through RT: email
+C<bug-dist-checkconflicts at rt.cpan.org>, or browse to
+L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dist-CheckConflicts>.
+
+=head1 SEE ALSO
+
+=over 4
+
+=item * L<Module::Install::CheckConflicts>
+
+=back
+
+=head1 SUPPORT
+
+You can find this documentation for this module with the perldoc command.
+
+ perldoc Dist::CheckConflicts
+
+You can also look for information at:
+
+=over 4
+
+=item * AnnoCPAN: Annotated CPAN documentation
+
+L<http://annocpan.org/dist/Dist-CheckConflicts>
+
+=item * CPAN Ratings
+
+L<http://cpanratings.perl.org/d/Dist-CheckConflicts>
+
+=item * RT: CPAN's request tracker
+
+L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Dist-CheckConflicts>
+
+=item * Search CPAN
+
+L<http://search.cpan.org/dist/Dist-CheckConflicts>
+
+=back
+
+=cut
+
1;
diff --git a/weaver.ini b/weaver.ini
index 219a165..1107cad 100644
--- a/weaver.ini
+++ b/weaver.ini
@@ -22,15 +22,5 @@ command = func
[Region / postlude]
-[Template / BUGS]
-template = ~/.dzil/pod_templates/bugs.section
-main_module_only = 1
-
-[SeeAlso]
-
-[Template / SUPPORT]
-template = ~/.dzil/pod_templates/support.section
-main_module_only = 1
-
[Authors]
[Legal]