From 631e727960ecf5773c0b2fe60c76f4f54c9145cc Mon Sep 17 00:00:00 2001 From: Jesse Luehrs Date: Sun, 21 Nov 2010 22:31:04 -0600 Subject: doc boilerplate --- lib/Dist/CheckConflicts.pm | 69 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) (limited to 'lib') 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, or browse to +L. + +=head1 SEE ALSO + +=over 4 + +=item * L + +=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 + +=item * CPAN Ratings + +L + +=item * RT: CPAN's request tracker + +L + +=item * Search CPAN + +L + +=back + +=cut + 1; -- cgit v1.2.3-54-g00ecf