The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Pod::Weaver::Section::ReplaceName - Add or replace a NAME section with abstract.

VERSION

version 1.00

OVERVIEW

This section plugin provides the same behaviour as Pod::Weaver::Section::Name but with the Pod::Weaver::Role::SectionReplacer role applied.

This section plugin will produce a hunk of Pod giving the name of the document as well as an abstract, like this:

  =head1 NAME

  Some::Document - a document for some

It will determine the name and abstract by inspecting the ppi_document input parameter. It will look for the first package declaration, and for a comment in this form:

  # ABSTRACT: a document for some

AUTHOR

Sam Graham <libpod-weaver-pluginbundle-replaceboilerplate-perl BLAHBLAH illusori.co.uk>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Sam Graham <libpod-weaver-pluginbundle-replaceboilerplate-perl BLAHBLAH illusori.co.uk>.

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