Pod::Classdoc::ForProjectTOC

SUMMARY: CONSTR | METHOD | DETAIL: CONSTR | METHOD

## Class Pod::Classdoc::ForProjectTOC

Inherits from:
  Pod::Classdoc

Subclass of Pod::Classdoc providing methods to write a project TOC.

Method Summary
`getProjectTOC(Additions => value, Manuals => value, SourceMap => value, Order => value, GroupExternals => value)` Generate a project table of contents document for the current collection of classdocs as a nested HTML list.
`writeProjectTOC(Additions => value, Manuals => value, SourceMap => value, Order => value, GroupExternals => value)` Write out a project table of contents document for the current collection of classdocs as a nested HTML list.

Method Details

### getProjectTOC

    getProjectTOC(Additions => value, Manuals => value, SourceMap => value, Order => value, GroupExternals => value)

  Generate a project table of contents document for the current collection of classdocs as a nested HTML list. Caller may optionally specify the order of classes in the menu.

  Parameters:

    `Additions` | => | (optional)string of additional HTML list elements to append to TOC
    `Manuals` | => | (optional)hashref mapping package names to manual files
    `SourceMap` | => | (optional)hashref mapping packages and methods to their source filename
    `Order` | => | (optional)arrayref of package names in the order in which they should appear in TOC; if a partial list, any remaining packages will be appended to the TOC in alphabetical order
    `GroupExternals` | => | (optional)if true, group external methods separately

  Returns:
    the TOC document

### writeProjectTOC

    writeProjectTOC(Additions => value, Manuals => value, SourceMap => value, Order => value, GroupExternals => value)

  Write out a project table of contents document for the current collection of classdocs as a nested HTML list. The output filename is 'toc.html'. The caller may optionally specify the order of classes in the menu.

  Parameters:

    `Additions` | => | (optional)string of additional HTML list elements to append to TOC
    `Manuals` | => | (optional)hashref mapping package names to manual files
    `SourceMap` | => | (optional)hashref mapping packages and methods to their source filename
    `Order` | => | (optional)arrayref of packages in the order in which they should appear in TOC; if a partial list, any remaining packages will be appended to the TOC in alphabetical order
    `GroupExternals` | => | (optional)if true, group external methods separately

  Returns:
    this object on success, undef on failure, with error message in $@

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