Pod::Generate::Recursive - Generate POD for directory contents.
If you've ever come across a code base and wanted to easily generate POD from the source then you've probably written a small script to do it for you. You no longer need to do it and can instead point this code at you source and have it generate POD from .pl and .pm files. Enjoy!
Version 0.5
use Pod::Generate::Recursive; my $pgr = Pod::Generate::Recursive->new(); $pgr->source("catalyst/"); $pgr->destination("docs/"); $pgr->debug(1); $pgr->run();
Generate the docs.
Find wanted files.
Debug output
Set the destination for docs.
Set the source directory.
Create a new instance.
Adam M Dutko, <addutko at cpan.org>
<addutko at cpan.org>
Please report any bugs or feature requests to bug-pod-generate-recursive at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Generate-Recursive. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-pod-generate-recursive at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Pod::Generate::Recursive
You can also look for information at:
RT: CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-Generate-Recursive
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Pod-Generate-Recursive
CPAN Ratings
http://cpanratings.perl.org/d/Pod-Generate-Recursive
Search CPAN
http://search.cpan.org/dist/Pod-Generate-Recursive/
Copyright 2014 Adam M Dutko.
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.
To install Pod::Generate::Recursive, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Generate::Recursive
CPAN shell
perl -MCPAN -e shell install Pod::Generate::Recursive
For more information on module installation, please visit the detailed CPAN module installation guide.