NaturalDocs::Builder::FramedHTML

A package that generates output in HTML with frames.

All functions are called with Package->Function() notation.

Summary

NaturalDocs::Builder::FramedHTML	A package that generates output in HTML with frames.
Implemented Interface Functions
INIT	Registers the package with NaturalDocs::Builder.
CommandLineOption	Returns the option to follow -o to use this package.
BuildFile	Builds the output file from the parsed source file.
BuildIndex	Builds an index for the passed type.
UpdateMenu	Builds the menu file.

sub INIT

Registers the package with NaturalDocs::Builder.

sub CommandLineOption

Returns the option to follow -o to use this package. In this case, “html”.

sub BuildFile #( sourceFile,
parsedFile )

Builds the output file from the parsed source file.

sourcefile	The FileName of the source file.
parsedFile	An arrayref of the source file as NaturalDocs::Parser::ParsedTopic objects.

sub BuildIndex #( type )

Builds an index for the passed type.

type	The TopicType to limit the index to, or undef if none.

sub UpdateMenu

Builds the menu file. Also generates index.html.