NaturalDocs::Builder

A package that takes parsed source file and builds the output for it.

Usage and Dependencies

Summary
NaturalDocs::BuilderA package that takes parsed source file and builds the output for it.
Variables
outputPackagesAn array of the output packages available for use.
Functions
OutputPackagesReturns an arrayref of the output packages available for use.
OutputPackageOfReturns the output package corresponding to the passed command line option, or undef if none.
AddAdds an output package to those available for use.
RunRuns the build process.

Variables

outputPackages

my @outputPackages

An array of the output packages available for use.

Functions

OutputPackages

sub OutputPackages

Returns an arrayref of the output packages available for use.  The arrayref is not a copy of the data, so don’t change it.

Add output packages to this list with the Add() function.

OutputPackageOf

sub OutputPackageOf #(commandLineOption)

Returns the output package corresponding to the passed command line option, or undef if none.

Add

sub Add #(package)

Adds an output package to those available for use.  All output packages must call this function in order to be recognized.

Parameters

packageThe package name.

Run

sub Run

Runs the build process.  This must be called every time Natural Docs is run, regardless of whether any source files changed or not.  Some output packages have dependencies on files outside of the source tree that need to be checked.

Since there are multiple stages to the build process, this function will handle its own status messages.  There’s no need to print “Building files...” or something similar beforehand.

my @outputPackages
An array of the output packages available for use.
sub OutputPackages
Returns an arrayref of the output packages available for use.
sub OutputPackageOf #(commandLineOption)
Returns the output package corresponding to the passed command line option, or undef if none.
sub Add #(package)
Adds an output package to those available for use.
sub Run
Runs the build process.
A package to handle the command line and various other program settings.
A package that manages information about the files in the source tree, as well as the list of files that have to be parsed and built.
A package handling the menu’s contents and state.
A package that coordinates source file parsing between the NaturalDocs::Languages::Base-derived objects and its own sub-packages such as NaturalDocs::Parser::Native.
sub GenerateDirectoryNames #(hashref inputHints,
hashref imageHints)
Generates names for each of the input and image directories, which can later be retrieved with InputDirectoryNameOf() and ImageDirectoryNameOf().
A package that handles all the gory details of managing symbols.
A package that handles all the gory details of managing the class hierarchy.
Close