Pod::Weaver::Section::Generic.3pm

Langue: en

Version: 2010-06-12 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Pod::Weaver::Section::Generic - a generic section, found by lifting sections

VERSION

version 3.101630

OVERVIEW

This section will find and include a located hunk of Pod. In general, it will find a "=head1" command with a content of the plugin's name.

In other words, if your configuration include:

   [Generic]
   header = OVERVIEW

...then this weaver will look for ``=head1 OVERVIEW'' and include it at the appropriate location in your output.

Since you'll probably want to use Generic several times, and that will require giving each use a unique name, you can omit "header" if you provide a plugin name, and it will default to the plugin name. In other words, the configuration above could be specified just as:

   [Generic / OVERVIEW]

If the "required" attribute is given, and true, then an exception will be raised if this section can't be found.

AUTHOR

Ricardo SIGNES <rjbs@cpan.org> This software is copyright (c) 2010 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.