NaturalDocs::Builder

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

Usage and Dependencies

Add() can be called immediately.
OutputPackages() and OutputPackageOf() can be called once all sub-packages have been registered via Add(). Since this is normally done in their INIT functions, they should be available to all normal functions immediately.
Prior to calling Run(), NaturalDocs::Settings, NaturalDocs::Project, NaturalDocs::Menu, and NaturalDocs::Parser must be initialized. NaturalDocs::Settings->GenerateDirectoryNames() must be called. NaturalDocs::SymbolTable and NaturalDocs::ClassHierarchy must be initialized and fully resolved.

Summary

NaturalDocs::Builder	A package that takes parsed source file and builds the output for it.
Variables
outputPackages	An array of the output packages available for use.
Functions
OutputPackages	Returns an arrayref of the output packages available for use.
OutputPackageOf	Returns the output package corresponding to the passed command line option, or undef if none.
Add	Adds an output package to those available for use.
Run	Runs 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

package

The 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.