NaturalDocs:: Settings:: BuildTarget

A class that stores information about a build target.

Summary
A class that stores information about a build target.
The class is implemented as a blessed arrayref with the members below.
Creates and returns a new object.
Returns the target’s name.
Changes the target’s name.
Returns the NaturalDocs::Builder::Base-derived object for the target’s output format.
Returns the directory for the traget’s output files.
Returns the target’s style, CSS if it’s HTML based.

Implementation

Members

The class is implemented as a blessed arrayref with the members below.

NAMEThe name of the target.
BUILDERThe NaturalDocs::Builder::Base-derived object for the target’s output format.
DIRECTORYThe output directory of the target.
STYLEThe style of the target.  If the target is HTML-based, it’s the CSS style.

Functions

New

sub New #(name,
builder,
directory,
style)

Creates and returns a new object.

Parameters

nameThe name of the target.
builderThe NaturalDocs::Builder::Base-derived object for the target’s output format.
directoryThe directory to place the output files in.
styleThe style of the target.  If it’s HTML-based, it’s the CSS style.

Name

sub Name

Returns the target’s name.

SetName

sub SetName #(name)

Changes the target’s name.

Builder

sub Builder

Returns the NaturalDocs::Builder::Base-derived object for the target’s output format.

Directory

sub Directory

Returns the directory for the traget’s output files.

Style

sub Style

Returns the target’s style, CSS if it’s HTML based.  Returns undef otherwise.

sub New #(name,
builder,
directory,
style)
Creates and returns a new object.
sub Name
Returns the target’s name.
sub SetName #(name)
Changes the target’s name.
sub Builder
Returns the NaturalDocs::Builder::Base-derived object for the target’s output format.
A base class for all Builder output formats.
sub Directory
Returns the directory for the traget’s output files.
sub Style
Returns the target’s style, CSS if it’s HTML based.