NaturalDocs::Builder::FramedHTML

NaturalDocs::Builder::FramedHTML

A package that generates output in HTML with frames.

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

Summary
NaturalDocs::Builder::FramedHTMLA package that generates output in HTML with frames.
Implemented Interface Functions
INITRegisters the package with NaturalDocs::Builder.
CommandLineOptionReturns the option to follow -o to use this package.
BuildFileBuilds the output file from the parsed source file.
BuildIndexBuilds an index for the passed type.
UpdateMenuBuilds the menu file.

Implemented Interface Functions

INIT

sub INIT

Registers the package with NaturalDocs::Builder.

CommandLineOption

sub CommandLineOption

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

BuildFile

sub BuildFile #(sourceFile,
parsedFile)

Builds the output file from the parsed source file.

Parameters

sourcefileThe FileName of the source file.
parsedFileAn arrayref of the source file as NaturalDocs::Parser::ParsedTopic objects.

BuildIndex

sub BuildIndex #(type)

Builds an index for the passed type.

Parameters

typeThe TopicType to limit the index to, or undef if none.

UpdateMenu

sub UpdateMenu

Builds the menu file.  Also generates index.html.

A base package for all the shared functionality in NaturalDocs::Builder::HTML and NaturalDocs::Builder::FramedHTML.
sub INIT
Registers the package with NaturalDocs::Builder.
A package that takes parsed source file and builds the output for it.
sub CommandLineOption
Returns the option to follow -o to use this package.
sub BuildFile #(sourceFile,
parsedFile)
Builds the output file from the parsed source file.
sub BuildIndex #(type)
Builds an index for the passed type.
sub UpdateMenu
Builds the menu file.
A string representing the absolute, platform-dependent path to a file.
A class for parsed topics of source files.
A string representing a topic type as defined in Topics.txt.
Close