Scroll to navigation

Pod::Weaver::Section::Collect(3pm) User Contributed Perl Documentation Pod::Weaver::Section::Collect(3pm)

NAME

Pod::Weaver::Section::Collect - a section that gathers up specific commands

VERSION

version 4.015

OVERVIEW

Given the configuration:

  [Collect / METHODS]
  command = method

This plugin will start off by gathering and nesting any "=method" commands found in the "pod_document". Those commands, along with their nestable content, will be collected under a "=head1 METHODS" header and placed in the correct location in the output stream. Their order will be preserved as it was in the source document.

ATTRIBUTES

command

The command that will be collected (e.g. "attr" or "method"). (required)

new_command

The command to be used in the output instead of the collected command. (default: "head2")

header_command

The section command for the section to be added. (default: "head1")

The title of the section to be added. (default: the plugin name)

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 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.

2016-10-22 perl v5.24.1