Pod::Classdoc::Project

SUMMARY: CONSTR | METHOD | DETAIL: CONSTR | METHOD

## Class Pod::Classdoc::Project

Generates and merges Pod::ProjectDocs, Pod::Classdoc, and PPI::HTML::CodeFolderoutput, then generates a Javascripted tree widget (via HTML::ListToTree) to navigate the merged manuals, classdocs, and folded/highlighted source code.

Author:
  Dean Arnold
See Also:
  Pod::ProjectDocs,
  Pod::Classdoc,
  PPI::HTML::CodeFolder,
  HTML::ListToTree

Exported Symbols
`renderProject` | () the only public method

Method Summary
`renderProject(Additions => value, Comments => value, Charset => value, CloseImage => value, CSSPath => value, Description => value, Download => value, Expandable => value, Force => value, Heredoc => value, Imports => value, IconPath => value, JSPath => value, Language => value, Libs => value, MinFoldLines => value, NoIcons => value, NoSource => value, OpenImage => value, Order => value, Output => value, POD => value, RootImage => value, Title => value, Verbose => value)` (class method) Generates merged project documentation from Pod::ProjectDocs, Pod::Classdoc, and PPI::HTML::CodeFOlder output, with a table of contents widget generated from HTML::ListToTree.

Method Details

### renderProject

    renderProject(Additions => value, Comments => value, Charset => value, CloseImage => value, CSSPath => value, Description => value, Download => value, Expandable => value, Force => value, Heredoc => value, Imports => value, IconPath => value, JSPath => value, Language => value, Libs => value, MinFoldLines => value, NoIcons => value, NoSource => value, OpenImage => value, Order => value, Output => value, POD => value, RootImage => value, Title => value, Verbose => value)

  (class method) Generates merged project documentation from Pod::ProjectDocs, Pod::Classdoc, and PPI::HTML::CodeFOlder output, with a table of contents widget generated from HTML::ListToTree.

  Parameters:

    `Additions` | => | (optional)HTML document to be appended to the TOC widget
    `Comments` | => | (optional)boolean; if true (the default), fold comments in PPI::HTML::CodeFolder output
    `Charset` | => | (optional)specifies character set for Pod::ProjectDocs
    `CloseImage` | => | (optional)name of closed node icon in TOC; default 'closedbook.gif'
    `CSSPath` | => | (optional)path to CSS files; default is `<Output>/css`
    `Description` | => | (optional)specifies description header for Pod::ProjectDocs
    `Download` | => | (optional)specifies a download file to be appended to the TOC widget
    `Expandable` | => | (optional)boolean; if true (the default), folds in PPI::HTML::CodeFolder output are expandable
    `Force` | => | (optional)boolean; if true, forces generation of all Pod::ProjectDocs documents
    `Heredoc` | => | (optional)boolean; if true (the default), fold heredocs in PPI::HTML::CodeFolder output
    `Imports` | => | (optional)boolean; if true (the default), fold imports in PPI::HTML::CodeFolder output
    `IconPath` | => | (optional)path to icon images for TOC; default is `<Output>/img`
    `JSPath` | => | (optional)path to Javascript files; default is `<Output>/js`
    `Language` | => | (optional)specifies language info for Pod::ProjectDocs
    `Libs` | => | (optional)library directories to be processed; defaults to './lib' and './bin'
    `MinFoldLines` | => | (optional)minimum number of lines for codefolding; default 4
    `NoIcons` | => | (optional)boolean; if true (default false), TOC will not use icons
    `NoSource` | => | (optional)boolean; if true (default false), omit PPI::HTML::CodeFolder source processing
    `OpenImage` | => | (optional)name of open node icon in TOC; default 'openbook.gif'
    `Order` | => | (optional)arrayref of package/script names; TOC nodes will be ordered in same order as this list. Any unlisted packages/scripts will be alphabetically ordered after these nodes are included.
    `Output` | => | (optional)root path of output files; default './classdocs'
    `POD` | => | (optional)boolean; if true (the default), fold POD in PPI::HTML::CodeFolder output
    `RootImage` | => | (optional)name of root node icon in TOC; default 'globe.gif'
    `Title` | => | (optional)title string for HTML document, and root node of TOC
    `Verbose` | => | (optional)boolean; if true, emits lots of diagnostic info

Generated by POD::ClassDoc 1.01 on Sat Aug 18 11:02:01 2007