Ricardo SIGNES > Pod-Weaver-3.101639 > Pod::Weaver::Section::Collect

Download:
Pod-Weaver-3.101639.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 3.101639   Source   Latest Release: Pod-Weaver-4.006

NAME ^

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

VERSION ^

version 3.101639

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)

header

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) 2013 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: