1Pod::Abstract::Filter::UosveerrlCaoyn(t3r)ibuted Perl DoPcoudm:e:nAtbasttiroanct::Filter::overlay(3)
2
3
4

METHODS

6   filter
7       Inspects the source document for a begin/end block named ":overlay".
8       The overlay block will be inspected for "=overlay" commands, which
9       should be structured like:
10
11        =begin :overlay
12
13        =overlay METHODS Some::Class::Or::File
14
15        =end :overlay
16
17       Each overlay is processed in order. It will add any headings for the
18       matched sections in the current document from the named source, for any
19       heading that is not already present in the given section.
20
21       If that doesn't make sense just try it and it will!
22
23       The main utility of this is to specify a superclass, so that all the
24       methods that are not documented in your subclass become documented by
25       the overlay. The "sort" filter makes a good follow up.
26
27       The start of overlaid sections will include:
28
29        =for overlay from <class-or-file>
30
31       You can use these markers to set sections to be replaced by some other
32       document, or to repeat an overlay on an already processed Pod file.
33       Changes to existing marked sections are made in-place without changing
34       document order.
35

AUTHOR

37       Ben Lilburne <bnej@mac.com>
38

40       Copyright (C) 2009 Ben Lilburne
41
42       This program is free software; you can redistribute it and/or modify it
43       under the same terms as Perl itself.
44
45
46
47perl v5.12.0                      2009-05-26 Pod::Abstract::Filter::overlay(3)
Impressum