logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Author

       Ben Lilburne <bnej@mac.com>

Methods

filter
       Inspects the source document for a begin/end block named ":overlay". The overlay block will be inspected
       for "=overlay" commands, which should be structured like:

        =begin :overlay

        =overlay METHODS Some::Class::Or::File

        =end :overlay

       Each overlay is processed in order. It will add any headings for the matched sections in the current
       document from the named source, for any heading that is not already present in the given section.

       If that doesn't make sense just try it and it will!

       The main utility of this is to specify a superclass, so that all the methods that are not documented in
       your subclass become documented by the overlay. The "sort" filter makes a good follow up.

       The start of overlaid sections will include:

        =for overlay from <class-or-file>

       You can use these markers to set sections to be replaced by some other document, or to repeat an overlay
       on an already processed Pod file. Changes to existing marked sections are made in-place without changing
       document order.

Name

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

See Also