The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Pod-Generate-Recursive-0.5
River stage zero No dependents
++
/ Pod::Generate::Recursive

NAME

Pod::Generate::Recursive - Generate POD for directory contents.

DESCRIPTION

    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

Version 0.5

SYNOPSIS

    use Pod::Generate::Recursive;

    my $pgr = Pod::Generate::Recursive->new();
    $pgr->source("catalyst/");
    $pgr->destination("docs/");
    $pgr->debug(1);
    $pgr->run();

SUBROUTINES/METHODS

run

Generate the docs.

wanted

Find wanted files.

debug

Debug output

destination

Set the destination for docs.

source

Set the source directory.

new

Create a new instance.

AUTHOR

Adam M Dutko, <addutko at cpan.org>

BUGS

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.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Pod::Generate::Recursive

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

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.