NAME

Decl::Semantics::POD - implements POD documentation in a declarative framework.

VERSION

Version 0.02

SYNOPSIS

Obviously, POD documentation doesn't *do* anything, but we'll be able to scan the tree for POD documentation and get it all out in sequence. The main benefit from the POD module is to permit convenient indentation for POD code, like this:

   pod head2 "Explanatory title"
      This function will do all kinds of neat stuff
      and here's an example of how to use it:
      
         (code POD will see as indented)
         
      And then we finish our explanation.
      
   do { some code }

The text that POD sees will automatically have =head2 and =cut added to the start and end, and will be de-indented to the lowest indentation level in the text defined as POD.

defines(), tags_defined()

Called by Decl::Semantics during import, to find out what xmlapi tags this plugin claims to implement. The asterisk means indented lines will all be put into the body of this tag even if not surrounded by curly braces.

extract

This is the only POD-specific function provided; it extracts the POD documentation. If we do a search_first ('pod') on the root of the tree, we can get a sequential list of all POD nodes, so join "\n\n", map { $_-extract() } search_first ('pod')> gives us the POD for the whole tree.

AUTHOR

Michael Roberts, <michael at vivtek.com>

BUGS

Please report any bugs or feature requests to bug-decl at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Decl. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

LICENSE AND COPYRIGHT

Copyright 2010 Michael Roberts.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.