Pod::Classdoc::Project - generate POD, classdocs, and folded source with tree TOC
use Pod::Classdoc::Project; renderProject( Additions => $additions, Charset => $charset, CloseImage => $closeimg, Comments => !$nocomments, Description => $desc, Download => $download, Expandable => $noexpand, Force => $forcegen, Heredoc => !$noheredocs, Imports => !$noimports, IconPath => $imgpath, JSPath => $jspath, Language => $lang, Libs => \@sources, MinLines => $lines, NoIcons => $noicons, NoSource => $nosrc, OpenImage => $openimg, Order => \@order, Output => $out, POD => !$nopod, RootImage => $rootimg, CSSPath => $csspath, Title => $title, Verbose => $verbose, );
Generates merged Pod::ProjectDocs (for POD), Pod::Classdoc (for classdocs), and PPI::HTML::CodeFolder (for source code) output with a Javascript tree widget index generated by HTML::ListToTree.
Refer to included classdocs.
By convention, Pod::Classdoc::Project assumes POD for manual pages is in a separate '.pod' file, not embedded in the module source '.pm' file. POD within '.pm' files is assumed to be classdocs only.
mkprojdocs
Pod::ProjectDocs
Pod::Classdoc
PPI::HTML::CodeFolder
HTML::ListToTree
Dean Arnold mailto:darnold@presicient.com
Copyright(C) 2007, Dean Arnold, USA. All rights reserved.
Permission is granted to use this software under the same terms as Perl itself. Refer to the Perl Artistic License for details.
To install Pod::Classdoc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Classdoc
CPAN shell
perl -MCPAN -e shell install Pod::Classdoc
For more information on module installation, please visit the detailed CPAN module installation guide.