NaturalDocs::Languages::Prototype::Parameter

A data class for storing parsed prototype parameters.

Summary

NaturalDocs::Languages::Prototype::Parameter	A data class for storing parsed prototype parameters.
Constants
Members	The object is implemented as a blessed arrayref, with the following constants as its indexes.
Functions
New	Creates and returns a new prototype object.
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.

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

TYPE	The parameter type, if any.
TYPE_PREFIX	The parameter type prefix which should be aligned separately, if any.
NAME	The parameter name.
NAME_PREFIX	The parameter name prefix which should be aligned separately, if any.
DEFAULT_VALUE	The default value expression, if any.
DEFAULT_VALUE_PREFIX	The default value prefix which should be aligned separately, if any.

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

Creates and returns a new prototype object.

type	The parameter type, if any.
typePrefix	The parameter type prefix which should be aligned separately, if any.
name	The parameter name.
namePrefix	The parameter name prefix which should be aligned separately, if any.
defaultValue	The default value expression, if any.
defaultValuePrefix	The default value prefix which should be aligned separately, if any.

The parameter type, if any.

Replaces the parameter type.

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

Replaces the parameter type prefix.

The parameter name.

Replaces the parameter name.

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

Replaces the parameter name prefix.

The default value expression, if any.

Replaces the default value expression.

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

Replaces the default value prefix.