NaturalDocs::Languages::Prototype

A data class for storing parsed prototypes.

Summary

NaturalDocs::Languages::Prototype	A data class for storing parsed prototypes.
Functions
New	Creates and returns a new prototype object.
BeforeParameters	Returns the part of the prototype before the parameter list.
SetBeforeParameters	Replaces the part of the prototype before the parameter list.
AfterParameters	Returns the part of the prototype after the parameter list, if any.
SetAfterParameters	Replaces the part of the prototype after the parameter list.
Parameters	Returns the parameter list as an arrayref of NaturalDocs::Languages::Prototype::Parameters, or undef if none.
AddParameter	Adds a NaturalDocs::Languages::Prototype::Parameter to the list.
OnlyBeforeParameters	Returns whether BeforeParameters() is the only thing set.

sub New #( beforeParameters,
afterParameters )

Creates and returns a new prototype object.

beforeParameters	The part of the prototype before the parameter list.
afterParameters	The part of the prototype after the parameter list.

You cannot set the parameters from here. Use AddParameter().

Returns the part of the prototype before the parameter list. If there is no parameter list, this will be the only thing that returns content.

Replaces the part of the prototype before the parameter list.

Returns the part of the prototype after the parameter list, if any.

Replaces the part of the prototype after the parameter list.

Returns the parameter list as an arrayref of NaturalDocs::Languages::Prototype::Parameters, or undef if none.

sub AddParameter #( parameter )

sub OnlyBeforeParameters

Returns whether BeforeParameters() is the only thing set.