Pod::Classdoc::Project - generate POD, classdocs, and folded source with tree TOC


Pod-Classdoc documentation  | view source Contained in the Pod-Classdoc distribution.

Index


NAME

Top

Pod::Classdoc::Project - generate POD, classdocs, and folded source with tree TOC

SYNOPSIS

Top

	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,
	);

DESCRIPTION

Top

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.

METHODS

Top

Refer to included classdocs.

NOTES

Top

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.

SEE ALSO

Top

mkprojdocs

Pod::ProjectDocs

Pod::Classdoc

PPI::HTML::CodeFolder

HTML::ListToTree

AUTHOR

Top

Dean Arnold mailto:darnold@presicient.com

COPYRIGHT AND LICENSE

Top


Pod-Classdoc documentation  | view source Contained in the Pod-Classdoc distribution.