Permalink
Browse files

added docs, bumped version

  • Loading branch information...
1 parent f50a83b commit b8bdc3bcb7803a37aa9d97036b2b781891f55ca1 @friedo committed Dec 2, 2011
Showing with 30 additions and 4 deletions.
  1. +13 −1 README.pod
  2. +1 −1 dist.ini
  3. +16 −2 lib/Pod/Weaver/Section/Extends.pm
View
@@ -4,7 +4,19 @@ Pod::Weaver::Section::Extends - Add a list of parent classes to your POD.
=head1 VERSION
-version 0.001
+version 0.002
+
+=head1 SYNOPSIS
+
+In your C<weaver.ini>:
+
+ [Extends]
+
+=head1 DESCRIPTION
+
+This L<Pod::Weaver> section plugin creates an "EXTENDS" section in your POD
+which will contain a list of your class's parent classes. It accomplishes
+this by attempting to compile your class and inspecting its C<@ISA>.
=head1 AUTHOR
View
@@ -4,7 +4,7 @@ license = Perl_5
copyright_holder = Mike Friedman
copyright_year = 2011
-version = 0.001
+version = 0.002
[@Basic]
[AutoPrereqs]
@@ -13,8 +13,6 @@ use aliased 'Pod::Elemental::Element::Nested';
use aliased 'Pod::Elemental::Element::Pod5::Verbatim';
use aliased 'Pod::Elemental::Element::Pod5::Command';
-use Data::Dumper;
-
sub weave_section {
my ( $self, $doc, $input ) = @_;
@@ -73,3 +71,19 @@ sub _get_parents {
1;
+
+
+=pod
+
+=head1 SYNOPSIS
+
+In your C<weaver.ini>:
+
+ [Extends]
+
+=head1 DESCRIPTION
+
+This L<Pod::Weaver> section plugin creates an "EXTENDS" section in your POD
+which will contain a list of your class's parent classes. It accomplishes
+this by attempting to compile your class and inspecting its C<@ISA>.
+

0 comments on commit b8bdc3b

Please sign in to comment.