NaturalDocs::Languages::Prototype::Parameter

A data class for storing parsed prototype parameters.

Summary
NaturalDocs::Languages::Prototype::ParameterA data class for storing parsed prototype parameters.
Constants
MembersThe object is implemented as a blessed arrayref, with the following constants as its indexes.
Functions
NewCreates and returns a new prototype object.
TypeThe parameter type, if any.
SetTypeReplaces the parameter type.
TypePrefixThe parameter type prefix, which should be aligned separately, if any.
SetTypePrefixReplaces the parameter type prefix.
NameThe parameter name.
SetNameReplaces the parameter name.
NamePrefixThe parameter name prefix, which should be aligned separately, if any.
SetNamePrefixReplaces the parameter name prefix.
DefaultValueThe default value expression, if any.
SetDefaultValueReplaces the default value expression.
DefaultValuePrefixThe default value prefix, which should be aligned separately, if any.
SetDefaultValuePrefixReplaces the default value prefix.

Constants

Members

The object is implemented as a blessed arrayref, with the following constants as its indexes.

TYPEThe parameter type, if any.
TYPE_PREFIXThe parameter type prefix which should be aligned separately, if any.
NAMEThe parameter name.
NAME_PREFIXThe parameter name prefix which should be aligned separately, if any.
DEFAULT_VALUEThe default value expression, if any.
DEFAULT_VALUE_PREFIXThe default value prefix which should be aligned separately, if any.

Functions

New

sub New #(type,
typePrefix,
name,
namePrefix,
defaultValue,
defaultValuePrefix)

Creates and returns a new prototype object.

Parameters

typeThe parameter type, if any.
typePrefixThe parameter type prefix which should be aligned separately, if any.
nameThe parameter name.
namePrefixThe parameter name prefix which should be aligned separately, if any.
defaultValueThe default value expression, if any.
defaultValuePrefixThe default value prefix which should be aligned separately, if any.

Type

The parameter type, if any.

SetType

Replaces the parameter type.

TypePrefix

The parameter type prefix, which should be aligned separately, if any.

SetTypePrefix

Replaces the parameter type prefix.

Name

The parameter name.

SetName

Replaces the parameter name.

NamePrefix

The parameter name prefix, which should be aligned separately, if any.

SetNamePrefix

Replaces the parameter name prefix.

DefaultValue

The default value expression, if any.

SetDefaultValue

Replaces the default value expression.

DefaultValuePrefix

The default value prefix, which should be aligned separately, if any.

SetDefaultValuePrefix

Replaces the default value prefix.

sub New #(type,
typePrefix,
name,
namePrefix,
defaultValue,
defaultValuePrefix)
Creates and returns a new prototype object.
Close