Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Pod::Weaver plugin for @ISA
Perl
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib/Pod/Weaver/Section
.gitignore
README.pod
dist.ini
weaver.ini

README.pod

NAME

Pod::Weaver::Section::Extends - Add a list of parent classes to your POD.

VERSION

version 0.009

SYNOPSIS

In your weaver.ini:

    [Extends]

DESCRIPTION

This 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 loading your class and inspecting their @ISA.

All classes (*.pm files) in your distribution's lib directory will be loaded. Classes which do not have parent classes will be skipped.

CAVEAT

In case you use Dist::Zilla to install dependencies of your distribution, you might encounter a quirk caused by this plugin. If you run dzil listdeps, dzil will load this module which in turn will load all classes in lib which in turn may want to load classes which are not yet installed. Currently, there seems to be no easy way around this with Dist::Zilla alone. But there are workarounds. You could, for example, eliminate weaver.ini during the installation process:

    #temporarily remove weaver.ini during install
    cpanm Pod::Weaver::Section::Consumes
    mv weaver.ini _weaver.ini
    dzil authordeps | cpanm
    dzil listdeps | cpanm
    mv _weaver.ini weaver.ini

Or install dependencies before you run listdeps, for example by adding them as authordeps to dist.ini.

    #dist.ini 
    #authordep JSON = 2.57

SEE ALSO

Pod::Weaver::Section::Consumes

AUTHOR

Mike Friedman <friedo@friedo.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Mike Friedman.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Something went wrong with that request. Please try again.