NaturalDocs:: SymbolTable:: SymbolDefinition

A class representing a symbol definition. This does not store the definition symbol, class, or file.

Summary

NaturalDocs:: SymbolTable:: SymbolDefinition	A class representing a symbol definition.
Implementation
Members	The class is implemented as a blessed arrayref.
Modification Functions
New	Creates and returns a new object.
SetType	Changes the type.
SetPrototype	Changes the prototype.
Information Functions
Type	Returns the definition’s type.
Prototype	Returns the definition’s prototype, or undef if it doesn’t have one.

The class is implemented as a blessed arrayref. The following constants are its members.

TYPE	The symbol type. Will be one of the Topic Types.
PROTOTYPE	The symbol’s prototype, if applicable. Will be undef otherwise.

sub New #(type, prototype)

Creates and returns a new object.

type	The symbol type. Should be one of the Topic Types.
prototype	The symbol prototype, if applicable. Undef otherwise.

sub SetType #(type)

Changes the type.

sub SetPrototype #(prototype)

Changes the prototype.

sub Type

Returns the definition’s type. Will be one of the Topic Types.

sub Prototype

Returns the definition’s prototype, or undef if it doesn’t have one.