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.020

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.

PERL VERSION

This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

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 <cpan@semiotic.systems>

COPYRIGHT AND LICENSE

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

2024-03-24 perl v5.38.2