Dean Arnold > Pod-Classdoc-1.01 > Pod::Classdoc::Project

Download:
Pod-Classdoc-1.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.01   Source  

NAME ^

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

SYNOPSIS ^

        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 ^

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 ^

Refer to included classdocs.

NOTES ^

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 ^

mkprojdocs

Pod::ProjectDocs

Pod::Classdoc

PPI::HTML::CodeFolder

HTML::ListToTree

AUTHOR ^

Dean Arnold mailto:darnold@presicient.com

COPYRIGHT AND LICENSE ^

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.

syntax highlighting: