Ricardo SIGNES > Dist-Zilla-Plugin-PodWeaver > Dist::Zilla::Plugin::PodWeaver

Download:
Dist-Zilla-Plugin-PodWeaver-4.006.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 4.006   Source  

NAME ^

Dist::Zilla::Plugin::PodWeaver - weave your Pod together from configuration and Dist::Zilla

VERSION ^

version 4.006

DESCRIPTION ^

[PodWeaver] is the bridge between Dist::Zilla and Pod::Weaver. It rips apart your kinda-Pod and reconstructs it as boring old real Pod.

ATTRIBUTES ^

finder

[PodWeaver] is a Dist::Zilla::Role::FileFinderUser. The FileFinder given for its finder attribute is used to decide which files to munge. By default, it will munge:

METHODS ^

weaver

This method returns the Pod::Weaver object to be used. The current implementation builds a new weaver on each invocation, because one or two core Pod::Weaver plugins cannot be trusted to handle multiple documents per plugin instance. In the future, when that is fixed, this may become an accessor of an attribute with a builder. Until this is clearer, use caution when modifying this method in subclasses.

CONFIGURATION ^

If the config_plugin attribute is given, it will be treated like a Pod::Weaver section heading. For example, @Default could be given. I may be given multiple times.

Otherwise, if a file matching ./weaver.* exists, Pod::Weaver will be told to look for configuration in the current directory.

Otherwise, it will use the default configuration.

AUTHOR ^

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by Ricardo SIGNES.

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

syntax highlighting: