summaryrefslogtreecommitdiff
path: root/Master/tlpkg/tlperl/lib/CPAN/Meta/Feature.pm
diff options
context:
space:
mode:
Diffstat (limited to 'Master/tlpkg/tlperl/lib/CPAN/Meta/Feature.pm')
-rw-r--r--Master/tlpkg/tlperl/lib/CPAN/Meta/Feature.pm48
1 files changed, 39 insertions, 9 deletions
diff --git a/Master/tlpkg/tlperl/lib/CPAN/Meta/Feature.pm b/Master/tlpkg/tlperl/lib/CPAN/Meta/Feature.pm
index 31f4935b178..f97cc652e83 100644
--- a/Master/tlpkg/tlperl/lib/CPAN/Meta/Feature.pm
+++ b/Master/tlpkg/tlperl/lib/CPAN/Meta/Feature.pm
@@ -2,10 +2,28 @@ use 5.006;
use strict;
use warnings;
package CPAN::Meta::Feature;
-our $VERSION = '2.120921'; # VERSION
+our $VERSION = '2.140640'; # VERSION
use CPAN::Meta::Prereqs;
+# =head1 DESCRIPTION
+#
+# A CPAN::Meta::Feature object describes an optional feature offered by a CPAN
+# distribution and specified in the distribution's F<META.json> (or F<META.yml>)
+# file.
+#
+# For the most part, this class will only be used when operating on the result of
+# the C<feature> or C<features> methods on a L<CPAN::Meta> object.
+#
+# =method new
+#
+# my $feature = CPAN::Meta::Feature->new( $identifier => \%spec );
+#
+# This returns a new Feature object. The C<%spec> argument to the constructor
+# should be the same as the value of the C<optional_feature> entry in the
+# distmeta. It must contain entries for C<description> and C<prereqs>.
+#
+# =cut
sub new {
my ($class, $identifier, $spec) = @_;
@@ -19,12 +37,28 @@ sub new {
bless \%guts => $class;
}
+# =method identifier
+#
+# This method returns the feature's identifier.
+#
+# =cut
sub identifier { $_[0]{identifier} }
+# =method description
+#
+# This method returns the feature's long description.
+#
+# =cut
sub description { $_[0]{description} }
+# =method prereqs
+#
+# This method returns the feature's prerequisites as a L<CPAN::Meta::Prereqs>
+# object.
+#
+# =cut
sub prereqs { $_[0]{prereqs} }
@@ -32,17 +66,19 @@ sub prereqs { $_[0]{prereqs} }
# ABSTRACT: an optional feature provided by a CPAN distribution
-
+__END__
=pod
+=encoding UTF-8
+
=head1 NAME
CPAN::Meta::Feature - an optional feature provided by a CPAN distribution
=head1 VERSION
-version 2.120921
+version 2.140640
=head1 DESCRIPTION
@@ -107,9 +143,3 @@ This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
-
-
-__END__
-
-
-