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

NAME

6       Pod::Abstract::Filter::overlay - paf command to perform a method
7       documentation overlay on a Pod document.
8

METHODS

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

AUTHOR

41       Ben Lilburne <bnej@mac.com>
42

44       Copyright (C) 2009 Ben Lilburne
45
46       This program is free software; you can redistribute it and/or modify it
47       under the same terms as Perl itself.
48
49
50
51perl v5.38.0                      2023-07-21 Pod::Abstract::Filter::overlay(3)
Impressum