Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Pod::Abstract::Filter:UserrContributed Perl DPod::Abstract::Filter::overlay(3)

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

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.

perl v5.24.1			  2010-01-03 Pod::Abstract::Filter::overlay(3)

NAME | METHODS | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Pod::Abstract::Filter::overlay&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help