GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  POD::ABSTRACT::FILTER::OVERLAY (3)

.ds Aq ’

NAME

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

CONTENTS

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.

AUTHOR

Ben Lilburne <bnej@mac.com>

COPYRIGHT AND LICENSE

Copyright (C) 2009 Ben Lilburne

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 POD::ABSTRACT::FILTER::OVERLAY (3) 2010-01-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.